Az
3.0.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.6.4)
- Az.Advisor (= 1.1.0)
- Az.Aks (= 1.0.2)
- Az.AnalysisServices (= 1.1.1)
- Az.ApiManagement (= 1.3.2)
- Az.ApplicationInsights (= 1.0.2)
- Az.Automation (= 1.3.4)
- Az.Batch (= 2.0.1)
- Az.Billing (= 1.0.1)
- Az.Cdn (= 1.4.0)
- Az.CognitiveServices (= 1.2.1)
- Az.Compute (= 3.0.0)
- Az.ContainerInstance (= 1.0.1)
- Az.ContainerRegistry (= 1.1.0)
- Az.DataFactory (= 1.4.1)
- Az.DataLakeAnalytics (= 1.0.1)
- Az.DataLakeStore (= 1.2.4)
- Az.DeploymentManager (= 1.0.1)
- Az.DevTestLabs (= 1.0.0)
- Az.Dns (= 1.1.1)
- Az.EventGrid (= 1.2.2)
- Az.EventHub (= 1.4.0)
- Az.FrontDoor (= 1.1.2)
- Az.HDInsight (= 3.0.0)
- Az.HealthcareApis (= 1.0.0)
- Az.IotHub (= 2.0.0)
- Az.KeyVault (= 1.3.1)
- Az.LogicApp (= 1.3.1)
- Az.MachineLearning (= 1.1.1)
- Az.ManagedServices (= 1.0.1)
- Az.MarketplaceOrdering (= 1.0.1)
- Az.Media (= 1.1.0)
- Az.Monitor (= 1.4.0)
- Az.Network (= 2.0.0)
- Az.NotificationHubs (= 1.1.0)
- Az.OperationalInsights (= 1.3.3)
- Az.PolicyInsights (= 1.1.3)
- Az.PowerBIEmbedded (= 1.1.0)
- Az.PrivateDns (= 1.0.0)
- Az.RecoveryServices (= 2.0.1)
- Az.RedisCache (= 1.1.1)
- Az.Relay (= 1.0.2)
- Az.Resources (= 1.7.1)
- Az.ServiceBus (= 1.4.0)
- Az.ServiceFabric (= 2.0.0)
- Az.SignalR (= 1.1.0)
- Az.Sql (= 2.0.0)
- Az.Storage (= 1.9.0)
- Az.StorageSync (= 1.2.1)
- Az.StreamAnalytics (= 1.0.0)
- Az.TrafficManager (= 1.0.2)
- Az.Websites (= 1.5.0)
Release Notes
3.0.0 - November 2019
Az.Accounts
* Add a deprecation message for 'Resolve-Error' alias.
Az.Advisor
* Added new category 'Operational Excellence' to Get-AzAdvisorRecommendation cmdlet.
Az.Cdn
* Introduced UrlRewriteAction and CacheKeyQueryStringAction to RulesEngine.
* Fixed several bugs like missing 'Selector' Input in New-AzDeliveryRuleCondition cmdlet.
Az.Batch
* Renamed `CoreQuota` on `BatchAccountContext` to `DedicatedCoreQuota`. There is also a new `LowPriorityCoreQuota`.
- This impacts **Get-AzBatchAccount**.
* **New-AzBatchTask** `-ResourceFile` parameter now takes a collection of `PSResourceFile` objects, which can be constructed using the new **New-AzBatchResourceFile** cmdlet.
* New **New-AzBatchResourceFile** cmdlet to help create `PSResourceFile` objects. These can be supplied to **New-AzBatchTask** on the `-ResourceFile` parameter.
- This supports two new kinds of resource file in addition to the existing `HttpUrl` way:
- `AutoStorageContainerName` based resource files download an entire auto-storage container to the Batch node.
- `StorageContainerUrl` based resource files download the container specified in the URL to the Batch node.
* Removed `ApplicationPackages` property of `PSApplication` returned by **Get-AzBatchApplication**.
- The specific packages inside of an application now can be retrieved using **Get-AzBatchApplicationPackage**. For example: `Get-AzBatchApplication -AccountName myaccount -ResourceGroupName myresourcegroup -ApplicationId myapplication`.
* Renamed `ApplicationId` to `ApplicationName` on **Get-AzBatchApplicationPackage**, **New-AzBatchApplicationPackage**, **Remove-AzBatchApplicationPackage**, **Get-AzBatchApplication**, **New-AzBatchApplication**, **Remove-AzBatchApplication**, and **Set-AzBatchApplication**.
- `ApplicationId` now is an alias of `ApplicationName`.
* Added new `PSWindowsUserConfiguration` property to `PSUserAccount`.
* Renamed `Version` to `Name` on `PSApplicationPackage`.
* Renamed `BlobSource` to `HttpUrl` on `PSResourceFile`.
* Removed `OSDisk` property from `PSVirtualMachineConfiguration`.
* Removed **Set-AzBatchPoolOSVersion**. This operation is no longer supported.
* Removed `TargetOSVersion` from `PSCloudServiceConfiguration`.
* Renamed `CurrentOSVersion` to `OSVersion` on `PSCloudServiceConfiguration`.
* Removed `DataEgressGiB` and `DataIngressGiB` from `PSPoolUsageMetrics`.
* Removed **Get-AzBatchNodeAgentSku** and replaced it with **Get-AzBatchSupportedImage**.
- **Get-AzBatchSupportedImage** returns the same data as **Get-AzBatchNodeAgentSku** but in a more friendly format.
- New non-verified images are also now returned. Additional information about `Capabilities` and `BatchSupportEndOfLife` for each image is also included.
Az.Compute
* Disk Encryption Set feature
- New cmdlets:
New-AzDiskEncryptionSetConfig
New-AzDiskEncryptionSet
Get-AzDiskEncryptionSet
Remove-AzDiskEncryptionSet
- DiskEncryptionSetId parameter is added to the following cmdlets:
Set-AzImageOSDisk
Set-AzVMOSDisk
Set-AzVmssStorageProfile
Add-AzImageDataDisk
New-AzVMDataDisk
Set-AzVMDataDisk
Add-AzVMDataDisk
Add-AzVmssDataDisk
Add-AzVmssVMDataDisk
- DiskEncryptionSetId and EncryptionType parameters are added to the following cmdlets:
New-AzDiskConfig
New-AzSnapshotConfig
* Add PublicIPAddressVersion parameter to New-AzVmssIPConfig
* Add ScaleInPolicy to New-AzVmss, New-AzVmssConfig and Update-AzVmss cmdlets
* Breaking changes
- UploadSizeInBytes parameter is used instead of DiskSizeGB for New-AzDiskConfig when CreateOption is Upload
- PublishingProfile.Source.ManagedImage.Id is replaced with StorageProfile.Source.Id in GalleryImageVersion object
Az.DataFactory
* Update ADF .Net SDK version to 4.3.0
Az.DataLakeStore
* Update ADLS SDK version (https://github.com/Azure/azure-data-lake-store-net/blob/preview-alpha/CHANGELOG.md#version-123-alpha), brings following fixes
* Avoid throwing exception while unable to deserialize the creationtime of the trash or directory entry.
* Expose setting per request timeout in adlsclient
* Fix EnumerateDirectory to retrieve continuation token once response is checked
Az.FrontDoor
* Fixed miscellaneous typos across module
Az.HDInsight
* Fixed the bug that customer will get 'Not a valid Base-64 string' error when using Get-AzHDInsightCluster to get the cluster with ADLSGen1 storage.
* Add a parameter named 'ApplicationId' to three cmdlets Add-AzHDInsightClusterIdentity, New-AzHDInsightClusterConfig and New-AzHDInsightCluster so that customer can provide the service principal application id for accessing Azure Data Lake.
* Changed Microsoft.Azure.Management.HDInsight from 2.1.0 to 5.1.0
* Removed five cmdlets:
- Get-AzHDInsightOMS
- Enable-AzHDInsightOMS
- Disable-AzHDInsightOMS
- Grant-AzHDInsightRdpServicesAccess
- Revoke-AzHDInsightRdpServicesAccess
* Added three cmdlets:
- Get-AzHDInsightMonitoring to replace Get-AzHDInsightOMS.
- Enable-AzHDInsightMonitoring to replace Enable-AzHDInsightOMS.
- Disable-AzHDInsightMonitoring to replace Disable-AzHDInsightOMS.
* Removed parameter sets('Spark1', 'Spark2') from Add-AzHDInsightConfigValue.
* Changed output type of the following cmdlets:
* - Changed the output type of Get-AzHDInsightProperties from CapabilitiesResponse to AzureHDInsightCapabilities.
* - Changed the output type of Remove-AzHDInsightCluster from ClusterGetResponse to bool.
* - Changed the output type of Set-AzHDInsightGatewaySettings HttpConnectivitySettings to GatewaySettings.
* Remove some alias: 'Add-AzHDInsightConfigValues', 'Get-AzHDInsightProperties'.
Az.Network
* Change all cmdlets for PrivateEndpointConnection to support generic service provider.
- Updated cmdlet:
- Approve-AzPrivateEndpointConnection
- Deny-AzPrivateEndpointConnection
- Get-AzPrivateEndpointConnection
- Remove-AzPrivateEndpointConnection
- Set-AzPrivateEndpointConnection
* Add new cmdlet for PrivateLinkResource and it also support generic service provider.
- New cmdlet:
- Get-AzPrivateLinkResource
* Add new fields and parameter for the feature Proxy Protocol V2.
- Add property EnableProxyProtocol in PrivateLinkService
- Add property LinkIdentifier in PrivateEndpointConnection
- Updated New-AzPrivateLinkService to add a new optional parameter EnableProxyProtocol.
* New cmdlets to support the azure firewall policy
* Add support for child resource RouteTables of VirtualHub
- New cmdlets added:
- Add-AzVirtualHubRoute
- Add-AzVirtualHubRouteTable
- Get-AzVirtualHubRouteTable
- Remove-AzVirtualHubRouteTable
- Set-AzVirtualHub
* Add support for new properties Sku of VirtualHub and VirtualWANType of VirtualWan
- Cmdlets updated with optional parameters:
- New-AzVirtualHub : added parameter Sku
- Update-AzVirtualHub : added parameter Sku
- New-AzVirtualWan : added parameter VirtualWANType
- Update-AzVirtualWan : added parameter VirtualWANType
* Add support for Configuring TopLevel WebApplicationFirewall Policy
- New cmdlets added:
- New-AzApplicationGatewayFirewallPolicy*
- Cmdlets updated with optional parameters:
- New-AzApplicationGatewayFirewallPolicy : added parameter PolicySetting, ManagedRule
* Added support for Geo-Match operator on CustomRule
- Added GeoMatch to the operator on the FirewallCondition
* Added support for perListener and perSite Firewall policy
- Cmdlets updated with optional parameters:
- New-AzApplicationGatewayHttpListener : added parameter FirewallPolicy, FirewallPolicyId
- New-AzApplicationGatewayPathRuleConfig : added parameter FirewallPolicy, FirewallPolicyId
Firewall
* Add support for top level resource RouteTables of IpGroup
- New cmdlets added:
- New-AzIpGroup
- Remove-AzIpGroup
- Get-AzIpGroup
- Set-AzIpGroup
Az.RecoveryServices
* Configure networking resources like NSG, public IP and internal load balancers for Azure to Azure.
* Write to managed disk for vMWare to Azure.
* NIC reduction for vMWare to Azure.
* Accelerated networking for Azure to Azure.
* Agent auto update for Azure to Azure.
* Standard SSD for Azure to Azure.
* Azure Disk Encryption two pass for Azure to Azure.
* Protect newly added disk for Azure to Azure.
* Added SoftDelete feature for VM and added tests for softdelete
Az.Resources
* Update dependency assemlby Microsoft.Extensions.Caching.Memory from 1.1.1 to 2.2
Az.ServiceFabric
* Remove Add-AzServiceFabricApplicationCertificate cmdlet as this scenario is covered by Add-AzVmssSecret.
Az.Sql
* Added support for restore of dropped databases on Managed Instances.
* Deprecated from code old auditing cmdlets.
* Removed deprecated aliases:
* Get-AzSqlDatabaseIndexRecommendations (use Get-AzSqlDatabaseIndexRecommendation instead)
* Get-AzSqlDatabaseRestorePoints (use Get-AzSqlDatabaseRestorePoint instead)
* Remove Get-AzSqlDatabaseSecureConnectionPolicy cmdlet
* Remove aliases for deprecated Vulnerability Assessment Settings cmdlets
* Deprecate Advanced Threat Detection Settings cmdlets
* Adding cmdlets to Disable and enable sensitivity recommendations on columns in a database.
Az.Storage
* Support enable Large File share when create or update Storage account
- New-AzStorageAccount
- Set-AzStorageAccount
* When close/get File handle, skip check the input path is File directory or File, to avoid failure with object in DeletePending status
- Get-AzStorageFileHandle
- Close-AzStorageFileHandle
FileList
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 16.4.0 | 991,876 | 10/6/2026 |
| 16.3.0 | 3,889,883 | 8/31/2026 |
| 16.2.0 | 2,891,449 | 8/4/2026 |
| 16.1.0 | 3,744,225 | 7/7/2026 |
| 16.0.0 | 7,568,267 | 6/2/2026 |
| 15.6.1 | 4,977,924 | 5/6/2026 |
| 15.6.0 | 300,393 | 5/5/2026 |
| 15.5.0 | 5,387,620 | 4/7/2026 |
| 15.4.0 | 6,643,778 | 3/3/2026 |
| 15.3.0 | 5,408,899 | 2/3/2026 |
| 15.2.0 | 4,154,095 | 1/13/2026 |
| 15.1.0 | 7,641,496 | 12/2/2025 |
| 15.0.0 | 2,766,203 | 11/18/2025 |
| 14.6.0 | 2,887,234 | 11/4/2025 |
| 14.5.0 | 3,946,751 | 10/14/2025 |
| 14.4.0 | 8,042,728 | 9/2/2025 |
| 14.3.0 | 5,066,704 | 8/5/2025 |
| 14.2.0 | 6,189,159 | 7/1/2025 |
| 14.1.0 | 4,380,424 | 6/3/2025 |
| 14.0.0 | 2,338,072 | 5/19/2025 |
| 13.5.0 | 2,363,030 | 5/6/2025 |
| 13.4.0 | 4,704,558 | 4/1/2025 |
| 13.3.0 | 3,404,630 | 3/4/2025 |
| 13.2.0 | 2,562,170 | 2/11/2025 |
| 13.1.0 | 4,236,328 | 1/14/2025 |
| 13.0.0 | 5,553,177 | 11/19/2024 |
| 12.5.0 | 1,392,104 | 11/11/2024 |
| 12.4.0 | 3,469,799 | 10/8/2024 |
| 12.3.0 | 2,542,108 | 9/3/2024 |
| 12.2.0 | 2,044,478 | 8/6/2024 |
| 12.1.0 | 3,359,524 | 7/9/2024 |
| 12.0.0 | 4,720,229 | 5/21/2024 |
| 11.6.0 | 2,029,050 | 4/30/2024 |
| 11.5.0 | 1,778,699 | 4/2/2024 |
| 11.4.0 | 2,019,331 | 3/5/2024 |
| 11.3.1 | 1,561,300 | 2/9/2024 |
| 11.3.0 | 459,633 | 2/6/2024 |
| 11.2.0 | 1,494,989 | 1/9/2024 |
| 11.1.0 | 1,600,990 | 12/5/2023 |
| 11.0.0 | 1,235,192 | 11/14/2023 |
| 10.4.1 | 3,421,939 | 9/27/2023 |
| 10.4.0 | 72,754 | 9/26/2023 |
| 10.3.0 | 5,606,172 | 9/5/2023 |
| 10.2.0 | 1,284,512 | 8/1/2023 |
| 10.1.0 | 1,088,262 | 7/4/2023 |
| 10.0.0 | 1,514,268 | 5/23/2023 |
| 9.7.1 | 2,612,533 | 4/28/2023 |
| 9.7.0 | 143,185 | 4/25/2023 |
| 9.6.0 | 815,634 | 4/4/2023 |
| 9.5.0 | 1,148,296 | 3/9/2023 |
| 9.4.0 | 2,422,110 | 2/7/2023 |
| 9.3.0 | 1,274,523 | 1/10/2023 |
| 9.2.0 | 1,146,970 | 12/6/2022 |
| 9.1.1 | 694,017 | 11/17/2022 |
| 9.1.0 | 559,182 | 11/1/2022 |
| 9.0.1 | 1,565,670 | 10/17/2022 |
| 8.3.0 | 2,019,638 | 9/6/2022 |
| 8.2.0 | 933,281 | 8/2/2022 |
| 8.1.0 | 694,750 | 7/5/2022 |
| 8.0.0 | 4,018,339 | 5/24/2022 |
| 7.5.0 | 4,428,030 | 4/26/2022 |
| 7.4.0 | 390,703 | 4/5/2022 |
| 7.3.2 | 469,087 | 3/12/2022 |
| 7.3.0 | 274,441 | 3/1/2022 |
| 7.2.1 | 190,404 | 2/18/2022 |
| 7.2.0 | 296,422 | 2/7/2022 |
| 7.1.0 | 695,527 | 1/4/2022 |
| 7.0.0 | 540,898 | 12/7/2021 |
| 6.6.0 | 2,451,961 | 11/2/2021 |
| 6.5.0 | 523,116 | 10/12/2021 |
| 6.4.0 | 763,518 | 9/7/2021 |
| 6.3.0 | 666,571 | 8/3/2021 |
| 6.2.1 | 566,736 | 7/9/2021 |
| 6.2.0 | 70,489 | 7/6/2021 |
| 6.1.0 | 404,569 | 6/15/2021 |
| 6.0.0 | 410,856 | 5/25/2021 |
| 5.9.0 | 3,758,549 | 5/4/2021 |
| 5.8.0 | 441,304 | 4/13/2021 |
| 5.7.0 | 672,526 | 3/23/2021 |
| 5.6.0 | 539,334 | 3/2/2021 |
| 5.5.0 | 887,880 | 2/9/2021 |
| 5.4.0 | 1,648,059 | 1/19/2021 |
| 5.3.0 | 1,475,523 | 12/29/2020 |
| 5.2.0 | 1,395,807 | 12/8/2020 |
| 5.1.0 | 1,716,054 | 11/17/2020 |
| 5.0.0 | 1,714,170 | 10/27/2020 |
| 4.8.0 | 4,891,015 | 10/13/2020 |
| 4.7.0 | 268,333 | 9/22/2020 |
| 4.6.1 | 1,823,981 | 8/28/2020 |
| 4.6.0 | 121,402 | 8/25/2020 |
| 4.5.0 | 433,819 | 8/4/2020 |
| 4.4.0 | 368,051 | 7/14/2020 |
| 4.3.0 | 410,241 | 6/23/2020 |
| 4.2.0 | 402,818 | 6/2/2020 |
| 4.1.0 | 339,840 | 5/19/2020 |
| 4.0.2-preview | 2,423 | 12/23/2019 |
| 4.0.1-preview | 1,061 | 10/9/2019 |
| 3.8.0 | 2,129,272 | 4/21/2020 |
| 3.7.0 | 299,662 | 3/31/2020 |
| 3.6.1 | 372,791 | 3/10/2020 |
| 3.5.0 | 373,247 | 2/18/2020 |
| 3.4.0 | 204,756 | 2/4/2020 |
| 3.3.0 | 382,131 | 1/7/2020 |
| 3.2.0 | 326,426 | 12/17/2019 |
| 3.1.0 | 614,461 | 11/26/2019 |
| 3.0.0 (current version) | 466,073 | 11/4/2019 |
| 2.8.0 | 1,175,201 | 10/15/2019 |
| 2.7.0 | 184,649 | 9/24/2019 |
| 2.6.0 | 322,227 | 8/27/2019 |
| 2.5.0 | 435,986 | 7/30/2019 |
| 2.4.0 | 176,181 | 7/2/2019 |
| 2.3.2 | 178,717 | 6/18/2019 |
| 2.2.0 | 78,611 | 6/4/2019 |
| 2.1.0 | 70,184 | 5/21/2019 |
| 2.0.1 | 12,096 | 12/15/2021 |
| 2.0.0 | 116,132 | 5/6/2019 |
| 1.8.0 | 369,086 | 4/23/2019 |
| 1.7.0 | 55,617 | 4/9/2019 |
| 1.6.0 | 83,211 | 3/26/2019 |
| 1.5.0 | 55,974 | 3/12/2019 |
| 1.4.0 | 43,803 | 2/26/2019 |
| 1.3.0 | 33,059 | 2/12/2019 |
| 1.2.1 | 25,199 | 1/31/2019 |
| 1.2.0 | 4,848 | 1/29/2019 |
| 1.1.0 | 20,126 | 1/15/2019 |
| 1.0.1 | 33,930 | 12/18/2018 |
| 1.0.0 | 29,215 | 12/18/2018 |
| 0.10.0-preview | 14,795 | 4/15/2020 |
| 0.7.0 | 14,765 | 12/4/2018 |
| 0.6.1 | 9,462 | 11/21/2018 |
| 0.5.0 | 9,940 | 11/6/2018 |
| 0.4.0 | 11,307 | 10/23/2018 |
| 0.3.0 | 11,071 | 10/9/2018 |
| 0.2.2 | 5,279 | 9/24/2018 |
| 0.1.0 | 755 | 8/28/2018 |