Skip to content

Commit 1425a5f

Browse files
author
Stephen Tramer
committed
Acrolynx review fixes.
1 parent 81e63e7 commit 1425a5f

File tree

3 files changed

+31
-43
lines changed

3 files changed

+31
-43
lines changed

docs-conceptual/azurermps-6.12.0/install-az-ps.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ ms.date: 10/29/2018
1111

1212
# Install Azure PowerShell with PowerShellGet
1313

14-
This article explains the steps to install the Azure PowerShell modules using PowerShellGet. For the preview release of Az,
15-
no other install methods are supported.
14+
This article tells you how to install the Azure PowerShell modules using PowerShellGet. For the preview release of Az, no other install methods are supported.
1615

1716
## Requirements
1817

@@ -23,8 +22,8 @@ on your machine, run the following command:
2322
$PSVersionTable.PSVersion
2423
```
2524

26-
If you have an outdated version or need to install PowerShell, see [Installing various versions of PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell?view=powershell-6) and click on the link for
27-
your platform.
25+
If you have an outdated version or need to install PowerShell, see [Installing various versions of PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell?view=powershell-6). Install
26+
information for your platform is linked from that page.
2827

2928
## Install the Azure PowerShell module
3029

@@ -34,8 +33,7 @@ your platform.
3433
> the `Az` module, `AzureRM` must be uninstalled. For instructions on how to do that, see
3534
> [Uninstall the Azure PowerShell module (AzureRM)](uninstall-azurerm-ps.md).
3635
37-
To install modules at a global scope, you need elevated privileges to install modules from the PowerShell Gallery. To install Azure PowerShell,
38-
run the following command in an elevated session ("Run as Administrator" on Windows, or with superuser privileges on macOS or Linux):
36+
To install modules at a global scope, you need elevated privileges to install modules from the PowerShell Gallery. To install Azure PowerShell, run the following command in an elevated session ("Run as Administrator" on Windows, or with superuser privileges on macOS or Linux):
3937

4038
```powershell-interactive
4139
Install-Module -Name Az -AllowClobber
@@ -103,7 +101,7 @@ Get-Module -Name Az -List | select Name,Version
103101

104102
To remove a version of Azure PowerShell, see [Uninstall the Azure PowerShell module](uninstall-azurerm-ps.md).
105103

106-
You can load a specific version of the `Az` module by providing the `-RequiredVersion` argument to `Install-Module` or `Import-Module`:
104+
You can load a specific version of the `Az` module by using the `-RequiredVersion` argument with `Install-Module` or `Import-Module`:
107105

108106
```powershell-interactive
109107
Install-Module -Name Az -RequiredVersion 0.4.0

docs-conceptual/azurermps-6.12.0/migrate-from-azurerm-to-az.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,28 @@ ms.author: sttramer
66
manager: carmonm
77
ms.devlang: powershell
88
ms.topic: conceptual
9-
ms.date: 11/01/2018
9+
ms.date: 11/07/2018
1010
---
1111

1212
# Migrate from AzureRM to Azure PowerShell Az
1313

1414
The Az module has feature parity with AzureRM, but uses shorter and more consistent cmdlet names.
15-
This means that scripts written for the AzureRM cmdlets won't automatically work with the new
15+
Scripts written for the AzureRM cmdlets won't automatically work with the new
1616
module. To make the transition easier, Az offers tools to allow you to run your existing scripts
1717
using AzureRM. No migration to a new command set is ever convenient, but this article will help
18-
you get started on transitioning to Az while minimizing the cost of upgrading so that you can
19-
take advantage of the features offered in this new module.
20-
21-
Each section of this article outlines a step in the process, and it's recommended that you follow
22-
them in order unless you've already completed the process outlined in a single step.
18+
you get started on transitioning to the new module.
2319

2420
## Ensure your existing scripts work with the latest AzureRM release
2521

2622
This is the most important step! Run your existing scripts, and make sure that they work with the
27-
_latest_ release of AzureRM (__6.12.0__). If your scripts do not work, make sure to read
23+
_latest_ release of AzureRM (__6.12.0__). If your scripts don't work, make sure to read
2824
the [AzureRM migration guide](migration-guide.6.0.0.md).
2925

3026
## Install the Azure PowerShell Az module
3127

32-
The first step is to install the Az module on your platform. This _does_ require uninstalling
33-
the AzureRM module. In the following steps you'll learn how to keep running your existing scripts
34-
and enable compatibility for old cmdlet names.
28+
The first step is to install the Az module on your platform. To install Az, you need to uninstall AzureRM.
29+
In the following steps, you'll learn how to keep running your existing scripts and enable compatibility
30+
for old cmdlet names.
3531

3632
To install the Azure PowerShell Az module, follow these steps:
3733

@@ -41,13 +37,13 @@ To install the Azure PowerShell Az module, follow these steps:
4137
## <a name="aliases"/>Enable AzureRM alias mode
4238

4339
With AzureRM uninstalled and your scripts working with the latest AzureRM version, now is the time to
44-
enable the compatibility mode for the Az module. This is done with the command
40+
enable the compatibility mode for the Az module. Compatibility is enabled with the command:
4541

4642
```powershell-interactive
4743
Enable-AzureRmAlias -Scope CurrentUser
4844
```
4945

50-
This enables the ability to use old cmdlet names with the `Az` module installed, through aliases. These
46+
Aliases enable the ability to use old cmdlet names with the `Az` module installed. These
5147
aliases are written to the user profile for the selected scope. If no user profile exists, one is created.
5248

5349
> [!WARNING]
@@ -60,24 +56,19 @@ Once the alias mode is enabled, run your scripts again to confirm that they stil
6056

6157
## Change module imports and cmdlet names
6258

63-
In general, the module names have been changed so that `AzureRM` becomes `Az`, and the same for cmdlets.
64-
For example, the `AzureRM.Compute` module has been renamed to `Az.Compute`. `New-AzureRmVM` has become `New-AzVM`.
65-
There are some exceptions to this naming change that you should be aware of before doing any renaming:
59+
In general, the module names have been changed so that `AzureRM` and `Azure` become `Az`, and the same for cmdlets.
60+
For example, the `AzureRM.Compute` module has been renamed to `Az.Compute`. `New-AzureRmVM` has become `New-AzVM`,
61+
and `Get-AzureStorageBlob` is now `Get-AzStorageBlob`.
62+
63+
There are exceptions to this naming change that you should be aware of before doing any renaming:
6664

6765
| AzureRM module | Az module |
6866
|----------------|-----------|
69-
| Azure.Storage | Az.Storage |
70-
| Azure.AnalysisServices | Az.AnalysisServices |
7167
| AzureRM.DataFactories | Az.DataFactory |
7268
| AzureRM.DataFactoryV2 | Az.DataFactory |
7369
| AzureRM.RecoveryServices.Backup | Az.RecoveryServices |
7470
| AzureRM.RecoveryServices.SiteRecovery | Az.RecoveryServices |
7571

76-
In the case of `Azure.Storage` and `Azure.AnalysisServices`, the associated cmdlets have also been renamed
77-
so that `Azure` is replaced with `Az`. For example, `Get-AzureStorageBlob` has been renamed to `Get-AzStorageBlob`.
78-
7972
## Summary
8073

81-
By following these steps, you can update all of your existing scripts to use the new module without a lot of pain or difficulty.
82-
If you have any questions or encountered problems with these steps that made your migration difficult, please comment on this article
83-
so that we can improve the instructions.
74+
By following these steps, you can update all of your existing scripts to use the new module. If you have any questions or problems with these steps that made your migration difficult, please comment on this article so that we can improve the instructions.
Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Introducing the Azure PowerShell Az module
33
description: Introducing the new Azure PowerShell module Az, the replacement for the AzureRM module.
4-
ms.date: 10/22/2018
4+
ms.date: 11/07/2018
55
author: sptramer
66
ms.author: sttramer
77
ms.manager: carmonm
@@ -14,11 +14,12 @@ Starting in November 2018, the Azure PowerShell `Az` module is available for ful
1414
Az offers shorter commands, improved stability, and supports Windows, macOS, and Linux. Az also offers
1515
feature parity and an easy migration path from AzureRM.
1616

17-
Az is built on the .NET Standard library, which means that it runs under both PowerShell 5.x on
18-
Windows and PowerShell Core on any platform. Using .NET Standard allows us to unify the code base of Azure
19-
PowerShell with minimal impact on users.
17+
Az uses the .NET Standard library, which means it runs on PowerShell 5.x and PowerShell 6.x.
18+
Since PowerShell 6.x can run on Linux, macOS, and Windows, that means Az is available for all platforms.
19+
Using .NET Standard allows us to unify the code base of Azure PowerShell with minimal impact on users.
2020

21-
This is a new module, so the version has been reset. The first stable release will be 1.0.
21+
Az is a new module, so the version has been reset. The first stable release will be 1.0, but the module
22+
has feature parity with AzureRm as of November 2018.
2223

2324
## Upgrade to Az
2425

@@ -30,19 +31,17 @@ It's recommended that users upgrade to the new `Az` module. To do so:
3031

3132
## Migrate existing scripts to Az
3233

33-
Major updates like this can be inconvenient. However, the `Az` module has a compatibility mode to
34+
Major updates can be inconvenient. However, the `Az` module has a compatibility mode to
3435
help you use existing scripts while you work on updates to the new syntax. Use the
3536
`Enable-AzureRmAlias` cmdlet to enable the `AzureRM` compatibility mode. This cmdlet defines
3637
`AzureRM` cmdlet names as aliases for the new `Az` cmdlet names.
3738

38-
The new cmdlet names have also been designed to be easy to learn. Instead of using `AzureRm` or `Azure` in cmdlet names,
39-
use `Az`. For most cmdlets, this should be the only change required. For example, the old command `New-AzureRmVm`
40-
has become `New-AzVm`.
39+
The new cmdlet names have been designed to be easy to learn. Instead of using `AzureRm` or `Azure`
40+
in cmdlet names, use `Az`. For example, the old command `New-AzureRmVm` has become `New-AzVm`.
4141

4242
For a full description of the migration process, see [Migrate from AzureRM to Az](migrate-from-azurerm-to-az.md).
4343

4444
## The future of support for AzureRM
4545

46-
The existing `AzureRM` module will no longer recieve new cmdlets or features when `Az` version 1.0 is released
47-
in December 2018. However, `AzureRM` is still officially maintained and will get bug fixes. To keep up with the latest
48-
Azure services and features, you should switch to the `Az` module as soon as possible.
46+
The existing `AzureRM` module will no longer receive new cmdlets or features when `Az` version 1.0 is released
47+
in December 2018. However, `AzureRM` is still officially maintained and will get bug fixes. To keep up with the latest Azure services and features, you should switch to the `Az` module.

0 commit comments

Comments
 (0)