You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updated readme as referenced in issue 14021 (Azure#19954)
* Updated readme as referenced in issue 14021
* Reverted table due to formatting issues
Co-authored-by: Mike F. Robbins <mikefrobbins@users.noreply.github.com>
Run the following command in an elevated PowerShell session to install the rollup module for Azure PowerShell cmdlets:
26
+
Run the following command in a PowerShell session to install the Az PowerShell module:
24
27
25
28
```powershell
26
-
Install-Module -Name Az
29
+
Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force
27
30
```
28
31
29
-
This module runs on Windows PowerShell with [.NET Framework 4.7.2][DotNetFramework] or greater, or [the latest version of PowerShell 7][PowerShellCore]. The `Az` module replaces `AzureRM`. You should not install `Az` side-by-side with `AzureRM`.
32
+
[The latest version of PowerShell 7][PowerShellCore] is the recommended version of PowerShell for
33
+
use with the Az PowerShell module on all platforms including Windows, Linux, and macOS. This module
34
+
also runs on Windows PowerShell 5.1 with [.NET Framework 4.7.2][DotNetFramework] or higher.
35
+
36
+
The `Az` module replaces `AzureRM`. You should not install `Az` side-by-side with `AzureRM`.
30
37
31
-
If you have an earlier version of the Azure PowerShell modules installed from the PowerShell Gallery and would like to update to the latest version, run the following commands in an elevated PowerShell session:
38
+
If you have an earlier version of the Azure PowerShell module installed from the PowerShell Gallery
39
+
and would like to update to the latest version, run the following command in a PowerShell session:
32
40
33
41
```powershell
34
-
Update-Module -Name Az
42
+
Update-Module -Name Az -Scope CurrentUser -Force
35
43
```
36
44
37
-
`Update-Module` installs the new version side-by-side with previous versions. It does not uninstall the previous versions.
45
+
`Update-Module` installs the new version side-by-side with previous versions. It does not uninstall
46
+
the previous versions.
38
47
39
-
For detailed instructions on installing Azure PowerShell, please refer to the [installation guide][InstallationGuide].
48
+
For more information on installing Azure PowerShell, see the
49
+
[installation guide][InstallationGuide].
40
50
41
51
## Usage
42
52
@@ -45,26 +55,30 @@ For detailed instructions on installing Azure PowerShell, please refer to the [i
45
55
To connect to Azure, use the [`Connect-AzAccount`][ConnectAzAccount] cmdlet:
46
56
47
57
```powershell
48
-
# Device Code login - Provides a link to sign into Azure via your web browser
58
+
# Opens a new browser window to log into your Azure account.
49
59
Connect-AzAccount
50
60
51
-
# Service Principal login - Use a previously created service principal to log in
To log into a specific cloud (_AzureChinaCloud_, _AzureCloud_, _AzureUSGovernment_), use the `-Environment` parameter:
66
+
To log into a specific cloud (_AzureChinaCloud_, _AzureCloud_, _AzureUSGovernment_), use the
67
+
`Environment` parameter:
56
68
57
69
```powershell
58
-
# Specific cloud login - Logs into the Azure China cloud
70
+
# Log into a specific cloud, for example the Azure China cloud.
59
71
Connect-AzAccount -Environment AzureChinaCloud
60
72
```
61
73
62
-
### Getting and setting your Azure PowerShell session context
74
+
### Session context
63
75
64
-
A session context persists login information across Azure PowerShell modules and PowerShell instances. To view the context you are using in the current session, which contains the subscription and tenant, use the [`Get-AzContext`][GetAzContext] cmdlet:
76
+
A session context persists login information across Azure PowerShell modules and PowerShell
77
+
instances. Use the [`Get-AzContext`][GetAzContext] cmdlet to view the context you are using in the
78
+
current session. The results contain the Azure tenant and subscription.
65
79
66
80
```powershell
67
-
# Gets the Azure PowerShell context for the current PowerShell session
81
+
# Get the Azure PowerShell context for the current PowerShell session
68
82
Get-AzContext
69
83
70
84
# Lists all available Azure PowerShell contexts in the current PowerShell session
@@ -81,7 +95,8 @@ Get-AzSubscription
81
95
Get-AzSubscription -TenantId $TenantId
82
96
```
83
97
84
-
To change the subscription that you are using for your current context, use the [`Set-AzContext`][SetAzContext] cmdlet:
98
+
To change the subscription that you are using for your current context, use the
99
+
[`Set-AzContext`][SetAzContext] cmdlet:
85
100
86
101
```powershell
87
102
# Set the Azure PowerShell context to a specific Azure subscription
To view the help content for a cmdlet, use the `Get-Help` cmdlet:
114
130
115
131
```powershell
116
-
# View the basic help content for Get-AzSubscription
132
+
# View basic help information for Get-AzSubscription
117
133
Get-Help -Name Get-AzSubscription
118
134
119
135
# View the examples for Get-AzSubscription
120
136
Get-Help -Name Get-AzSubscription -Examples
121
137
122
-
# View the full help content for Get-AzSubscription
138
+
# View the full help for Get-AzSubscription
123
139
Get-Help -Name Get-AzSubscription -Full
124
140
125
-
# View the help content for Get-AzSubscription on https://docs.microsoft.com
141
+
# View the online version of the help from https://learn.microsoft.com for Get-AzSubscription
126
142
Get-Help -Name Get-AzSubscription -Online
127
143
```
128
144
129
-
For detailed instructions on using Azure PowerShell, please refer to the [getting started guide][GettingStartedGuide].
145
+
For detailed instructions on using Azure PowerShell, see the [getting started guide][GettingStartedGuide].
130
146
131
147
## Reporting Issues and Feedback
132
148
133
149
### Issues
134
150
135
-
If you find any bugs when using the Azure PowerShell modules, please file an issue in our [GitHub issues][GitHubIssues] page. Please fill out the provided template with the appropriate information.
151
+
If you find any bugs when using Azure PowerShell, file an issue in our [GitHub repo][GitHubRepo].
152
+
Fill out the issue template with the appropriate information.
136
153
137
-
Alternatively, be sure to check out the [Azure Community Support](https://azure.microsoft.com/en-us/support/community/) if you have issues with the cmdlets or Azure services.
154
+
Alternatively, see [Azure Community Support][AzureCommunitySupport] if you
155
+
have issues with Azure PowerShell or Azure services.
138
156
139
157
### Feedback
140
158
141
-
If there is a feature you would like to see in Azure PowerShell, please use the [`Send-Feedback`][SendFeedback] cmdlet, or file an issue in our [GitHub issues][GitHubIssues] page to provide the Azure PowerShell team direct feedback.
159
+
If there is a feature you would like to see in Azure PowerShell, use the
160
+
[`Send-Feedback`][SendFeedback] cmdlet, or file an issue in our [GitHub repo][GitHubRepo].
142
161
143
162
## Contribute Code
144
163
145
-
If you would like to become an active contributor to this project, please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines][ContributionGuidelines].
164
+
If you would like to become a contributor to this project, see the instructions provided in
Additional information about contributing to this repository can be found in the [`CONTRIBUTING.md`][Contributing] document and the [_Azure PowerShell Developer Guide_][DeveloperGuide] document.
167
+
Additional information about contributing to this repository can be found in
168
+
[`CONTRIBUTING.md`][Contributing] and the [_Azure PowerShell Developer Guide_][DeveloperGuide].
148
169
149
170
## Telemetry
150
171
151
-
Azure PowerShell collects telemetry data by default. Microsoft aggregates collected data to identify patterns of usage to identify common issues and to improve the experience of Azure PowerShell. Microsoft Azure PowerShell does not collect any private or personal data.
152
-
For example, the usage data helps identify issues such as cmdlets with low success and helps prioritize our work.
153
-
While we appreciate the insights this data provides, we also understand that not everyone wants to send usage data. You can disable data collection with the [`Disable-AzDataCollection`](/powershell/module/az.accounts/disable-azdatacollection) cmdlet. You can also read our [privacy statement](https://privacy.microsoft.com/privacystatement) to learn more.
172
+
Azure PowerShell collects telemetry data by default. Microsoft aggregates collected data to identify
173
+
patterns of usage to identify common issues and to improve the experience of Azure PowerShell.
174
+
Microsoft Azure PowerShell does not collect any private or personal data. For example, the usage
175
+
data helps identify issues such as cmdlets with low success and helps prioritize our work. While we
176
+
appreciate the insights this data provides, we also understand that not everyone wants to send usage
177
+
data. You can disable data collection with the
178
+
[`Disable-AzDataCollection`][DisableAzDataCollection] cmdlet. To learn more, see our
_This project has adopted the [Microsoft Open Source Code of Conduct][CodeOfConduct]. For more information see the [Code of Conduct FAQ][CodeOfConductFaq] or contact [opencode@microsoft.com][OpenCodeEmail] with any additional questions or comments._
187
+
_This project has adopted the [Microsoft Open Source Code of Conduct][CodeOfConduct]. For more
188
+
information see the [Code of Conduct FAQ][CodeOfConductFaq] or contact
189
+
[opencode@microsoft.com][OpenCodeEmail] with any additional questions or comments._
0 commit comments