@@ -14,12 +14,31 @@ Starting in December 2018, the Azure PowerShell Az module is in general release
14
14
PowerShell module for interacting with Azure. Az offers shorter commands, improved stability, and
15
15
cross-platform support. Az also offers feature parity and an easy migration path from AzureRM.
16
16
17
- Az uses the .NET Standard library, which means it runs on PowerShell 5 and PowerShell 6.
18
- Since PowerShell 6 can run on Linux, macOS, and Windows, Azure PowerShell is now available for all platforms.
19
- Using .NET Standard allows us to unify the code base of Azure PowerShell with minimal impact on users.
17
+ With the Az module, Azure PowerShell is now compatible with PowerShell 5.1 on Windows and PowerShell Core 6.x
18
+ and later on all supported platforms - including Windows, macOS, and Linux.
20
19
21
20
Az is a new module, so the version has been reset to 1.0.0.
22
21
22
+ ## Why a new module?
23
+
24
+ Major updates can be inconvenient, so it's important that we let you know why the decision was made to
25
+ introduce a new set of modules, with new cmdlets, for interacting with Azure from PowerShell.
26
+
27
+ The biggest and most important change is that PowerShell has been a cross-platform product since the
28
+ introduction of [ PowerShell Core 6.x] ( /powershell/scripting/overview ) , based on the .NET Standard library.
29
+ We're committed to bringing Azure support to all platforms, which means that the Azure PowerShell modules
30
+ needed to be updated to use .NET Standard and be compatible with PowerShell Core. Rather than taking the
31
+ existing AzureRM module and introduce complex changes to add this support, the Az module was created.
32
+
33
+ <!-- NOTE: nbsp used here to avoid markdown parsing error-->
34
+ Creating a new module also gave our engineers the opportunity to make the design and naming of cmdlets
35
+ and modules consistent. All modules now start with the ` Az. ` prefix and use the _ ` Verb ` _ -Az  ; _ ` Noun ` _
36
+ form. Previously, cmdlet names were not only longer, there were inconsistencies in cmdlet names.
37
+
38
+ By making these important changes that required building a Azure PowerShell module, the team has
39
+ committed to making it easier than ever, and on more platforms than previously possible, to use
40
+ Azure with PowerShell cmdlets.
41
+
23
42
## Upgrade to Az
24
43
25
44
It's recommended that all users upgrade to the new Az module. To do so:
@@ -31,10 +50,15 @@ It's recommended that all users upgrade to the new Az module. To do so:
31
50
32
51
## Migrate existing scripts to Az
33
52
34
- Major updates can be inconvenient. However, the Az module has a compatibility mode to
35
- help you use existing scripts while you work on updates to the new syntax. Use the
36
- ` Enable-AzureRmAlias ` cmdlet to enable the AzureRM compatibility mode. This cmdlet defines
37
- AzureRM cmdlet names as aliases for the new Az cmdlet names.
53
+ The Az module has a compatibility mode to help you use existing scripts while you work on
54
+ updates to the new syntax. Use the [ Enable-AzureRmAlias] ( /powershell/module/az.accounts/enable-azurermalias )
55
+ cmdlet to enable the AzureRM compatibility mode. This cmdlet defines AzureRM cmdlet names as aliases for
56
+ the new Az cmdlet names.
57
+
58
+ > [ !IMPORTANT]
59
+ > Even though the cmdlet names are aliased, there may still be new (or renamed) parameters for the
60
+ > Az cmdlets that will be exposed. Don't expect enabling aliases to take care of the full migration
61
+ > for you! After enabling them, test your scripts to make sure they don't need any immediate updates.
38
62
39
63
The new cmdlet names have been designed to be easy to learn. Instead of using ` AzureRm ` or ` Azure `
40
64
in cmdlet names, use ` Az ` . For example, the old command ` New-AzureRMVm ` has become ` New-AzVm ` .
0 commit comments