Skip to content

Commit 37fd254

Browse files
author
Stephen Tramer
committed
Backport 2.x updates to 1.8
1 parent 6538952 commit 37fd254

File tree

7 files changed

+28
-23
lines changed

7 files changed

+28
-23
lines changed

docs-conceptual/azps-1.8.0/authenticate-azureps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,17 @@ store based on a certificate thumbprint.
7171
Connect-AzAccount -ServicePrincipal -TenantId $tenantId -CertificateThumbprint <thumbprint>
7272
```
7373

74-
In PowerShell 5, the certificate store can be managed and inspected with the [PKI](/powershell/module/pkiclient) module. For PowerShell 6, the process is more complicated. The following scripts show you how to import an existing certificate into the certificate store accessible by PowerShell.
74+
In PowerShell 5.1, the certificate store can be managed and inspected with the [PKI](/powershell/module/pkiclient) module. For PowerShell Core 6.x and later, the process is more complicated. The following scripts show you how to import an existing certificate into the certificate store accessible by PowerShell.
7575

76-
#### Import a certificate in PowerShell 5
76+
#### Import a certificate in PowerShell 5.1
7777

7878
```azurepowershell-interactive
7979
# Import a PFX
8080
$credentials = Get-Credential -Message "Provide PFX private key password"
8181
Import-PfxCertificate -FilePath <path to certificate> -Password $credentials.Password -CertStoreLocation cert:\CurrentUser\My
8282
```
8383

84-
#### Import a certificate in PowerShell 6
84+
#### Import a certificate in PowerShell Core 6.x and later
8585

8686
```azurepowershell-interactive
8787
# Import a PFX

docs-conceptual/azps-1.8.0/context-persistence.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Persist user credentials across PowerShell sessions
2+
title: Persist Azure credentials across PowerShell sessions
33
description: Learn how to reuse Azure credentials and other information across multiple PowerShell sessions.
44
author: sptramer
55
ms.author: sttramer
@@ -8,7 +8,7 @@ ms.devlang: powershell
88
ms.topic: conceptual
99
ms.date: 12/13/2018
1010
---
11-
# Persist user credentials across PowerShell sessions
11+
# Persist Azure user credentials across PowerShell sessions
1212

1313
Azure PowerShell offers a feature called **Azure Context Autosave**, which gives the following features:
1414

docs-conceptual/azps-1.8.0/install-az-ps.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ are supported.
1919

2020
Azure PowerShell works with PowerShell 5.1 or higher on Windows, or PowerShell Core 6.x and later on
2121
all platforms. If you aren't sure if you have PowerShell, or are on macOS or Linux,
22-
[install the latest PowerShell Core](/powershell/scripting/install/installing-powershell#powershell-core).
22+
[install the latest version of PowerShell Core](/powershell/scripting/install/installing-powershell#powershell-core).
2323

2424
To check your PowerShell version, run the command:
2525

@@ -95,12 +95,17 @@ across PowerShell sessions, see [Persist user credentials across PowerShell sess
9595

9696
## Update the Azure PowerShell module
9797

98-
You can update your Azure PowerShell installation by running [Update-Module](/powershell/module/powershellget/update-module). This command does __not__ uninstall older versions.
98+
Because of how the Az module is package, the [Update-Module](/powershell/module/powershellget/update-module)
99+
command won't update your installation correctly. Az is technically a meta-module, encompassing all of
100+
the submodules that contain cmdlets to interact with Azure services. That means that to update the
101+
Azure PowerShell module, you will need to __reinstall__, rather than just __update__. This is done in the
102+
same way as installing, but you may need to add the `-Force` argument:
99103

100-
```powershell-interactive
101-
Update-Module -Name Az
104+
```powershell
105+
Install-Module -Name Az -AllowClobber -Force
102106
```
103107

108+
Although this can overwrite installed modules, you may still have older versions left on your system.
104109
To learn how to remove old versions of Azure PowerShell from your system, see [Uninstall the Azure PowerShell module](uninstall-az-ps.md).
105110

106111
## Use multiple versions of Azure PowerShell

docs-conceptual/azps-1.8.0/migrate-az-1.0.0.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -186,15 +186,15 @@ The tools for these services are no longer actively supported. Customers are en
186186
### Windows PowerShell 5.1 and .NET 4.7.2
187187

188188
Using Az with PowerShell 5.1 for Windows requires the installation of .NET Framework 4.7.2. Using PowerShell
189-
Core 6.x or later does not have a .NET Framework dependency.
189+
Core 6.x or later does not require .NET Framework.
190190

191191
### Temporary removal of User login using PSCredential
192192

193-
Due to changes in the authentication flow for .NET Standard, we are temporarily removing user login via PSCredential. This capability will be re-introduced in the 1/15/2019 release for Windows PowerShell 5.1. This is discussed in detail in [this GitHub issue.](https://github.com/Azure/azure-powershell/issues/7430)
193+
Due to changes in the authentication flow for .NET Standard, we are temporarily removing user login via PSCredential. This capability will be re-introduced in the 1/15/2019 release for PowerShell 5.1 for Windows. This is discussed in detail in [this GitHub issue.](https://github.com/Azure/azure-powershell/issues/7430)
194194

195195
### Default device code login instead of web browser prompt
196196

197-
Due to changes in the authentication flow for .NET Standard, we are using device login as the default login flow during interactive login. Web browser based login will be re-introduced for Windows PowerShell 5.1 as the default in the 1/15/2019 release. At that time, users will be able to choose device login using a Switch parameter.
197+
Due to changes in the authentication flow for .NET Standard, we are using device login as the default login flow during interactive login. Web browser based login will be re-introduced for PowerShell 5.1 for Windows as the default in the 1/15/2019 release. At that time, users will be able to choose device login using a Switch parameter.
198198

199199
## Module breaking changes
200200

@@ -207,7 +207,7 @@ This section details specific breaking changes for individual modules and cmdlet
207207
- Set-AzureRmApiManagementHostnames
208208
- Update-AzureRmApiManagementDeployment
209209
- Import-AzureRmApiManagementHostnameCertificate
210-
- Use **Set-AzApiManagement** cmdlet to set these properites instead
210+
- Use **Set-AzApiManagement** cmdlet to set these properties instead
211211
- Removed the following properties:
212212
- Removed property `PortalHostnameConfiguration`, `ProxyHostnameConfiguration`, `ManagementHostnameConfiguration` and `ScmHostnameConfiguration` of type `PsApiManagementHostnameConfiguration` from `PsApiManagementContext`. Instead use `PortalCustomHostnameConfiguration`, `ProxyCustomHostnameConfiguration`, `ManagementCustomHostnameConfiguration` and `ScmCustomHostnameConfiguration` of type `PsApiManagementCustomHostNameConfiguration`.
213213
- Removed property `StaticIPs` from PsApiManagementContext. The property has been split into `PublicIPAddresses` and `PrivateIPAddresses`.
@@ -259,8 +259,8 @@ This section details specific breaking changes for individual modules and cmdlet
259259
New-AzDataLakeStoreAccount -Tag @{TagName="TagValue"}
260260
```
261261

262-
- Removed deprecated properties ```Identity```, ```EncryptionState```, ```EncrypotionProvisioningState```, ```EncryptionConfig```, ```FirewallState```, ```FirewallRules```, ```VirtualNetworkRules```, ```TrustedIdProviderState```, ```TrustedIdProviders```, ```DefaultGroup```, ```NewTier```, ```CurrentTier```, ```FirewallAllowAzureIps``` from ```PSDataLakeStoreAccountBasic``` object. Any script that
263-
uses the ```PSDatalakeStoreAccount``` returned from ```Get-AzDataLakeStoreAccount``` should not reference these properties.
262+
- Removed deprecated properties `Identity`, `EncryptionState`, `EncryptionProvisioningState`, `EncryptionConfig`, `FirewallState`, `FirewallRules`, `VirtualNetworkRules`, `TrustedIdProviderState`, `TrustedIdProviders`, `DefaultGroup`, `NewTier`, `CurrentTier`, `FirewallAllowAzureIps` from `PSDataLakeStoreAccountBasic` object. Any script that
263+
uses the `PSDatalakeStoreAccount` returned from `Get-AzDataLakeStoreAccount` should not reference these properties.
264264

265265
### Az.KeyVault (previously AzureRM.KeyVault)
266266

@@ -299,7 +299,7 @@ uses the ```PSDatalakeStoreAccount``` returned from ```Get-AzDataLakeStoreAccoun
299299
- Removed deprecated `EnableVmProtection` property from `PSVirtualNetwork` object
300300
- Removed deprecated `Set-AzVirtualNetworkGatewayVpnClientConfig` cmdlet
301301

302-
Scripts shoudl no longer make processing decisions based on the values fo these fields.
302+
Scripts should no longer make processing decisions based on the values fo these fields.
303303

304304
### Az.OperationalInsights (previously AzureRM.OperationalInsights)
305305

@@ -342,7 +342,7 @@ Scripts shoudl no longer make processing decisions based on the values fo these
342342
### Az.ServiceFabric (previously AzureRM.ServiceFabric)
343343

344344
- The following cmdlet return types have been changed:
345-
- The property `SerivceTypeHealthPolicies` of type `ApplicationHealthPolicy` has been removed.
345+
- The property `ServiceTypeHealthPolicies` of type `ApplicationHealthPolicy` has been removed.
346346
- The property `ApplicationHealthPolicies` of type `ClusterUpgradeDeltaHealthPolicy` has been removed.
347347
- The property `OverrideUserUpgradePolicy` of type `ClusterUpgradePolicy` has been removed.
348348
- These changes affect the following cmdlets:

docs-conceptual/azps-1.8.0/new-azureps-module-az.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ _Verb_-`Az`_Noun_ form. Previously, cmdlet names were not only longer, there wer
3636
in cmdlet names.
3737

3838
The number of modules was also reduced: Some modules which worked with the same services have been rolled
39-
together, and magement plane and data plane cmdlets are now contained all within single modules for their
39+
together, and management plane and data plane cmdlets are now contained all within single modules for their
4040
services. For those of you who manually manage dependencies and imports, this makes things much simpler.
4141

4242
By making these important changes that required building a new Azure PowerShell module, the team has

docs-conceptual/azps-1.8.0/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Azure PowerShell is also available on Azure Cloud Shell.
1919
## About the new Az module
2020

2121
This documentation describes the new Az module for Azure PowerShell. This new module is written from the
22-
ground up in .NET Standard. Using .NET Standard allows Azure PowerShell to run under PowerShell 5 on Windows
23-
or PowerShell 6 on any platform. The Az module is now the intended way to interact with Azure through PowerShell.
22+
ground up in .NET Standard. Using .NET Standard allows Azure PowerShell to run under PowerShell 5.1 on Windows
23+
or PowerShell Core 6.x and later on any platform. The Az module is now the intended way to interact with Azure through PowerShell.
2424
AzureRM will continue to get bug fixes, but no longer receive new features.
2525

2626
Learn the full details about the new module, including how commands have been renamed and the maintenance
@@ -38,8 +38,8 @@ The [AzureRM documentation](/powershell/azure/azurerm) is also available.
3838
3939
## Run or install
4040

41-
You can install Azure PowerShell on PowerShell 5.1 or higher on Windows, PowerShell 6 on any platform, or run
42-
in Azure Cloud Shell.
41+
You can install Azure PowerShell on PowerShell 5.1 or higher on Windows, PowerShell Core 6.x and later on
42+
any platform, or run in Azure Cloud Shell.
4343

4444
* To run in your browser with Azure Cloud Shell, see [Quickstart for PowerShell in Azure Cloud Shell](/azure/cloud-shell/quickstart-powershell).
4545
* To install Azure PowerShell on your system, see [Install Azure PowerShell](install-az-ps.md).

docs-conceptual/azps-1.8.0/uninstall-az-ps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ part of the `Az.Accounts` module. This removes _all_ AzureRM modules from your m
145145
Uninstall-AzureRm
146146
```
147147

148-
If you can't successfully run the `Uninstall-AzureRM` command, use the [`Uninstall-AllModules` script](#uninstall-script) provided in this article, with the following invocation:
148+
If you can't successfully run the `Uninstall-AzureRM` command, use the [`Uninstall-AllModules` script](#uninstall-script) provided in this article with the following invocation:
149149

150150
```powershell-interactive
151151
$versions = (Get-InstalledModule AzureRM -AllVersions | Select-Object Version)

0 commit comments

Comments
 (0)