Skip to content

Commit 7336b43

Browse files
authored
Merge pull request #7470 from alexandair/patch-2
Fix typos and capitalization
2 parents 038d33f + da82e02 commit 7336b43

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

documentation/announcing-az-module.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Announcing New Module 'Az'
22
In August 2018 we released a new module, 'Az' which combines the functionality of the AzureRM and AzureRM.Netcore modules. Az runs on both PowerShell 5.1 and PowerShell Core. 'Az' ensures that the PowerShell and PowerShell Core cmdlets for managing Azure resources will always be in sync and up to date. In addition, Az will simplify and regularize the naming of Azure cmdlets, and the organization of Azure modules. Az is intended as a replacement for the AzureRM.Netcore and AzureRM modules.
33

4-
Az currently ships in CloudShell, and can be found on the PowerShell Gallery [here](https://www.powershellgallery.com/packages/Az/)
4+
Az currently ships in Cloud Shell, and can be found on the PowerShell Gallery [here](https://www.powershellgallery.com/packages/Az/)
55

66
Az is a new module, and reorganizing and simplifying cmdlet names involves breaking changes, so we have [added features to Az to make it easier to transition to the simplified, normalized names in your existing scripts](#migrating-from-azurerm).
77

88
## New Features
99
- PowerShell 5.1 and PowerShell Core support in the same module
1010
- PowerShell Core Edition and PowerShell Desktop Edition cmdlets always in sync and up to date with latest Azure capabilities
11-
- Shortened and Normalized cmdlet names - all cmdlets use the noun prefix 'Az'
12-
- Normalized module Organization - data plane and management plane cmdlets in the same module for each service
11+
- Shortened and normalized cmdlet names - all cmdlets use the noun prefix 'Az'
12+
- Normalized module organization - data plane and management plane cmdlets in the same module for each service
1313
- Enhanced authentication for Netcore
14-
* Self-renewing Service Princpal Authentication
14+
* Self-renewing Service Principal Authentication
1515
* Service Principal Certificate Authentication (in the future)
1616
- Enable/Disable-AzureRmAlias cmdlets to manage compatibility with scripts based on AzureRM
1717

1818
## Supported Platforms
1919
- PowerShell 5.1 with .Net Framework 4.7.2 or later [Windows only]
20-
- PowerShell Core 6.0 - Windows, Linux, MacOS
21-
- PowerShell Core 6.1 - Windows, Linux, MacOS
20+
- PowerShell Core 6.0 - Windows, Linux, macOS
21+
- PowerShell Core 6.1 - Windows, Linux, macOS
2222

2323
## Timeline
2424
- Initial Release - August 2018
@@ -27,7 +27,7 @@ Az is a new module, and reorganizing and simplifying cmdlet names involves break
2727

2828

2929
## AzureRM Module Support
30-
Azure RM will continue to be supported, and important bugs will be fixed, but new development and new Azure capabilities will be shipped only in Az starting December 2018
30+
AzureRM will continue to be supported, and important bugs will be fixed, but new development and new Azure capabilities will be shipped only in Az starting December 2018.
3131

3232
## Migrating From AzureRM
3333

@@ -37,8 +37,7 @@ To make it easier for existing scripts to migrate from AzureRM to Az, we have pr
3737
PS C:\> Enable-AzureRmAlias
3838
```
3939

40-
will enable Azure RM aliases in the Az module for the current PowerShell session. For your convenience, we have added a ```Scope``` parameter that will automatically
41-
set up the AzureRm aliases in Az for every PowerShell session:
40+
will enable AzureRM aliases in the Az module for the current PowerShell session. For your convenience, we have added a ```Scope``` parameter that will automatically set up the AzureRM aliases in Az for every PowerShell session:
4241

4342
```powershell
4443
PC C:\> Enable-AzureRmAlias -Scope CurrentUser
@@ -50,7 +49,7 @@ Sets up AzureRM cmdlet name aliases in the Az module for all sessions started by
5049
PS C:\> Enable-AzureRmAlias -Scope LocalMachine
5150
```
5251

53-
Sets up AzureRM Cmdlet aliases in the Az module for all sessions started on this machine for any user. You can turn aliases off similarly using the ```Disable-AzureRmAlias``` cmdlet
52+
sets up AzureRM cmdlet aliases in the Az module for all sessions started on this machine for any user. You can turn aliases off similarly using the ```Disable-AzureRmAlias``` cmdlet
5453

5554
```powershell
5655
PS C:\> Disable-AzureRmAlias
@@ -71,7 +70,7 @@ PS C:\> Disable-AzureRmAlias -Scope LocalMachine
7170
### Module Name Changes
7271
For scripts that import modules directly, or use ```#Requires``` statements to specify required modules, references to ```AzureRM.*``` will need to be changed to the appropriate ```Az``` module. A current list of AzureRM modules and their Az equivalents are listed below. Note that this list is subject to change as module names in Az are updated through November 2018.
7372

74-
| Azure RM Module Name | Az Module Name|
73+
| AzureRM Module Name | Az Module Name|
7574
| -------------------------------------- | ------------------------------- |
7675
| AzureRM | Az |
7776
| Azure.AnalysisServices | Az.AnalysisServices |
@@ -81,7 +80,7 @@ For scripts that import modules directly, or use ```#Requires``` statements to s
8180
| AzureRM.ApiManagement | Az.ApiManagement |
8281
| AzureRM.ApplicationInsights | Az.ApplicationInsights* |
8382
| AzureRM.Automation | Az.Automation |
84-
| AzureRM.Backup | Az.Backup***|
83+
| AzureRM.Backup | Az.Backup*** |
8584
| AzureRM.Batch | Az.Batch |
8685
| AzureRM.Billing | Az.Billing |
8786
| AzureRM.Cdn | Az.Cdn |
@@ -105,7 +104,7 @@ For scripts that import modules directly, or use ```#Requires``` statements to s
105104
| AzureRM.HDInsight | Az.HDInsight** |
106105
| AzureRM.Insights | Az.Insights* |
107106
| AzureRM.IotHub | Az.IoTHub |
108-
| AzureRM.KeyVault | Az.KeyVault|
107+
| AzureRM.KeyVault | Az.KeyVault |
109108
| AzureRM.LogicApp | Az.LogicApp*** |
110109
| AzureRM.MachineLearning | Az.MachineLearning |
111110
| AzureRM.MachineLearningCompute | Az.MachineLearningCompute* |
@@ -117,12 +116,12 @@ For scripts that import modules directly, or use ```#Requires``` statements to s
117116
| AzureRM.Network | Az.Network* |
118117
| AzureRM.NotificationHubs | Az.NotificationHubs* |
119118
| AzureRM.OperationalInsights | Az.OperationalIsights |
120-
| AzureRM.PolicyInsights | Az.PolicyInsights *|
119+
| AzureRM.PolicyInsights | Az.PolicyInsights* |
121120
| AzureRM.PowerBIEmbedded | Az.PowerBIEmbedded* |
122121
| AzureRM.Profile | Az.Profile* |
123-
| AzureRM.RecoveryServices | Az.RecoveryServices**|
124-
| AzureRM.RecoveryServices.Backup | Az.RecoveryServices**|
125-
| AzureRM.RecoveryServices.SiteRecovery | Az.RecoveryServices**|
122+
| AzureRM.RecoveryServices | Az.RecoveryServices** |
123+
| AzureRM.RecoveryServices.Backup | Az.RecoveryServices** |
124+
| AzureRM.RecoveryServices.SiteRecovery | Az.RecoveryServices** |
126125
| AzureRM.RedisCache | Az.RedisCache** |
127126
| AzureRM.Relay | Az.Relay* |
128127
| AzureRM.Reservations | Az.Reservations* |
@@ -144,7 +143,7 @@ For scripts that import modules directly, or use ```#Requires``` statements to s
144143
| AzureRM.Websites | Az.Websites |
145144

146145

147-
```*``` Module Name may change for 1.0
146+
```*``` Module name may change for 1.0
148147

149148
```**``` Module not yet available
150149

@@ -165,6 +164,6 @@ If you need to have both modules installed:
165164

166165
- You cannot load Az and AzureRM modules in the same PowerShell session, but they can be used in seperate sessions as follows
167166
- In AzureRM session: ```Import-Module AzureRM```
168-
- In Az session: Use cmdlets with Az noun, do not use cmdlets with AzureRM noun
167+
- In Az session: Use cmdlets with Az noun, do not use cmdlets with AzureRm noun
169168

170169

0 commit comments

Comments
 (0)