Skip to content

Commit 6bebeff

Browse files
authored
Refresh of azps docs (MicrosoftDocs#1919)
1 parent 1063ff6 commit 6bebeff

File tree

69 files changed

+1223
-674
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+1223
-674
lines changed

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Sign in with Azure PowerShell
33
description: How to sign in with Azure PowerShell as a user, service principal, or with managed identities for Azure resources.
44
ms.devlang: powershell
55
ms.topic: conceptual
6-
ms.date: 08/10/2021
6+
ms.date: 09/27/2021
77
ms.custom: devx-track-azurepowershell
88
ms.service: azure-powershell
99
---
@@ -52,7 +52,7 @@ in a variable to be used in the next two sections of this article.
5252
$tenantId = (Get-AzContext).Tenant.Id
5353
```
5454

55-
## Sign in with a service principal <a name="sp-signin"/>
55+
## Sign in with a service principal
5656

5757
Service principals are non-interactive Azure accounts. Like other user accounts, their permissions
5858
are managed with Azure Active Directory. By granting a service principal only the permissions it
@@ -61,11 +61,10 @@ needs, your automation scripts stay secure.
6161
To learn how to create a service principal for use with Azure PowerShell, see
6262
[Create an Azure service principal with Azure PowerShell](create-azure-service-principal-azureps.md).
6363

64-
To sign in with a service principal, use the `-ServicePrincipal` argument with the
65-
`Connect-AzAccount` cmdlet. You'll also need the service principal's application ID, sign-in
66-
credentials, and the tenant ID associate with the service principal. How you sign in with a service
67-
principal depends on whether it's configured for password-based or certificate-based
68-
authentication.
64+
To sign in with a service principal, use the `ServicePrincipal` parameter of the `Connect-AzAccount`
65+
cmdlet. You'll also need the service principal's application ID, sign-in credentials, and the tenant
66+
ID associate with the service principal. How you sign in with a service principal depends on whether
67+
it's configured for password-based or certificate-based authentication.
6968

7069
### Password-based authentication
7170

@@ -109,17 +108,18 @@ local certificate store based on a certificate thumbprint.
109108
Connect-AzAccount -ApplicationId $appId -Tenant $tenantId -CertificateThumbprint <thumbprint>
110109
```
111110

112-
When using a service principal instead of a registered application, add the `-ServicePrincipal` argument
113-
and provide the service principal's Application ID as the `-ApplicationId` parameter's value.
111+
When using a service principal instead of a registered application, specify the `ServicePrincipal`
112+
parameter and provide the service principal's Application ID as the `-ApplicationId` parameter's
113+
value.
114114

115115
```azurepowershell-interactive
116116
Connect-AzAccount -ServicePrincipal -ApplicationId $servicePrincipalId -Tenant $tenantId -CertificateThumbprint <thumbprint>
117117
```
118118

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

124124
#### Import a certificate in PowerShell 5.1
125125

@@ -162,23 +162,23 @@ that assigned identity.
162162

163163
## Sign in with a non-default tenant or as a Cloud Solution Provider (CSP)
164164

165-
If your account is associated with more than one tenant, sign-in requires the `-Tenant` parameter to
165+
If your account is associated with more than one tenant, sign-in requires the `Tenant` parameter to
166166
be specified when connecting. This parameter works with any sign-in method. When logging in, this
167167
parameter value can either be the Azure object ID of the tenant (Tenant ID) or the fully qualified
168168
domain name of the tenant.
169169

170170
If you're a [Cloud Solution Provider (CSP)](https://azure.microsoft.com/offers/ms-azr-0145p/), the
171-
`-Tenant` value **must** be a tenant ID.
171+
value for the `Tenant` parameter **must** be a tenant ID.
172172

173173
```azurepowershell-interactive
174-
Connect-AzAccount -Tenant 'xxxx-xxxx-xxxx-xxxx'
174+
Connect-AzAccount -Tenant '00000000-0000-0000-0000-000000000000'
175175
```
176176

177177
## Sign in to another Cloud
178178

179179
Azure cloud services offer environments compliant with regional data-handling laws. For accounts in
180-
a regional cloud, set the environment when you sign in with the `-Environment` argument. This
181-
parameter works with any sign-in method. For example, if your account is in the China cloud:
180+
a regional cloud, set the environment when you sign in with the `Environment` parameter. This
181+
parameter works with any sign-in method. For example, if your account is in Azure China 21Vianet:
182182

183183
```azurepowershell-interactive
184184
Connect-AzAccount -Environment AzureChinaCloud
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Use the Az PowerShell module behind a proxy
3+
description: How to use the Azure Az PowerShell module behind a proxy server
4+
ms.date: 09/27/2021
5+
ms.devlang: powershell
6+
ms.topic: conceptual
7+
ms.custom: devx-track-azurepowershell
8+
ms.service: azure-powershell
9+
---
10+
11+
# Use the Az PowerShell module behind a proxy
12+
13+
If a proxy is necessary for HTTP request, the Azure PowerShell team recommends the following proxy
14+
configuration for different platforms:
15+
16+
| **Platform** | **Recommended Proxy Settings** | **Comment** |
17+
| ----------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
18+
| Windows PowerShell 5.1 | System proxy settings | Do not suggest setting HTTP_PROXY/HTTPS_PROXY environment variables. |
19+
| PowerShell 7 on Windows | System proxy settings | Proxy could be configured by setting both HTTP_PROXY and HTTPS_PROXY environment variables. |
20+
| PowerShell 7 on macOS | System proxy settings | Proxy could be configured by setting both HTTP_PROXY and HTTPS_PROXY environment variables. |
21+
| PowerShell 7 on Linux | Set both HTTP_PROXY and HTTPS_PROXY environment variables, plus optional NO_PROXY | The environment variables should be set before starting PowerShell, otherwise they may not be respected. |
22+
23+
The environment variables used are:
24+
25+
- HTTP_PROXY: the proxy server used on HTTP requests.
26+
- HTTPS_PROXY: the proxy server used on HTTPS requests.
27+
- NO_PROXY: a comma-separated list of hostnames that should be excluded from proxying.
28+
29+
On systems where environment variables are case-sensitive, the variable names may be all lowercase
30+
or all uppercase. The lowercase names are checked first.

docs-conceptual/azps-5.9.0/azureps-in-docker.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Using Azure PowerShell in Docker
33
description: How to use Azure PowerShell that is preinstalled in a Docker image.
44
ms.devlang: powershell
55
ms.topic: conceptual
6-
ms.date: 03/20/2020
7-
ms.custom: devx-track-azurepowershell
6+
ms.date: 09/27/2021
7+
ms.custom: devx-track-azurepowershell
88
ms.service: azure-powershell
99
---
1010

@@ -26,7 +26,7 @@ For each new release of the Az module we are releasing an image for the followin
2626

2727
- Ubuntu 18.04 (default)
2828
- Debian 9
29-
- CentOs 7
29+
- CentOS 7
3030

3131
A full list of available images can be found on our [Docker image][az image] page.
3232

@@ -47,7 +47,9 @@ PowerShell session.
4747
docker run -it mcr.microsoft.com/azure-powershell pwsh
4848
```
4949

50-
For Windows Docker hosts, you must enable Docker File Sharing to allow local drives on Windows to be shared with Linux containers. For more information see [Get started with Docker for Windows][file-sharing].
50+
For Windows Docker hosts, you must enable Docker file sharing to allow local drives on Windows to be
51+
shared with Linux containers. For more information see
52+
[Get started with Docker for Windows][file-sharing].
5153

5254
### Run the azure-powershell container interactively using host authentication
5355

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Azure PowerShell support lifecycle
3+
description: Details about the support lifecycle of the Azure PowerShell modules
4+
ms.devlang: powershell
5+
ms.topic: conceptual
6+
ms.date: 09/29/2021
7+
ms.custom: devx-track-azurepowershell
8+
ms.service: azure-powershell
9+
---
10+
11+
# Azure PowerShell Support Lifecycle
12+
13+
## Az PowerShell modules
14+
15+
The _"Az PowerShell modules"_ are comprised of the module named _"Az"_ and the dependent modules
16+
signed by _"Microsoft Corporation"_. The Az PowerShell modules are identifiable by their names, that
17+
starting with _"Az."_. For the current list of Az PowerShell modules, see
18+
[Azure PowerShell Modules](https://github.com/Azure/azure-powershell/blob/master/documentation/azure-powershell-modules.md).
19+
20+
The Az PowerShell modules support lifecycle falls under the
21+
[Azure SDK lifecycle policy](https://support.microsoft.com/help/18486). We support no less than the
22+
last minor version of each of the two most recent major versions of the Az PowerShell module.
23+
24+
## AzureRM PowerShell modules
25+
26+
Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more,
27+
we'll retire AzureRM PowerShell modules on 29 February 2024.
28+
29+
To avoid service interruptions, [update your scripts](https://aka.ms/azpsmigrate) that use AzureRM
30+
PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your
31+
scripts, follow the
32+
[quickstart guide](/powershell/azure/quickstart-migrate-azurerm-to-az-automatically).
33+
34+
## Supported environments
35+
36+
The following table identifies the supported platforms for the Az, AzureRM, and Azure PowerShell
37+
modules.
38+
39+
| Az | PowerShell <br/> 7.1.3 | PowerShell <br/> >= 7.0.6 | PowerShell <br/> <= 7.0.5 | Windows PowerShell <br/> 5.1 |
40+
| :--------------: | :--------------------: | :-----------------------: | :-----------------------: | :--------------------------: |
41+
| Az 6.0 | Supported | Supported | Not supported | Supported |
42+
| Az 5.9 | Supported | Supported | Supported | Supported |
43+
| AzureRM (6.13.2) | Not Supported | Not Supported | Not Supported | Supported |
44+
| Azure (5.3.1) | Not Supported | Not Supported | Not Supported | Supported |
45+
46+
> [!NOTE]
47+
> PowerShell 6.2 has reached its end of life as of September 4, 2020. The Az PowerShell modules are
48+
> not supported on any version of PowerShell 6.
49+
50+
### Information about CVE-2021-26701
51+
52+
The Az PowerShell modules use components impacted by security advisory
53+
[CVE-2021-26701](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2021-26701) which has
54+
been fixed in PowerShell 7.0.6 and 7.1.3. For more information, see
55+
[Microsoft Security Advisory CVE-2021-26701: .NET Core Remote Code Execution Vulnerability](https://github.com/PowerShell/Announcements/issues/23).
56+
57+
Starting with Az 6.0.0, PowerShell 7.0.6 or 7.1.3 or later is required. When the Az.Accounts module
58+
is imported, the following non-blocking message will be displayed if an unsupported version of
59+
PowerShell is being used: _"This version of Az.Accounts is only supported on Windows PowerShell 5.1
60+
and PowerShell 7.0.6 or greater, open
61+
[https://aka.ms/install-powershell](https://aka.ms/install-powershell) to learn how to upgrade. For
62+
further information, go to [https://aka.ms/azpslifecyle](https://aka.ms/azpslifecyle)."_

docs-conceptual/azps-5.9.0/azureps-vm-tutorial.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
level: Beginner
88
displayType: two-column
99
interactive: azurepowershell
10-
ms.date: 12/13/2018
10+
ms.date: 09/07/2021
1111
ms.author: mirobb
1212
author: mikefrobbins
1313
manager: barbkess

0 commit comments

Comments
 (0)