Az
2.1.0
Microsoft Azure PowerShell - Cmdlets to manage resources in Azure. This module is compatible with WindowsPowerShell and PowerShell Core.
For more information about the Az module, please visit the following: https://docs.microsoft.com/en-us/powershell/azure/
Minimum PowerShell version
5.1
See the version list below for details.
Installation Options
Owners
Copyright
Microsoft Corporation. All rights reserved.
Package Details
Author(s)
- Microsoft Corporation
Tags
Azure ARM ResourceManager Linux AzureAutomationNotSupported
PSEditions
Dependencies
-
- Az.Accounts (>= 1.5.2)
- Az.Aks (= 1.0.1)
- Az.AnalysisServices (= 1.1.0)
- Az.ApiManagement (= 1.1.0)
- Az.ApplicationInsights (= 1.0.0)
- Az.Automation (= 1.2.2)
- Az.Batch (= 1.1.0)
- Az.Billing (= 1.0.0)
- Az.Cdn (= 1.2.0)
- Az.CognitiveServices (= 1.1.1)
- Az.Compute (= 2.1.0)
- Az.ContainerInstance (= 1.0.1)
- Az.ContainerRegistry (= 1.0.1)
- Az.DataFactory (= 1.1.1)
- Az.DataLakeAnalytics (= 1.0.0)
- Az.DataLakeStore (= 1.2.1)
- Az.DeploymentManager (= 1.0.0)
- Az.DevTestLabs (= 1.0.0)
- Az.Dns (= 1.1.0)
- Az.EventGrid (= 1.1.1)
- Az.EventHub (= 1.1.0)
- Az.FrontDoor (= 1.0.0)
- Az.HDInsight (= 2.0.0)
- Az.IotHub (= 1.1.0)
- Az.KeyVault (= 1.2.0)
- Az.LogicApp (= 1.2.1)
- Az.MachineLearning (= 1.1.0)
- Az.MarketplaceOrdering (= 1.0.0)
- Az.Media (= 1.1.0)
- Az.Monitor (= 1.2.1)
- Az.Network (= 1.8.1)
- Az.NotificationHubs (= 1.1.0)
- Az.OperationalInsights (= 1.2.0)
- Az.PolicyInsights (= 1.1.0)
- Az.PowerBIEmbedded (= 1.1.0)
- Az.RecoveryServices (= 1.4.0)
- Az.RedisCache (= 1.1.0)
- Az.Relay (= 1.0.1)
- Az.Resources (= 1.4.0)
- Az.ServiceBus (= 1.1.0)
- Az.ServiceFabric (= 1.0.1)
- Az.SignalR (= 1.0.2)
- Az.Sql (= 1.10.0)
- Az.Storage (= 1.3.0)
- Az.StreamAnalytics (= 1.0.0)
- Az.TrafficManager (= 1.0.1)
- Az.Websites (= 1.2.1)
Release Notes
2.1.0 - May 2019
Az.ApiManagement
* Created new Cmdlets for managing diagnostics at the global and API Scope
- **Get-AzApiManagementDiagnostic** - Get the diagnostics configured a global or api Scope
- **New-AzApiManagementDiagnostic** - Create new diagnostics at the global scope or api Scope
- **New-AzApiManagementHttpMessageDiagnostic** - Create diagnostic setting for which Headers to log and the size of Body Bytes
- **New-AzApiManagementPipelineDiagnosticSetting** - Create Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
- **New-AzApiManagementSamplingSetting** - Create Sampling Setting for the requests/response for a diagnostic
- **Remove-AzApiManagementDiagnostic** - Remove a diagnostic entity at global or api scope
- **Set-AzApiManagementDiagnostic** - Update a diagnostic Entity at global or api scope
* Created new Cmdlets for managing Cache in ApiManagement service
- **Get-AzApiManagementCache** - Get the details of the Cache specified by identifier or all caches
- **New-AzApiManagementCache** - Create a new 'default' Cache or Cache in a particular azure 'region'
- **Remove-AzApiManagementCache** - Remove a cache
- **Update-AzApiManagementCache** - Update a cache
* Created new Cmdlets for managing API Schema
- **New-AzApiManagementSchema** - Create a new Schema for an API
- **Get-AzApiManagementSchema** - Get the schemas configured in the API
- **Remove-AzApiManagementSchema** - Remove the schema configured in the API
- **Set-AzApiManagementSchema** - Update the schema configured in the API
* Created new Cmdlet for generating a User Token.
- **New-AzApiManagementUserToken** - Generate a new User Token valid for 8 hours by default.Token for the 'GIT' user can be generated using this cmdlet./
* Created a new cmdlet to retrieving the Network Status
- **Get-AzApiManagementNetworkStatus** - Get the Network status connectivity of resources on which API Management service depends on. This is useful when deploying ApiManagement service into a Virtual Network and validing whether any of the dependencies are broken.
* Updated cmdlet **New-AzApiManagement** to manage ApiManagement service
- Added support for the new 'Consumption' SKU
- Added support to turn the 'EnableClientCertificate' flag on for 'Consumption' SKU
- The new cmdlet **New-AzApiManagementSslSetting** allows configuring 'TLS/SSL' setting on the 'Backend' and 'Frontend'. This can also be used to configure 'Ciphers' like '3DES' and 'ServerProtocols' like 'Http2' on the 'Frontend' of an ApiManagement service.
- Added support for configuring the 'DeveloperPortal' hostname on ApiManagement service.
* Updated cmdlets **Get-AzApiManagementSsoToken** to take 'PsApiManagement' object as input
* Updated the cmdlet to display Error Messages inline
> PS D:\github\azure-powershell> Set-AzApiManagementPolicy -Context -PolicyFilePath C:\wrongpolicy.xml -ApiId httpbin
> Set-AzApiManagementPolicy :
Error Code: ValidationError
Error Message: One or more fields contain incorrect values:
Error Details:
[Code=ValidationError, Message=Error in element 'log-to-eventhub' on line 3, column 10: Logger not found, Target=log-to-eventhub]
* Updated cmdlet **Export-AzApiManagementApi** to export APIs in 'OpenApi 3.0' format
* Updated cmdlet **Import-AzApiManagementApi**
- To import Api from 'OpenApi 3.0' document specification
- To override the 'PsApiManagementSchema' property specified in any ('Swagger', 'Wadl', 'Wsdl', 'OpenApi') document.
- To override the 'ServiceUrl' property specified in any document.
* Updated cmdlet **Get-AzApiManagementPolicy** to return policy in Non-Xml escaped 'format' using 'rawxml'
* Updated cmdlet **Set-AzApiManagementPolicy** to accept policy in Non-Xml escaped 'format' using 'rawxml' and Xml escaped using 'xml'
* Updated cmdlet **New-AzApiManagementApi**
- To configure API with 'OpenId' authorization server.
- To create an API in an 'ApiVersionSet'
- To clone an API using 'SourceApiId' and 'SourceApiRevision'.
- Ability to configure 'SubscriptionRequired' at the Api scope.
* Updated cmdlet **Set-AzApiManagementApi**
- To configure API with 'OpenId' authorization server.
- To updated an API into an 'ApiVersionSet'
- Ability to configure 'SubscriptionRequired' at the Api scope.
* Updated cmdlet **New-AzApiManagementRevision**
- To clone (copy tags, products, operations and policies) an existing revision using 'SourceApiRevision'. The new Revision assumes the 'ApiId' of the parent.
- To provide an 'ApiRevisionDescription'
- To override the 'ServiceUrl' when cloning an API.
* Updated cmdlet **New-AzApiManagementIdentityProvider**
- To configure 'AAD' or 'AADB2C' with an 'Authority'
- To setup 'SignupPolicy', 'SigninPolicy', 'ProfileEditingPolicy' and 'PasswordResetPolicy'
* Updated cmdlet **New-AzApiManagementSubscription**
- To account for the new SubscriptonModel using 'Scope' and 'UserId'
- To account for the old subscription model using 'ProductId' and 'UserId'
- Add support to enable 'AllowTracing' at the subscription level.
* Updated cmdlet **Set-AzApiManagementSubscription**
- To account for the new SubscriptonModel using 'Scope' and 'UserId'
- To account for the old subscription model using 'ProductId' and 'UserId'
- Add support to enable 'AllowTracing' at the subscription level.
* Updated following cmdlets to accept 'ResourceId' as input
- 'New-AzApiManagementContext'
> New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/contoso
- 'Get-AzApiManagementApiRelease'
> Get-AzApiManagementApiRelease -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/contoso/apis/echo-api/releases/releaseId
- 'Get-AzApiManagementApiVersionSet'
> Get-AzApiManagementApiVersionSet -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/constoso/apiversionsets/pathversionset
- 'Get-AzApiManagementAuthorizationServer'
- 'Get-AzApiManagementBackend'
> Get-AzApiManagementBackend -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/contoso/backends/servicefabric
- 'Get-AzApiManagementCertificate'
- 'Remove-AzApiManagementApiVersionSet'
- 'Remove-AzApiManagementSubscription'
Az.Automation
* Updated Get-AzAutomationJobOutputRecord to handle JSON and Text record values.
- Fix for issue https://github.com/Azure/azure-powershell/issues/7977
- Fix for issue https://github.com/Azure/azure-powershell/issues/8600
* Changed behavior for Start-AzAutomationDscCompilationJob to just start the job instead of waiting for its completion.
* Fix for issue https://github.com/Azure/azure-powershell/issues/8347
* Fix for Get-AzAutomationDscNode when using -Name returns all node. Now it returns matching node only.
Az.Compute
* Add ProtectFromScaleIn and ProtectFromScaleSetAction parameters to Update-AzVmssVM cmdlet.
* New-AzVM wimple parameter set now uses by default an available location if 'East US' is not supported
Az.DataLakeStore
* Update the ADLS sdk to use httpclient, integrate dataplane testing with azure framework
Az.Monitor
* Fixed incorrect parameter names in help examples
Az.Network
* Add DisableBgpRoutePropagation flag to Effective Route Table output
- Updated cmdlet:
- Get-AzEffectiveRouteTable
* Fix double dash in New-AzApplicationGatewayTrustedRootCertificate documentation
Az.Resources
* Add new cmdlet Get-AzureRmDenyAssignment for retrieving deny assignments
Az.Sql
* Rename Advanced Threat Protection cmdlets to Advanced Data Security and enable Vulnerability Assessment by default
FileList
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 15.4.0 | 2,722,658 | 3/3/2026 |
| 15.3.0 | 5,392,523 | 2/3/2026 |
| 15.2.0 | 4,117,769 | 1/13/2026 |
| 15.1.0 | 7,621,670 | 12/2/2025 |
| 15.0.0 | 2,760,745 | 11/18/2025 |
| 14.6.0 | 2,681,808 | 11/4/2025 |
| 14.5.0 | 3,933,398 | 10/14/2025 |
| 14.4.0 | 7,988,330 | 9/2/2025 |
| 14.3.0 | 5,051,591 | 8/5/2025 |
| 14.2.0 | 6,140,169 | 7/1/2025 |
| 14.1.0 | 4,333,417 | 6/3/2025 |
| 14.0.0 | 2,292,207 | 5/19/2025 |
| 13.5.0 | 2,179,754 | 5/6/2025 |
| 13.4.0 | 4,684,454 | 4/1/2025 |
| 13.3.0 | 3,399,777 | 3/4/2025 |
| 13.2.0 | 2,549,986 | 2/11/2025 |
| 13.1.0 | 4,170,921 | 1/14/2025 |
| 13.0.0 | 5,465,878 | 11/19/2024 |
| 12.5.0 | 1,246,087 | 11/11/2024 |
| 12.4.0 | 3,413,738 | 10/8/2024 |
| 12.3.0 | 2,533,255 | 9/3/2024 |
| 12.2.0 | 2,030,576 | 8/6/2024 |
| 12.1.0 | 2,820,434 | 7/9/2024 |
| 12.0.0 | 4,664,677 | 5/21/2024 |
| 11.6.0 | 1,894,399 | 4/30/2024 |
| 11.5.0 | 1,768,241 | 4/2/2024 |
| 11.4.0 | 1,924,278 | 3/5/2024 |
| 11.3.1 | 1,521,180 | 2/9/2024 |
| 11.3.0 | 457,336 | 2/6/2024 |
| 11.2.0 | 1,484,174 | 1/9/2024 |
| 11.1.0 | 1,587,355 | 12/5/2023 |
| 11.0.0 | 1,224,406 | 11/14/2023 |
| 10.4.1 | 3,193,490 | 9/27/2023 |
| 10.4.0 | 70,366 | 9/26/2023 |
| 10.3.0 | 4,594,289 | 9/5/2023 |
| 10.2.0 | 1,283,352 | 8/1/2023 |
| 10.1.0 | 1,086,874 | 7/4/2023 |
| 10.0.0 | 1,510,440 | 5/23/2023 |
| 9.7.1 | 2,478,863 | 4/28/2023 |
| 9.7.0 | 143,159 | 4/25/2023 |
| 9.6.0 | 812,455 | 4/4/2023 |
| 9.5.0 | 1,144,071 | 3/9/2023 |
| 9.4.0 | 2,346,397 | 2/7/2023 |
| 9.3.0 | 1,262,559 | 1/10/2023 |
| 9.2.0 | 1,144,029 | 12/6/2022 |
| 9.1.1 | 692,269 | 11/17/2022 |
| 9.1.0 | 556,723 | 11/1/2022 |
| 9.0.1 | 1,517,312 | 10/17/2022 |
| 8.3.0 | 1,978,323 | 9/6/2022 |
| 8.2.0 | 926,154 | 8/2/2022 |
| 8.1.0 | 690,992 | 7/5/2022 |
| 8.0.0 | 3,987,827 | 5/24/2022 |
| 7.5.0 | 4,363,681 | 4/26/2022 |
| 7.4.0 | 383,541 | 4/5/2022 |
| 7.3.2 | 468,126 | 3/12/2022 |
| 7.3.0 | 271,625 | 3/1/2022 |
| 7.2.1 | 190,285 | 2/18/2022 |
| 7.2.0 | 295,790 | 2/7/2022 |
| 7.1.0 | 691,883 | 1/4/2022 |
| 7.0.0 | 501,503 | 12/7/2021 |
| 6.6.0 | 2,352,368 | 11/2/2021 |
| 6.5.0 | 522,430 | 10/12/2021 |
| 6.4.0 | 759,754 | 9/7/2021 |
| 6.3.0 | 659,406 | 8/3/2021 |
| 6.2.1 | 557,602 | 7/9/2021 |
| 6.2.0 | 69,671 | 7/6/2021 |
| 6.1.0 | 403,088 | 6/15/2021 |
| 6.0.0 | 405,934 | 5/25/2021 |
| 5.9.0 | 3,563,984 | 5/4/2021 |
| 5.8.0 | 441,110 | 4/13/2021 |
| 5.7.0 | 672,038 | 3/23/2021 |
| 5.6.0 | 539,201 | 3/2/2021 |
| 5.5.0 | 887,483 | 2/9/2021 |
| 5.4.0 | 1,647,566 | 1/19/2021 |
| 5.3.0 | 1,474,939 | 12/29/2020 |
| 5.2.0 | 1,395,774 | 12/8/2020 |
| 5.1.0 | 1,692,227 | 11/17/2020 |
| 5.0.0 | 1,713,476 | 10/27/2020 |
| 4.8.0 | 4,481,987 | 10/13/2020 |
| 4.7.0 | 267,525 | 9/22/2020 |
| 4.6.1 | 1,823,797 | 8/28/2020 |
| 4.6.0 | 120,144 | 8/25/2020 |
| 4.5.0 | 432,776 | 8/4/2020 |
| 4.4.0 | 366,933 | 7/14/2020 |
| 4.3.0 | 410,226 | 6/23/2020 |
| 4.2.0 | 400,840 | 6/2/2020 |
| 4.1.0 | 339,568 | 5/19/2020 |
| 4.0.2-preview | 2,418 | 12/23/2019 |
| 4.0.1-preview | 1,058 | 10/9/2019 |
| 3.8.0 | 2,095,062 | 4/21/2020 |
| 3.7.0 | 299,620 | 3/31/2020 |
| 3.6.1 | 372,698 | 3/10/2020 |
| 3.5.0 | 373,096 | 2/18/2020 |
| 3.4.0 | 204,752 | 2/4/2020 |
| 3.3.0 | 382,119 | 1/7/2020 |
| 3.2.0 | 326,421 | 12/17/2019 |
| 3.1.0 | 595,390 | 11/26/2019 |
| 3.0.0 | 464,792 | 11/4/2019 |
| 2.8.0 | 1,140,409 | 10/15/2019 |
| 2.7.0 | 184,611 | 9/24/2019 |
| 2.6.0 | 320,992 | 8/27/2019 |
| 2.5.0 | 423,952 | 7/30/2019 |
| 2.4.0 | 176,127 | 7/2/2019 |
| 2.3.2 | 177,791 | 6/18/2019 |
| 2.2.0 | 78,593 | 6/4/2019 |
| 2.1.0 (current version) | 70,159 | 5/21/2019 |
| 2.0.1 | 11,767 | 12/15/2021 |
| 2.0.0 | 115,410 | 5/6/2019 |
| 1.8.0 | 368,313 | 4/23/2019 |
| 1.7.0 | 55,090 | 4/9/2019 |
| 1.6.0 | 83,148 | 3/26/2019 |
| 1.5.0 | 55,971 | 3/12/2019 |
| 1.4.0 | 43,801 | 2/26/2019 |
| 1.3.0 | 33,054 | 2/12/2019 |
| 1.2.1 | 25,194 | 1/31/2019 |
| 1.2.0 | 4,843 | 1/29/2019 |
| 1.1.0 | 20,118 | 1/15/2019 |
| 1.0.1 | 33,806 | 12/18/2018 |
| 1.0.0 | 28,549 | 12/18/2018 |
| 0.10.0-preview | 14,367 | 4/15/2020 |
| 0.7.0 | 14,749 | 12/4/2018 |
| 0.6.1 | 9,457 | 11/21/2018 |
| 0.5.0 | 9,936 | 11/6/2018 |
| 0.4.0 | 11,302 | 10/23/2018 |
| 0.3.0 | 11,065 | 10/9/2018 |
| 0.2.2 | 5,240 | 9/24/2018 |
| 0.1.0 | 728 | 8/28/2018 |