Powershell Azure Azps 10.1.0
Powershell Azure Azps 10.1.0
e OVERVIEW
Get started
Support Lifecycle
d TRAINING
Choose the best Azure command line tools for managing and provisioning your cloud
infrastructure
Installation
a DOWNLOAD
Install
Install - Windows
Install - Linux
Install - macOS
What's new
h WHAT'S NEW
R l t
Release notes
i REFERENCE
Cmdlet reference
h WHAT'S NEW
c HOW-TO GUIDE
Authentication methods
Credential Contexts
Concepts
c HOW-TO GUIDE
Manage subscriptions
Format output
PowerShell jobs
g TUTORIAL
c HOW-TO GUIDE
Deploy
` DEPLOY
Samples
s SAMPLE
SQL databases
Cosmos DB
Samples repo
e OVERVIEW
c HOW-TO GUIDE
Migration steps
f QUICKSTART
e OVERVIEW
Troubleshoot
Azure PowerShell is a set of cmdlets for managing Azure resources directly from
PowerShell. Azure
PowerShell is designed to make it easy to learn and get started with,
but provides powerful features
for automation.
) Important
The Az PowerShell module is based on the .NET Standard, and works with PowerShell
7.0.6 LTS and
PowerShell 7.1.3 or higher on all platforms including Windows, Linux, and
macOS. It's also
compatible with Windows PowerShell 5.1.
7 Note
PowerShell 7.0.6 LTS and PowerShell 7.1.3 or higher is the recommended version of
PowerShell for
use with the Az PowerShell module on all platforms.
You can install the Az PowerShell module locally on Windows, Linux, and macOS. It can
also be used
from a browser through Azure Cloud Shell or
inside a Docker container. For
more information, see the
Azure PowerShell documentation.
Authentication
Azure PowerShell supports several authentication methods. For detailed information
about
authenticating to Azure from the Az PowerShell module, see
Sign in with Azure
PowerShell.
Module Design
The Az PowerShell module is a wrapper module for Azure service related PowerShell
modules, usually
one module per Azure service such as Az.Network for Azure
networking services and Az.AKS for
Azure Kubernetes Service.
The cmdlets in the Az PowerShell module make REST calls to the Azure API. Breaking
changes in the Az
PowerShell module are limited to twice a year. Many breaking
changes at the API level are handled
within the cmdlets to prevent the perception of a
breaking change.
The Az PowerShell module contains cmdlets for performing both control plane and data
plane
operations in Azure. You use the control plane to manage resources in your
subscription. You use the
data plane to use capabilities exposed by your instance of a
resource type. For more information,
see
Azure control plane and data plane.
Output Objects
The cmdlets in the Az PowerShell module produce .NET objects. As with any PowerShell
command that
produces output, the cmdlets in the Az PowerShell module can be piped
to the
Get-Member cmdlet to determine what
type of object is produced along with a
list of the available properties and methods. For more
information, see Query output of
Azure PowerShell and
Format Azure PowerShell cmdlet output.
Other modules
The AzureAD and MSOnline PowerShell modules aren't part of the Az PowerShell
module. For more
information about those modules, see the documentation for
Azure
Active Directory PowerShell for Graph.
U Caution
) Important
The cmdlets in the Azure PowerShell module are for managing legacy Azure
resources that use
Service Management APIs.
Some cmdlets in the Azure PowerShell module have been deprecated and others have
been deprecated for
new customers with retirement announced for existing customers
as noted on their corresponding
reference documentation pages. For more information,
see
Overview of the Azure PowerShell Service Management module
Introducing the Azure Az PowerShell
module
Article • 07/04/2023
Overview
The Az PowerShell module is a set of cmdlets for managing Azure resources directly
from PowerShell.
PowerShell provides powerful features for automation that can be
leveraged for managing your Azure
resources, for example in the context of a CI/CD
pipeline.
U Caution
You can use the Az PowerShell module with one of the following methods:
Features
The Az PowerShell module features the following benefits:
7 Note
The Az PowerShell module is based on the .NET Standard library and works with
PowerShell 7 and later
on all platforms including Windows, Linux, and macOS. It's also
compatible with Windows PowerShell
5.1.
We're committed to bringing Azure support to all platforms and all Az PowerShell
modules are
cross-platforms.
Keep the AzureRM module installed in Windows PowerShell 5.1 and install the Az
module in
PowerShell 7 or later. Windows PowerShell 5.1 and PowerShell 7 and
later use separate
collections of modules. Follow the instructions to install the
latest version of PowerShell and then
install the Az module from PowerShell 7 or
later.
Supportability
Az is the most current PowerShell module for Azure. Issues or feature requests can be
logged
directly on the GitHub repository , or via Microsoft
support if you have a
support contract. Feature requests are implemented in the latest version of
Az. Critical
issues are implemented on the last two versions of Az.
Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell
modules and more,
we'll retire AzureRM PowerShell modules on February 29, 2024.
Data collection
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 doesn't collect any private or personal
data. For example, the usage
data helps identify issues such as cmdlets with low success
and helps prioritize our work.
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 cmdlet. You
can also read our privacy statement to learn more.
Get started with Azure PowerShell
Article • 07/04/2023
Azure PowerShell is designed for managing and administering Azure resources from the
command line.
Use Azure PowerShell when you want to build automated tools that use
the Azure Resource Manager
model. Try it out in your browser with Azure Cloud Shell, or
install
on your local machine.
This article helps you get started with Azure PowerShell and teaches the core concepts
behind it.
When you're ready to install Azure PowerShell on your local machine, follow the
instructions in
Install the Azure PowerShell module.
Sign in to Azure
Sign in interactively with the
Connect-AzAccount cmdlet. Skip this step if you
use Cloud
Shell. Your Azure Cloud Shell session is already authenticated for the environment,
subscription, and tenant that launched the Cloud Shell session.
Azure PowerShell
Connect-AzAccount
Azure cloud services offer environments compliant with regional data-handling laws. For
accounts in
a regional cloud, use the Environment parameter to sign in. Get the name of
the environment for
your region using the Get-AzEnvironment cmdlet.
For example, to
sign in to Azure China 21Vianet:
Azure PowerShell
After signing in, you'll see information indicating which of your Azure subscriptions is
active. If
you have multiple Azure subscriptions in your account and want to select a
different one, get your
available subscriptions with
Get-AzSubscription and use the
Set-
AzContext cmdlet with your subscription ID. For
more information about managing your
Azure subscriptions in Azure PowerShell, see
Use multiple Azure subscriptions.
Once signed in, use the Azure PowerShell cmdlets to access and manage resources in
your
subscription. To learn more about the sign-in process and authentication methods,
see
Sign in with Azure PowerShell.
Find commands
Azure PowerShell cmdlets follow a standard naming convention for PowerShell, Verb-
Noun . The verb
describes the action (examples include New , Get , Set , Remove ) and the
Knowing the nouns, verbs, and the Azure PowerShell modules available helps you find
commands with
the Get-Command cmdlet. For example, to
find all VM-related
commands that use the Get verb:
PowerShell
To help you find common commands, this table lists the resource type, corresponding
Azure PowerShell
module, and noun prefix to use with Get-Command :
Data Collection
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. For example, the usage
data helps identify issues such as cmdlets with
low success and helps prioritize our work.
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 cmdlet. You
can also read our privacy statement to learn more.
There are also Azure PowerShell quickstarts for other popular Azure services:
Versioning
The Az PowerShell modules follow Semantic Versioning for version numbering.
Versions of Azure service modules fall into one of three categories:
Generally available. Modules version 1.0.0 and higher without preview in the
version. Adheres to
breaking change policy.
Preview. Modules less than version 1.0.0. Don't adhere to breaking change policy.
Feature preview. Modules version 1.0.0 and higher with preview in the version.
Don't adhere to
breaking change policy.
The AzPreview module is always the same version and is released at the same time as
the Az module.
Release cadence
Planned updates to the Az PowerShell module are released on the first Tuesday of each
month. These
12 planned updates per calendar year are in two categories:
Major versions. At most, two per calendar year introduce breaking changes. The
first number in the
version number is updated. For example, version 6.6.0 to
version 7.0.0.
Minor versions. 10 per calendar year that don't introduce breaking changes. The
second number in
the version number is updated. For example, version 7.0.0 to
version 7.1.0.
2 Warning
Unplanned patch versions may be released at any time to fix bugs. Patch versions don't
introduce
breaking changes. The third number in the version number is updated. For
example, version 6.2.0 to
version 6.2.1.
Breaking changes
) Important
Breaking changes may occur at any point for non-GA preview and feature preview
modules. Non-GA
modules aren't required to adhere to breaking change policies.
For information about upcoming breaking change releases, see Azure PowerShell
milestones .
Provide feedback
For general feedback, use the Send-Feedback cmdlet.
For product issues, log an issue in the azure-powershell GitHub repository .
Other resources
Azure PowerShell modules .
Azure PowerShell Support Lifecycle
Azure PowerShell releases demystified
Azure PowerShell Support Lifecycle
Article • 07/04/2023
Az PowerShell modules
The "Az PowerShell modules" consist of the module named "Az" and the dependent
modules signed by
"Microsoft Corporation". The Az PowerShell modules are identifiable
by their names, that start
with "Az.". For the current list of Az PowerShell modules, see
Azure PowerShell Modules .
Supported environments
The following table identifies the supported platforms for the Az, AzureRM, and Azure
PowerShell
modules.
Az 10.x
Az 9.x
<= Az 8.x
AzureRM 6.13.2
Azure 5.3.1
7 Note
PowerShell 6.2 reached its end of life as of September 4, 2020. The Az PowerShell
modules are not
supported on any version of PowerShell 6.
Starting with Az 6.0.0, PowerShell 7.0.6 or 7.1.3 or later is required. When the
Az.Accounts module
is imported, the following non-blocking message is displayed if an
unsupported version of PowerShell
is being used: "This version of Az.Accounts is only
supported on Windows PowerShell 5.1 and
PowerShell 7.0.6 or greater, open
https://aka.ms/install-powershell to learn how to upgrade. For
further information, go to
https://aka.ms/azpslifecyle ."
U Caution
The Azure PowerShell Az module is a rollup module. Installing the Az PowerShell module
downloads the
generally available modules and makes their cmdlets available for use.
Install
The current version of Azure PowerShell is 10.1.0. For information about the latest
release, see the release notes.
Install on Windows
Install on Linux
Install on macOS
Run in Azure Cloud Shell
Run in Docker container
A supported version of
PowerShell version 7 or higher is
the recommended version of
PowerShell for use with the Az PowerShell module on all platforms
including Windows,
Linux, and macOS.
See also
What is Azure PowerShell
Get started with Azure PowerShell
Versioning, release cadence, and breaking changes
Support Lifecycle
Install Azure PowerShell on Windows
Article • 07/04/2023
The Azure PowerShell Az module is a rollup module. Installing the Az PowerShell module
downloads the
generally available modules and makes their cmdlets available for use.
The recommended installation method and PowerShell version for the Az PowerShell
module:
This article explains how to install the Az PowerShell module on Windows from the
PowerShell Gallery.
Prerequisites
Run the following command from PowerShell to determine your PowerShell
version:
PowerShell
$PSVersionTable.PSVersion
PowerShell
) Important
PowerShell 7
PowerShell
Get-ExecutionPolicy -List
PowerShell
Installation
Use the Install-Module cmdlet to install the Az
PowerShell module:
PowerShell
PowerShell
Updating the Az PowerShell module using Update-Module doesn't remove old versions
of the Az
PowerShell module from your system.
Uninstallation
To remove the Az PowerShell module, see
Uninstall the Azure PowerShell module.
Sign in
To start managing your Azure resources with the Az PowerShell module, launch a
PowerShell session
and run Connect-AzAccount to sign in to Azure:
Azure PowerShell
Connect-AzAccount
Use your Azure account login credentials to log into the browser window that opens.
You'll need to repeat this step for every new PowerShell session you start. To learn how
to persist
your Azure sign-in across PowerShell sessions, see
Azure PowerShell context
objects.
Troubleshooting
For solutions to common installation issues with the Az PowerShell module, see
Troubleshoot installation problems with the Azure Az PowerShell module.
Provide feedback
To file an issue about the Az PowerShell module, see:
file an issue on GitHub
Next Steps
To learn more about managing your Azure resources with the Az PowerShell module,
see
Get Started with Azure PowerShell.
Install Azure PowerShell on Linux
Article • 07/04/2023
Prerequisites
Install a supported version of PowerShell version 7 or higher
Installation
Open the Terminal or other shell host application and run pwsh to start PowerShell.
PowerShell
PowerShell
Updating the Az PowerShell module using Update-Module doesn't remove old versions
of the Az
PowerShell module from your system.
Uninstallation
To remove the Az PowerShell module from your system, see
Uninstall the Azure
PowerShell module.
Sign in
To start managing your Azure resources with the Az PowerShell module, launch a
PowerShell session
and run Connect-AzAccount to sign in to Azure:
Azure PowerShell
Connect-AzAccount
Use your Azure account login credentials to log into the browser window that opens.
You'll need to repeat this step for every new PowerShell session you start. To learn how
to persist
your Azure sign-in across PowerShell sessions, see
Azure PowerShell context
objects.
Troubleshooting
For solutions to common installation issues with the Az PowerShell module, see
Troubleshoot installation problems with the Azure Az PowerShell module.
Provide feedback
To file an issue about the Az PowerShell module, see:
file an issue on GitHub .
Next Steps
To learn more about managing your Azure resources with the Az PowerShell module,
see
Get Started with Azure PowerShell.
Install Azure PowerShell on macOS
Article • 07/04/2023
This article explains how to install the Azure PowerShell Az module from
the PowerShell
Gallery on macOS.
Prerequisites
Install a supported version of
PowerShell version 7 or higher
Installation
Open the Terminal or other shell host application and run pwsh to start PowerShell.
PowerShell
PowerShell
Updating the Az PowerShell module using Update-Module doesn't remove old versions
of the Az
PowerShell module from your system.
Uninstallation
To remove the Az PowerShell module from your system, see
Uninstall the Azure
PowerShell module.
Sign in
To start managing your Azure resources with the Az PowerShell module, launch a
PowerShell session
and run Connect-AzAccount to sign in to Azure:
Azure PowerShell
Connect-AzAccount
Use your Azure account login credentials to log into the browser window that opens.
You'll need to repeat this step for every new PowerShell session you start. To learn how
to persist
your Azure sign-in across PowerShell sessions, see
Azure PowerShell context
objects.
Troubleshooting
For solutions to common installation issues with the Az PowerShell module, see
Troubleshoot installation problems with the Az PowerShell module.
Provide feedback
To file an issue about the Az PowerShell module, see:
file an issue on GitHub .
Next steps
To learn more about managing your Azure resources with the Az PowerShell module,
see
Get Started with Azure PowerShell.
Using Azure PowerShell in a Docker
container
Article • 07/04/2023
We publish Docker images with Azure PowerShell preinstalled. You can use Docker to
run a standalone
Linux container with Azure PowerShell preinstalled. This article shows
you how to use Azure
PowerShell in the Docker container.
The release containers derive from the official distribution image, install dependencies,
and
install the Azure PowerShell module.
The latest container image contains the latest version of PowerShell and the latest Azure
PowerShell
modules supported with the Az PowerShell module.
You can find a complete list of Azure PowerShell Docker images on our Docker image
page.
amd64
Console
Console
docker run -it mcr.microsoft.com/azure-powershell pwsh
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 .
amd64
Console
Next steps
To learn more about the Azure PowerShell modules and their features, see
Get Started
with Azure PowerShell.
How to uninstall Azure PowerShell
modules
Article • 07/04/2023
This article explains how to uninstall Azure PowerShell, or completely remove it from
your system.
If you've decided to completely uninstall Azure PowerShell and don't plan
to reinstall it, give us
some feedback through the Send-Feedback cmdlet. If
you
encountered a bug, file a GitHub issue .
Platform Instructions
Windows 7
Start > Control Panel > Programs > Uninstall a program
Windows 8
Once on this screen, you should see Azure PowerShell in the program listing. This is the
app to
uninstall. If you don't see this program listed, then you installed through
PowerShellGet and
should follow the instructions outlined in option 2.
) Important
Run PowerShell elevated as an admin if any version of the Az PowerShell module is
installed in the
all users $env:PSModulePath .
7 Note
Uninstallation can be complicated if you have more than one version of the Az
PowerShell module
installed. Because of this complexity, we only support
uninstalling all versions of the Az
PowerShell module that are installed.
First, you'll need a list of all the Az PowerShell module versions installed on your system.
PowerShell
You can use the following example to generate a list of all the Az PowerShell modules
that need to
be uninstalled in addition to the Az module.
PowerShell
($AzVersions |
ForEach-Object {
PowerShell
$AzModules |
ForEach-Object {
Platform Instructions
Windows 7
Start > Control Panel > Programs > Uninstall a program
Windows 8
Once on this screen, you should see Azure PowerShell or Microsoft Azure PowerShell -
Month
Year in the program listing. This is the app to uninstall. If you don't see this
program listed,
then you installed through PowerShellGet, and should follow the next
set of instructions.
To use Uninstall-AzureRM from the Az.Accounts module, you need to have the Az
PowerShell module
installed. Having both the AzureRM and the Az modules installed at
the same time isn't supported,
however the Az module can be used to immediately
uninstall the AzureRM module. You can install the
Az module and bypass the AzureRM
module warning with the following command if you don't have the Az
module installed
already:
PowerShell
Once the Az module is installed, the following command removes all AzureRM modules
from your machine. It
requires administrator privileges.
PowerShell
Uninstall-AzureRm
Az.Accounts 2.12.4
Az.Aks 5.5.1
Fixed the issue of handling 'nextLink' in 'Set-AzAksCluster'. [#21846]
Fixed the issue of parameter 'AcrNameToDetach' in 'Set-AzAksCluster' due to role
assignment name is a guid.
Added breaking change message for parameter 'DockerBridgeCidr' in 'New-
AzAksCluster'.
Supported the value 'AzureLinux' for parameter '-NodeOsSKU' in 'New-
AzAksCluster' and parameter '-OsSKU' in 'New-AzAksNodePool'.
Fixed the issue of '-DisableLocalAccount' for 'Set-AzAksCluster'. [#21835]
Az.Billing 2.0.3
Fixed page continuation for Consumption PriceSheet cmdlet
Az.Cdn 3.1.0
Az.CognitiveServices 1.14.0
Az.Compute 6.1.0
Az.CosmosDB 1.11.1
Az.Databricks 1.6.0
Az.Migrate 2.2.0
Fixed key vault SPN Id coming as null for some users
Added support for Windows Server OS upgrade while migrating the server to Azure
using Azure Migrate
Updated OsUpgradeVersion parameter for Azure Migrate
Az.MySql 1.1.1
Az.Network 6.1.0
Added new cmdlets to get Connection child resource of Network Virtual Appliance.
-'Get-AzNetworkVirtualApplianceConnection'
Updated cmdlets to return connections in Network Virtual Appliance
-'Network
Virtual Appliance'
Allowed not to provide 'Rules' in
'PSApplicationGatewayFirewallPolicyManagedRuleGroupOverride', which would
return an empty 'RuleID' to be passed to NRP.
Added optional parameter 'AdminState' to Express Route Virtual Network Gateway
Fixed bug that caused 'Remove-AzApplicationGatewayAutoscaleConfiguration' to
always fails
Added read-only property 'DefaultPredefinedSslPolicy' in PSApplicationGateway
Updated cmdlet to added optional parameter 'DomainNameLabelScope' to Public
Ip Address
'New-AzPublicIpAddress'
Fixed bug where HubRoutingPreference didn't show up when running 'Get-
AzRouteServer'
Updated 'New-AzVirtualNetworkGateway' to remove validation for
'ExtendedLocation' parameter
Az.RecoveryServices 6.5.0
Added CRR support for new regions malaysiasouth, chinanorth3, chinaeast3,
jioindiacentral, jioindiawest.
Regenerated CRR SDK. Fixed issues with SQL CRR.
Fixed bug with rp expiry time, making 30 days expiry time for adhoc backup as
default from client side.
Added example to fetch pruned recovery points after modify policy.
Fixed the documentation for suspend backups with immutability.
Az.RedisCache 1.8.0
Az.Resources 6.8.0
Az.Sql 4.8.0
Added 'TryPlannedBeforeForcedFailover' parameter to 'Switch-
AzSqlDatabaseFailoverGroup'
Added new cmdlets for managed database move and copy operations
'Copy-AzSqlInstanceDatabase'
'Move-AzSqlInstanceDatabase'
'Complete-AzSqlInstanceDatabaseCopy'
'Stop-AzSqlInstanceDatabaseCopy'
'Complete-AzSqlInstanceDatabaseMove'
'Stop-AzSqlInstanceDatabaseMove'
'Get-AzSqlInstanceDatabaseMoveOperation'
'Get-AzSqlInstanceDatabaseCopyOperation'
Az.Storage 5.8.0
Supported TierToCold and TierToHot in Storage account management policy
'Add-AzStorageAccountManagementPolicyAction'
Supported Blob Tier Cold
'Copy-AzStorageBlob'
'Set-AzStorageBlobContent'
'Start-AzStorageBlobCopy'
Migrated the following Azure Queue dataplane cmdlets from
'Microsoft.Azure.Storage.Queue' to 'Azure.Storage.Queue'
'New-AzStorageQueueSASToken'
Added warning messages for an upcoming breaking change when creating SAS
token
'New-AzStorageBlobSasToken'
'New-AzStorageContainerSasToken'
'New-AzStorageAccountSasToken'
'New-AzStorageContext'
'New-AzStorageFileSasToken'
'New-AzStorageShareSasToken'
'New-AzStorageQueueSasToken'
'New-AzStorageTableSasToken'
'New-AzDataLakeGen2SasToken'
Added a warning message for an upcoming breaking change when creating a
storage account
'New-AzStorageAccount'
Az.StorageMover 1.0.1
Fixed the issue of System.Management.Automation.Internal.Host.InternalHost
conflicting with system parameter
System.Management.Automation.Internal.Host.InternalHost
Az.Synapse 3.0.1
Az.TrafficManager 1.2.1
Added a new API 'CheckTrafficManagerNameAvailabilityV2'.
Az.Websites 3.0.1
Increased timeout for Publish-AzWebApp command
Fixed Set-AzWebApp issue with 'Set-AzWebApp' when piping in Get-AzWebApp
object [#21820]
Added support for the PremiumMV3 tier to 'New-AzAppServicePlan' [#21933]
Az.Accounts 2.12.3
Az.Aks 5.5.0
Fixed the issue of 'Enable-AzAksAddon' when there are no addons. [#21665]
Added parameter '-EnableAHUB' for 'New-AzAksCluster' and 'Set-AzAksCluster'
Added parameter '-WindowsProfileAdminUserPassword' for 'Set-AzAksCluster'
Az.Billing 2.0.2
Fixed skip token for Consumption PriceSheet cmdlet
Az.Cdn 3.0.0
Upgraded API version to 2022-11-01-preview
Added support to migrate from Azure Front Door (classic) to Azure Front Door
Standard and Premium.
Added support for AFDX upgrade from Standard tier to Premium tier.
Az.Compute 6.0.0
Added new switch parameter 'OSImageScheduledEventEnabled' and string
parameter 'OSImageScheduledEventNotBeforeTimeoutInMinutes' to the cmdlets
'New-AzVmssConfig' and 'Update-AzVmss'.
Fixed an issue that 'Add-AzVhd' throws 'FileNotFoundException' on Windows
PowerShell. [#21321]
Removed the 'NextLink' parameter and parameter set from the 'Get-AzVM' cmdlet.
Az.ContainerRegistry 4.0.0
Updated module to autorest based
Az.CosmosDB 1.11.0
Added support for Continuous 7 Days backup mode.
Added new parameter 'EnablePartitionMerge' to 'Update-AzCosmosDBAccount' and
'New-AzCosmosDBAccount'.
Az.Databricks 1.5.1
Fixed an issue that 'Update-AzDatabricksWorkspace' doesn't work as expected while
enabling encryption. [#21324]
Az.DataProtection 2.0.0
Az.DesktopVirtualization 4.0.0
Upgraded API version to 2022-09-09
Added cmdlet:
'Get-AzWvdScalingPlanPooledSchedule'
'New-AzWvdScalingPlanPooledSchedule'
'Remove-AzWvdScalingPlanPooledSchedule'
'Update-AzWvdScalingPlanPooledSchedule'
Added parameters 'pageSize', 'isDescending' and 'initialSkip' to:
'Get-AzWvdApplication'
'Get-AzWvdApplicationGroup'
'Get-AzWvdDesktop'
'Get-AzWvdHostPool'
'Get-AzWvdMsixPackage'
'Get-AzWvdScalingPlan'
'Get-AzWvdSessionHost'
'Get-AzWvdStartMenuItem'
'Get-AzWvdUserSession'
'Get-AzWvdWorkspace'
Added parameters 'AgentUpdateMaintenanceWindow',
'AgentUpdateMaintenanceWindowTimeZone', 'AgentUpdateType',
'AgentUpdateUseSessionHostLocalTime' to:
'New-AzWvdHostPool'
'Update-AzWvdHostPool'
Added parameter 'FriendlyName' to:
'New-AzWvdHostPool'
'Update-AzWvdHostPool'
'Update-AzWvdSessionHost'
Az.EventHub 4.0.0
Az.Functions 4.0.7
Az.HDInsight 6.0.0
Breaking Change:
Removed the parameter '-RdpAccessExpiry' which has been marked as
deprecated for a long time from cmdlet 'New-AzHDInsightCluster'
Removed the parameter '-RdpCredential' which has been marked as deprecated
for a long time from cmdlet 'New-AzHDInsightCluster'
Az.KeyVault 4.10.0
Added breaking change announcement for parameter 'SoftDeleteRetentionInDays'
in 'New-AzKeyVaultManagedHsm'. The parameter 'SoftDeleteRetentionInDays' is
becoming mandatory
This change will take effect on version 6.0.0
Changed the encoding way from a string into byte array in 'Invoke-
AzKeyVaultKeyOperation' from ASCII to UTF8. UTF8 is backward-compatible with
ASCII. [#21269]
Bug fix: Changed the decoding way from byte array into a string from system
default encoding to UTF8 to match encoding way. [#21269]
Added parameter 'PolicyPath' and 'PolicyObject' in 'Import-AzKeyVaultCertificate' to
support custom policy [#20780]
Az.MachineLearningServices 1.0.0
General availability for module Az.MachineLearningServices
Az.Migrate 2.2.0
Added support for Windows Server OS upgrade while migrating the server to Azure
using Azure Migrate
Added fix for keyvault SPN Id coming as null for some users
Az.Monitor 4.5.0
Added cmdlets for monitor workspace:
'Get-AzMonitorWorkspace'
'New-AzMonitorWorkspace'
'Update-AzMonitorWorkspace'
'Remove-AzMonitorWorkspace'
Az.Network 6.0.0
Az.RedisEnterpriseCache 1.2.0
Upgraded API version to 2023-03-01-preview
Az.Relay 2.0.0
Updated API version to 2021-11-01
Az.Resources 6.7.0
Added parameter '-CountVariable' for list operations, 'odataCount' can now be
assigned to this variable [#20982]
'Get-AzADApplication'
'Get-AzADServicePrincipal'
'Get-AzADUser'
'Get-AzADGroup'
Supported polymorphism for 'Get-AzADGroupMember', output of this cmdlet was
now 'Application' 'ServicePrincipal', 'User' and 'Group' based on the 'odataType'
[#19728]
Added '-Force' parameter on 'Publish-AzBicepModule' for supporting overwriting
existing modules.
Fixed 'New-AzADApplication' when multiple redirect url types were provided.
[#21108]
Fixed 'Update-AzADServicePrincipal' when empty array passed for 'IdentifierUri'
[#21345]
Fixed an issue where location header was missing in the response from the service
for 'New-AzManagedApplication'.
Fixed 'Get-AzResourceGroup' ignored the subscription ID in '-Id' [#21725]
Az.ServiceBus 3.0.0
Aliased 'New-AzServiceBusNamespace', 'Remove-AzServiceBusNamespace', 'Set-
AzServiceBusNamespace', 'Get-AzServiceBusNamespace' with 'New-
AzServiceBusNamespaceV2', 'Remove-AzServiceBusNamespaceV2', 'Set-
AzServiceBusNamespaceV2', 'Get-AzServiceBusNamespaceV2' respectively.
Replaced 'New-AzServiceBusEncryptionConfig' by 'New-
AzServiceBusKeyVaultPropertiesObject'
Az.ServiceFabric 3.2.0
Added new cmdlet 'Add-AzServiceFabricManagedClusterNetworkSecurityRule' to
update network security rules in managed cluster resource
Az.SignalR 2.0.0
Breaking change:
Removed 'HostNamePrefix' property of output type 'PSSignalRResource' of
following cmdlets:
'Get-AzSignalR'
'New-AzSignalR'
'Update-AzSignalR'
Az.Sql 4.7.0
Az.SqlVirtualMachine 2.0.0
Az.StackHCI 2.0.0
Az.Storage 5.7.0
Az.StorageSync 2.0.0
Deprecated 'RegisteredServer' alias for InputObject parameter for Set-
AzStorageSyncServerEndpoint
Az.Synapse 3.0.0
Removed the unnecessary breaking change of parameter '-SparkConfigFilePath' for
'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' cmdlets
Az.Websites 3.0.0
Az.Accounts 2.12.2
Fixed 'AzureSynapseAnalyticsEndpointResourceId' of 'USGovernment' environment.
Updated Azure.Core to 1.31.0.
Updated the reference of Azure PowerShell Common to 1.3.75-preview.
Az.Aks 5.4.0
Added cmdlet 'New-AzAksMaintenanceConfiguration', 'Get-
AzAksMaintenanceConfiguration', 'Remove-AzAksMaintenanceConfiguration', 'New-
AzAksSnapshot', 'Get-AzAksSnapshot', 'Remove-AzAksSnapshot', 'Get-
AzAksManagedClusterCommandResult', 'Get-AzAksManagedClusterOSOption',
'Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint', 'Invoke-
AzAksAbortAgentPoolLatestOperation', 'Invoke-
AzAksAbortManagedClusterLatestOperation', 'Invoke-
AzAksRotateManagedClusterServiceAccountSigningKey', 'Start-
AzAksManagedClusterCommand', 'New-AzAksTimeInWeekObject', 'New-
AzAksTimeSpanObject'.
Added parameter '-OutboundType' for 'New-AzAksCluster'
Added parameter '-EnableOidcIssuer' for 'New-AzAksCluster' and 'Set-AzAksCluster'
Added parameter '-NodePodSubnetID' for 'New-AzAksCluster', '-PodSubnetID' for
'New-AzAksNodePool'
Az.Compute 5.7.1
Added a breaking change warning to the 'Get-AzVM' cmdlet to show that the
'NextLink' parameter and parameter set will be removed in June 2023. The
parameter has been non-functional for a long time.
Updated the breaking change warning in 'New-AzVM' and 'New-AzVmss' regarding
using the new versioned image aliases to indicate that certain aliases will be
removed next breaking change release.
Updated the 'Get-AzVMRunCommand' to include the 'ProvisioningState' value. Fix
[#21473]
Updated Azure.Core to 1.31.0.
Az.ContainerRegistry 3.0.4
Az.CosmosDB 1.10.1
Az.KeyVault 4.9.3
Az.LoadTesting 1.0.0
Az.Network 5.7.0
Az.PolicyInsights 1.6.1
Az.PowerBIEmbedded 1.2.1
Az.RecoveryServices 6.4.0
Az.Resources 6.6.1
Added support for Azure resources deployment with parameters file using Bicep
parameters syntax
Az.Sql 4.6.0
Az.Storage 5.6.0
Supported rename file and directory
'Rename-AzStorageFile'
'Rename-AzStorageDirectory'
Added a warning message for an upcoming breaking change when getting a single
blob
'Get-AzStorageBlob'
Fixed the issue of listing blobs with leading slashes
'Get-AzStorageBlob'
Added support for sticky bit
'New-AzDataLakeGen2Item'
'New-AzDataLakeGen2ACLObject'
'Update-AzDataLakeGen2Item'
Added warning messages for an upcoming cmdlet breaking change
'New-AzStorageAccount'
'Set-AzStorageAccount'
Allowed to clear blob tags on a blob
'Set-AzStorageBlobTag'
Updated Azure.Core to 1.31.0
Az.Synapse 2.3.1
Updated Azure.Core to 1.31.0.
Az.Websites 2.15.0
Fixed Tag parameter issues with ASE for 'New-AzWebApp'
Az.Aks 5.3.2
Fixed the issue that system variable 'True' is undefined in 'Windows PowerShell'.
Decoupled AutoMapper dependency, replaced with AdapterHelper.
Az.Batch 3.4.0
Added new property 'Encryption' of type 'EncryptionProperties' to
'AccountCreateParameters'.
Configures how customer data is encrypted inside the Batch account.
Az.Billing 2.0.1
Az.CognitiveServices 1.13.1
Az.Compute 5.7.0
Az.ContainerRegistry 3.0.3
Added breaking change attributes for cmdlets
Az.CosmosDB 1.10.0
Introduced restorable apis support for Gremlin and Table, which includes:
Added the apis for RestorableGremlinDatabases, RestorableGremlinGraphs,
RestorableGremlinResources,RestorableTables, RestorableResources.
Added RetrieveContinuousBackupInfo apis for Gremlin and Table which help in
determining the restore point of time and the resources to restore.
Added GremlinDatabasesToRestore and TablesToRestore field to provision and
restore database account api.
Added StartTime and EndTime support for listing restorable containers event
feed.
Az.DataProtection 1.2.0
Az.EventGrid 1.6.0
Added fix for DeliveryAttributeMapping
Added validation for StorageQueueTtl
Az.EventHub 3.2.3
Az.Kusto 2.2.0
Az.Network 5.6.0
Az.Resources 6.6.0
Fixed an issue when running the 'New-AzManagementGroup' command where it
tried to cast an async operation as a Management Group. [#21000]
Fixed an issue when running 'Get-AzResourceGroup -Name 'some_name'', it ignores
'-Location' if specified[#21225]
Az.ServiceBus 2.2.1
Added upcoming breaking change notifications for Az.ServiceBus module.
Az.Sql 4.5.0
Added a new cmdlet to refresh external governance status
'Invoke-AzSqlServerExternalGovernanceStatusRefresh'
Az.SqlVirtualMachine 1.1.1
Az.Storage 5.5.0
Supported create storage account with DnsEndpointType
'New-AzStorageAccount'
Fixed file cmdlets potential context issue when the current context doesn't match
with the credential of input Azure File object
'Close-AzStorageFileHandle'
'Get-AzStorageFile'
'Get-AzStorageFileContent'
'Get-AzStorageFileHandle'
'New-AzStorageDirectory'
'New-AzStorageFileSASToken'
'Remove-AzStorageDirectory'
'Remove-AzStorageFile'
'Remove-AzStorageShare'
'Set-AzStorageFileContent'
'Set-AzStorageShareQuota'
'Start-AzStorageFileCopy'
Az.Websites 2.14.0
Fixed 'Edit-AzWebAppBackupConfiguration' to pass backup configuration enabled
or not
Added a new parameter '-SoftRestart' for 'Restart-AzWebApp' and 'Restart-
AzWebApp' to perform a soft restart
Updated 'Get-AzWebApp' and 'Get-AzWebAppSlot' to expose 'VirtualNetwork
Integration Info' [#10665]
Set default value for '-RepositoryUrl' of 'New-AzStaticWebApp' [#21202]
Az.Aks 5.3.1
Fixed the issue that Invoke-AzAksRunCommand will fail when the directory for
parameter CommandContextAttachment contains sub-directories. [#20734]
Az.Automanage 1.0.0
Az.Automation 1.9.1
Az.CloudService 1.2.0
Upgraded the api version to 2022-09-04.
Upgraded the api version of referenced network to 2022-07-01.
Az.CognitiveServices 1.13.0
Az.Compute 5.5.0
Az.ContainerInstance 3.2.0
Az.ContainerRegistry 3.0.2
Updated Azure.Core to 1.28.0.
Az.CosmosDB 1.9.1
Updated Azure.Core to 1.28.0.
Az.Databricks 1.5.0
Upgraded API version to 2023-02-01
Az.DataFactory 1.16.13
Updated ADF .Net SDK version to 9.2.0
Added AzureBlobFS sasUri and sasToken properties in ADF
Added AzureBlobStorage containerUri and authenticationType properties in ADF
Added support copyComputeScale And pipelineExternalComputeScale in
IntegrationRuntime
Az.EventHub 3.2.2
Az.FrontDoor 1.10.0
Fixed New-AzFrontDoorWafPolicy cmdlet to support adding Tags for the Azure
Frontdoor waf policy
Az.IotHub 2.7.5
Updated IoT Hub Management SDK to version 4.2.0 (api-version 2021-07-02)
Fixed 'Get-AzIoTHub' to work with DigiCert hubs
Az.KeyVault 4.9.2
Az.ManagedServiceIdentity 1.1.1
Az.Network 5.5.0
Updated cmdlets to add new property of 'Snat' in Azure Firewall Policy.
'New-AzFirewallPolicySnat'
'New-AzFirewallPolicy'
'Set-AzFirewallPolicy'
Fixed a bug that reverts classic fw private ranges to default when doing get & set
Onboarded 'Microsoft.Monitor/accounts' to private link cmdlets
Az.PolicyInsights 1.6.0
Added support for policy attestations.
Az.RecoveryServices 6.3.0
Supported using managed disks for replication for HyperV to Azure provider in
Azure Site Recovery
Az.Relay 1.0.4
Added breaking change message for cmdlets.
'Set-AzRelayNamespace'
'Get-AzRelayOperation'
Az.Resources 6.5.3
Updated behavior of Get-AzPolicyDefinition which previously returned all definitions
when -Id was provided with a nonexistent policy definition id. Fixed to correctly
throw a 404 exception in this case.
Az.Security 1.4.0
Updated Alerts cmdlets:
'Get-AzSecurityAlert'
'Set-AzSecurityAlert'
Moving Security Contacts to be based on the latest API version '2020-01-01-
preview' with backward compatibility support
Az.ServiceBus 2.2.0
Upgraded API version to 2022-10-01-preview
Fixed a bug for 'Set-AzServiceBusQueue'
Az.ServiceFabric 3.1.1
Az.Sql 4.4.0
Az.Storage 5.4.1
Updated Azure.Core to 1.28.0.
Az.StorageMover 1.0.0
General availability for module Az.StorageMover
Updated StorageMover API version to 2023-03-01
Az.Synapse 2.3.0
Az.Websites 2.13.0
Added a new parameter '-CopyIdentity' for 'New-AzWebAppSlot' to copy the
identity from the parent app to the slot.
Updated 'New-AzWebAppSSLBinding' to support -WhatIf parameter
Az.Accounts 2.11.2
Az.Aks 5.3.0
Az.ApplicationInsights 2.2.2
Az.Compute 5.4.0
Az.DataFactory 1.16.12
Updated ADF .Net SDK version to 9.0.0
Az.DataProtection 1.1.0
Added support for Immutable backup vaults
Added Cross subscription restore flag for backup vaults
Added Soft delete setting for backup vaults
Fixed issue with Set-AzDataProtectionMSIPermission command
Replaced Get-InstalledModule with Get-Module -ListAvailable
Added New-AzDataProtectionSoftDeleteSettingObject command
Az.EventHub 3.2.1
Fixed 'New-AzEventHubAuthorizationRuleSASToken' cmdlet which was returning
wrong skn value
Az.Monitor 4.4.1
Removed default value for time window for autoscale profile [#20660]
'Get-AzAutoscaleSetting'
'New-AzAutoscaleSetting'
Az.Network 5.4.0
Fixed a bug that does not enable to set Perform SNAT to Always
Fixed the incorrect type of '-TotalBytesPerSession' in 'New-
AzNetworkWatcherPacketCapture'
Az.RecoveryServices 6.2.0
Added support for enable/disable Public Network Access and PrivateEndpoints
Added support for Immutable Vaults
Added support for RetainRecoveryPointsAsPerPolicy in Disable-
AzRecoveryServicesBackupProtection cmdlet. Now user can suspend backups and
retain RPs as per policy
Added List Recovery Point expiry time
Added RecoveryServices, RecoveryServices.Backup,
RecoveryServices.Backup.CrossRegionRestore management SDK
Added support for non-UTC time zones with standard policy for workloadType
IaasVM, MSSql, AzureFiles
Az.RedisCache 1.7.1
Updated 'Get-AzRedisCacheLink' and 'New-AzRedisCacheLink' to print
'PrimaryHostName', 'GeoReplicatedPrimaryHostName', 'ServerRole', and
'LinkedRedisCacheLocation'.
Az.Resources 6.5.2
Az.Sql 4.3.0
Az.StackHCI 1.4.2
Added Remote Support terms and conditions for HCI device types.
Unified Resource Group support for both Azure Stack HCI and Arc for server
resources.
Enhanced error feedback and logging in the Register-AzStackHCI cmdlet.
Bug fixes and improvements in Azure Arc for servers enablement in Register-
AzStackHCI cmdlet.
Improved parameter validations in the Register-AzStackHCI cmdlet.
Enabled Managed System Identity (MSI) for Registration in Fairfax Cloud.
Minor bug fixes and improvements.
Az.Storage 5.4.0
Added a warning message for the upcoming breaking change when creating a
Storage account
'New-AzStorageAccount'
Removed the ValidateSet of StandardBlobTier parameter
'Copy-AzStorageBlob'
'Set-AzStorageBlobContent'
'Start-AzStorageBlobCopy'
Az.TrafficManager 1.2.0
Az.Accounts
Az.Aks
Added parameter '-EnableEncryptionAtHost' for 'New-AzAksCluster' and 'New-
AzAksNodePool'
Added parameter '-EnableUltraSSD' for 'New-AzAksCluster' and 'New-
AzAksNodePool'
Added parameter '-NodeKubeletConfig' for 'New-AzAksCluster', '-KubeletConfig'
for 'New-AzAksNodePool'
Added parameter '-NodeLinuxOSConfig' for 'New-AzAksCluster', '-LinuxOSConfig'
and 'New-AzAksNodePool'
Added parameter '-NodeMaxSurge' for 'New-AzAksCluster', '-MaxSurge' for 'New-
AzAksNodePool' and 'Update-AzAksNodePool'
Added parameter '-PPG' for 'New-AzAksCluster' and 'New-AzAksNodePool'
Added parameter '-SpotMaxPrice' for 'New-AzAksNodePool'
Added parameter '-EnableFIPS' for 'New-AzAksCluster' and 'New-AzAksNodePool'
Added parameter '-AutoScalerProfile' for 'New-AzAksCluster' and 'Set-AzAksCluster'
Added parameter '-GpuInstanceProfile' for 'New-AzAksCluster' and 'New-
AzAksNodePool'
Added parameter '-EnableUptimeSLA' for 'New-AzAksCluster' and 'Set-
AzAksCluster'
Added parameter '-EdgeZone' for 'New-AzAksCluster'
Az.ApiManagement
Az.ApplicationInsights
Enabled output object enumerating for 'Get-AzApplicationInsights' [#20225]
Az.Automation
Updated Example: Start-AzAutomationRunbook should pass ordered dictionary for
parameters [#20408]
Az.Batch
Added new properties 'CurrentNodeCommunicationMode' (read only) and
'TargetCommunicationMode' of type 'NodeCommunicationMode' to 'PSCloudPool'.
Valid values for 'NodeCommunicationMode': Default, Classic, Simplified
When the 'PSCloudPool' is updated with a new 'TargetCommunicationMode'
value, the Batch service will attempt to update the pool to the new value the next
time the pool is resized down to zero compute nodes and back up.
'PSPrivateLinkServiceConnectionState''s 'ActionRequired' property required has
been renamed to 'ActionsRequired'. The old property has been marked as obsolete,
and now just returns the new property. This should not impact existing consumers.
Az.Compute
Removed the image 'Win2008R2SP1' from the list of available images and
documentation. This image is no longer available on the backend so the client tools
need to sync to that change.
Fixed a bug for creating Linux VM's from SIG/Community Gallery Images
Added 'ImageReferenceId' string parameter to the 'New-AzVmssConfig' cmdlet. This
allows gallery image references to be added for the Confidential VM feature.
Added 'SecurityEncryptionType' and 'SecureVMDiskEncryptionSet' string parameters
to the 'Set-AzVmssStorageProfile' cmdlet for the Confidential VM feature.
Az.ContainerRegistry
Fixed bug in 'Get-AzContainerRegistryTag' to show correct tags [#20528]
Az.Monitor
Fixed bug for 'Remove-AzDataCollectionRuleAssociation' [#20207]
Added support for test notifications cmdlets
'Test-AzActionGroup'
Fixed start time parameter description of 'Get-AzActivityLog' [#20409]
Az.Network
Az.RedisCache
Az.Resources
Fixed issue introduced in previous fix for 'Set-AzPolicySetDefinition'
InternalServerError when the initiative is too large [#20238], which will remove space
in value.
Fixed 'Get-AzRoleAssignment' BadRequest when scope is '/' [#20323]
Az.SecurityInsights
Fixed for 'Update-AzSentinelAlertRule' fails when using '-TriggerThreshold 0'
[#20417]
Az.Sql
Az.StackHCI
Added support for arc extensions which depend on HCI cluster's IMDS endpoints.
Az.Storage
Return ListBlobProperties in blob list result
'Get-AzStorageBlob'
Output AllowedCopyScope in get account result
'Get-AzStorageAccount'
Az.Websites
Fixed 'Import-AzWebAppKeyVaultCertificate' to use certificate naming convention
same as portal [#19592]
Az.Accounts
Enabled caching tokens when logging in with a client assertion. This fixed the
incorrectly short lifespan of tokens.
Upgraded target framework of Microsoft.Identity.Client to net461 [#20189]
Stored 'ServicePrincipalSecret' and 'CertificatePassword' into 'AzKeyStore'.
Updated the reference of Azure PowerShell Common to 1.3.67-preview.
Az.Aks
Az.ApplicationInsights
Az.Compute
Fixed issue found for 'Set-AzVmssVMRunCommand' [#19985]
Fixed 'Get-AzVm' cmdlet when parameter '-Status' is provided, return property
'OsName', 'OsVersion' and 'HyperVGeneration'
Fixed 'New-AzVM' cmdlet when creating VM with bootdiagnostic storage causes
exception 'Kind' cannot be null.
Az.CosmosDB
Az.DataFactory
Az.DataProtection
Fixed spacing issues in Set-AzDataProtectionMSIPermission.ps1
Az.EventHub
Added NamespaceV2 cmdlets for EventHub
Az.KeyVault
Fixed certificate export parameter issue in 'Add-AzKeyVaultKey' [#19623]
Fixed CertificateString decoding issue in 'Import-AzKeyVaultCertificate'
Shifted the location of key CVM release policy to GitHub [#19984]
Added fallback logic (reading default CVM policy from a local copy) if fetching
default CVM Policy from GitHub failed.
Az.Monitor
Az.Network
Az.RecoveryServices
Added support for passing DiskEncryptionSetId for Cross region restore
Fixed the pagination bug in 'Get-AzRecoveryServicesAsrProtectableItem' for the
V2ARCM scenario.
Fixed 'IncludeDiskId' property for 'New-ASRReplicationProtectedItem' cmdlet of
H2A
Az.Resources
Added cmdlet 'Get-AzADOrganization'
Fixed 'Set-AzPolicySetDefinition' InternalServerError when the initiative is too large
[#20238]
Az.ServiceBus
Added NamespaceV2 cmdlets for ServiceBus.
Az.SignalR
Az.StackHCI
Az.Storage
Supported MaxPageSize, Include, and Filter parameters for listing encryption scopes
'Get-AzStorageEncryptionScope'
Supported excludePrefix, includeDeleted, and many new schema fields in Blob
Inventory
'New-AzStorageBlobInventoryPolicyRule'
Az.Synapse
Added breaking change message for '-SparkConfigFilePath'. It will be deprecated
around the middle of December.
Updated 'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' to support
for setting spark pool configuration artifact by '-SparkCongifuration'. '-
SparkCongifuration' is an alternative of parameter '-SparkConfigFilePath'.
Az.Websites
Added Tag parameter for 'New-AzWebApp' and 'New-AzWebAppSlot'
Fixed 'Set-AzWebApp' and 'Set-AZWebAppSlot' to rethrow exception when Service
Principal/User doesn't have permission to list web app configuration. [#19942]
Az.Accounts
Az.CognitiveServices
Updated CognitiveServices PowerShell to use 2022-10-01 version.
Az.Compute
Fixed EdgeZone does not pass to VM for 'New-AzVM' 'SimpleParameterSet'
[#18978]
Added 'ScriptFilePath' parameter set for 'Set-AzVMRunCommand' and 'Set-
AzVmssVMRunCommand' to allow users to pass in the path of the file that has the
run command script
Added '-AsJob' optional parameter to 'Remove-AzVMExtension' cmdlet.
Added '-EdgeZone' optional parameter for 'Get-AzComputeResourceSku' and 'New-
AzSnapshotUpdateConfig' cmdlets.
Added Disk Delete Optional parameters 'OsDisk Deletion Option' and 'Delete
Option' to the 'Set-AzVmssStorageProfile' (OS Disk) and 'Add-AzVmssDataDisk'
(Data Disk)
Improved printed output for 'Get-AzComputeResourceSku'
Updated 'Get-AzHost' cmdlet logic to return Host for '-ResourceId' parameterset.
Added '-OSDiskSizeGB' optional parameter for 'Set-AzVmssStorageProfile'.
Improved cmdlet description for 'Set-AzVM' and added examples.
Updated property mapping for parameter 'Encryption' of 'New-
AzGalleryImageVersion'
Updated list format to display all VmssVmRunCommand properties for 'Get-
AzVmssVmRunCommand'
Updated 'Get-AzGallery', 'New-AzGallery', 'Update-AzGallery', 'Get-
AzGalleryImageDefinition', 'Get-AzGalleryImageVersion', 'New-AzVm' and 'New-
AzVmss' to support community galleries
Az.Databricks
Az.DataFactory
Az.DataProtection
Az.EventGrid
Az.EventHub
Added readonly Status property in EventHub Namespace
Az.Functions
Added warning logs to detect Az context switching in Get-AzFunctionApp
Az.KeyVault
Bumped API version to 2022-07-01
Added 'Undo-AzKeyVaultManagedHsm' to recover deleted managed HSM
Az.ManagedServiceIdentity
Az.Migrate
Added parameter 'CacheStorageAccountId' to 'Initialize-
AzMigrateReplicationInfrastructure'
Added support for OS Disk Swap and Test Migrate Subnet Selection
Az.Network
Added possible value 'LocalGateway' for parameter 'GatewayType'
'New-AzVirtualNetworkGateway'
Exposed 'ExtendedLocation' and 'VNetExtendedLocationResourceId' for
'VirtualNetworkGateway'
'Get-AzVirtualNetworkGateway'
Added new cmdlet to get firewall learned ip prefixes
'Get-AzFirewallLearnedIpPrefix'
Fixed a bug that does not update firewall policy application, network and nat rules'
descriptions even though description is provided via description parameter
Updated 'New-AzIpConfigurationBgpPeeringAddressObject' to remove validate null
or empty check for CustomAddress in Azure Virtual Network Gateway
Updated 'New-AzVirtualNetworkGateway' to add validate null or empty check for
CustomAddress in Azure Virtual Network Gateway
Updated cmdlets to add new property of 'VirtualNetworkGatewayPolicyGroup' and
'VpnClientConnectionConfiguration' in Azure Virtual Network Gateway
'New-AzVirtualNetworkGateway'
'Set-AzVirtualNetworkGateway'
Added new cmdlets to create
'New-AzVirtualNetworkGatewayPolicyGroup'
'New-AzVirtualNetworkGatewayPolicyGroupMember'
'New-AzVpnClientConnectionConfiguration'
Added message in breaking change attribute to notify that load balancer sku
default behavior will be changed
'New-AzLoadBalancer'
Added cmdlet preview to notify customers to use default value or leave null for load
balancer probe threshold property
'New-AzLoadBalancerProbeConfig'
'Set-AzLoadBalancerProbeConfig'
'Add-AzLoadBalancerProbeConfig'
Az.RecoveryServices
Added support for cross zonal restore for ZRS vaults for non-ZonePinned VM
Fixed bug with Update-AzRecoveryServicesAsrProtectionContainerMapping
Added new scenarios: EZ-to-AZ, EZ-to-AZ, EZ-to-EZ
Removed 'VmName' from non A2A scenarios of 'New-
AzRecoveryServicesAsrReplicationProtectedItem' as it is not applicable
Az.Resources
Az.Sql
Added new cmdlets for CRUD operations on SQL server IPv6 Firewall rules
'Get-
AzSqlServerIpv6FirewallRule'
'New-AzSqlServerIpv6FirewallRule'
'Remove-
AzSqlServerIpv6FirewallRule'
'Set-AzSqlServerIpv6FirewallRule'
StorageContainerSasToken parameter in the 'Start-
AzSqlInstanceDatabaseLogReplay' cmdlet is now optional
Az.StackHCI
Az.Storage
Supported generate DataLakeGen2 Sas token with Encryption scope
'New-AzDataLakeGen2SasToken'
Supported blob type conversions in sync blob copy
'Copy-AzStorageBlob'
Supported create/upgrade storage account with Keyvault from another tenant and
access Keyvault with FederatedClientId
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported find blobs in a container with a blob tag filter sql expression
'Get-AzStorageBlobByTag'
Migrated following Azure File dataplane cmdlets from 'Microsoft.Azure.Storage.File'
to 'Azure.Storage.Files.Shares'
'Get-AzStorageFileHandle'
'Close-AzStorageFileHandle'
Az.Websites
Fixed 'Publish-AzWebApp' to use latest publish API when deploying war package
[#19791]
Az.Accounts
Upgraded Azure.Core to 1.25.0 and Azure.Identity to 1.6.1
Upgraded Microsoft.Identity.Client to 4.46.2 and
Microsoft.Identity.Client.Extensions.Msal to 2.23.0
Upgraded Microsoft.ApplicationInsights to 2.13.1
[Breaking Change] Changed target framework of
AuthenticationAssemblyLoadContext to netcoreapp3.1.
[Breaking Change] Removed built-in environment of Azure Germany
Supported tenant domain as input while using 'Connect-AzAccount' with parameter
'Tenant'. [#19471]
Used the ArgumentCompleter attribute to replace the dynamic parameters of 'Get-
AzContext'. [#18041]
Fixed issue that module cannot be imported when required file is locked [#19624]
Az.Advisor
Bumped API version to 2020-01-01
Az.Aks
[Breaking Change] Removed the alias 'Install-AzAksKubectl' of 'Install-AzAksCliTool'.
Az.ApiManagement
[Breaking Change] Changed the type of parameter 'Sku' from Enum to String in
'Add-AzApiManagementRegion', 'New-AzApiManagement' and 'Update-
AzApiManagementRegion'.
Az.Attestation
[Breaking Change] Replaced 'New/Remove/Get-AzAttestation' with
'New/Remove/Get-AzAttestationProvider'
Added 'Get-AzAttestationDefaultProvider' and 'Update-AzAttestationProvider'
Upgraded API version from 2018-09-01-preview to 2020-10-01
Az.Automation
Added cmdlets 'Remove-AzAutomationHybridRunbookWorker', 'Remove-
AzAutomationHybridRunbookWorkerGroup', 'Set-
AzAutomationHybridRunbookWorkerGroup', 'Get-
AzAutomationHybridRunbookWorker', 'Get-
AzAutomationHybridRunbookWorkerGroup', 'Move-
AzAutomationHybridRunbookWorker', 'New-AzAutomationHybridRunbookWorker',
'New-AzAutomationHybridRunbookWorkerGroup' for Hybrid Runbook Worker
group management.
Az.Compute
Added the 'TimeCreated' property to the Virtual Machine and Virtual Machine Scale
Set models.
Added Confidential VM functionality to multiple cmdlets.
Added new parameter 'SecureVMDiskEncryptionSet' to cmdlet 'Set-
AzDiskSecurityProfile'.
Added new parameters 'SecureVMDiskEncryptionSet' and
'SecurityEncryptionType' to cmdlet 'Set-AzVMOSDisk'.
Improved cmdlet descriptions and parameter descriptions for VM/VMSS creation.
Added the 'BaseRegularPriorityCount' integer property to the following cmdlets:
'New-AzVmssConfig' and 'Update-AzVmssConfig'
Added the 'RegularPriorityPercentage' integer property to the following cmdlets:
'New-AzVmssConfig' and 'Update-AzVmssConfig'
Added Breaking Changes for Add-AzVMAdditionalUnattendContent and Get-
AzGallery cmdlets
Added '-DiskControllerType' property to the following cmdlets: 'New-AzVm', 'New-
AzVmss', 'New-AzVmConfig', 'Set-AzVmssStorageProfile'
Az.Databricks
Upgraded API version to 2022-04-01-preview
Modified description of 'EnableNoPublicIP' parameter in the 'New-
AzDatabricksWorkspace'. [#14381]
Az.DataFactory
Az.EventGrid
Az.EventHub
Most cmdlets in Az.EventHub module have been migrated to a new format and
would witness breaking changes. Please refer our migration guide
https://go.microsoft.com/fwlink/?linkid=2204690 to know breaking changes in
detail.
Az.Functions
Enabled support to create Node 18 Preview and Java 17 Preview function apps (fixes
issues #19184 and #18925)
Removed the logic that checks for AzureGermanCloud in the cloud endpoints (fixes
issue #19667)
Hided generated unused cmdlets (fixes #16666)
Az.KeyVault
Fixed the exception content swallowed issue when exception.Response is null
[#19531]
Added the existing parameters 'Exportable', 'Immutable', 'UseDefaultCVMPolicy',
and 'ReleasePolicyPath'
to the parameter sets 'InteractiveCreate',
'InputObjectCreate', and 'ResourceIdCreate'.
Az.MarketplaceOrdering
Upgraded API version to 2021-01-01.
Az.Migrate
Updated ApiVersion to 2022-05-01
Added support for pause and resume
'Suspend-AzMigrateServerReplication'
'Resume-AzMigrateServerReplication'
[Breaking Change] Removed unless cmdlets
'Get-AzMigrateReplicationEligibilityResult'
'Get-AzMigrateReplicationProtectionIntent'
'Get-AzMigrateReplicationVaultSetting'
'Get-AzMigrateSupportedOperatingSystem'
'New-AzMigrateReplicationProtectionIntent'
'New-AzMigrateReplicationVaultSetting'
Az.Monitor
[Breaking Change] Upgraded API version for ActivityLogAlert from 2017-04-01 to
2020-10-01, affected cmdlets:
'Get-AzActivityLogAlert'
'Remove-AzActivityLogAlert'
'Set-AzActivityLogAlert' replaced by 'New-AzActivityLogAlert'
'Disable-AzActivityLogAlert' replaced by 'Update-AzActivityLogAlert'
'Enable-AzActivityLogAlert' replaced by 'Update-AzActivityLogAlert'
'New-AzActionGroup' replaced by 'New-AzActivityLogAlertActionGroupObject'
[Breaking Change] Upgraded API version for DiagnosticSetting from 2017-05-01-
preview to 2021-05-01-preview
'Get-AzDiagnosticSettingCategory'
'Get-AzDiagnosticSetting'
'New-AzDiagnosticSetting'
'Remove-AzDiagnosticSetting'
'Set-AzDiagnosticSetting' replaced by 'New-AzDiagnosticSetting'
'New-AzDiagnosticDetailSetting' replaced by 'New-
AzDiagnosticSettingLogSettingsObject' and 'New-
AzDiagnosticSettingMetricSettingsObject'
'Get-AzSubscriptionDiagnosticSettingCategory' replaced by 'Get-
AzEventCategory'
[Breaking Change] Upgraded API version for Autoscale from 2015-04-01 to 2022-
10-01
'Get-AzAutoscaleSetting'
'Remove-AzAutoscaleSetting'
'Add-AzAutoscaleSetting' replaced by 'New-AzAutoscaleSetting'
'New-AzAutoscaleNotification' replaced by 'New-AzAutoscaleNotificationObject'
'New-AzAutoscaleProfile' replaced by 'New-AzAutoscaleProfileObject'
'New-AzAutoscaleRule' replaced by 'New-AzAutoscaleScaleRuleObject'
'New-AzAutoscaleWebhook' replaced by 'New-
AzAutoscaleWebhookNotificationObject'
[Breaking Change] Upgraded API version for ScheduledQueryRule from 2018-04-16
to 2021-08-01
'Get-AzScheduledQueryRule'
'New-AzScheduledQueryRuleAlertingAction'
'New-AzScheduledQueryRuleAznActionGroup'
'New-AzScheduledQueryRule'
'New-AzScheduledQueryRuleLogMetricTrigger'
'New-AzScheduledQueryRuleSchedule'
'New-AzScheduledQueryRuleSource'
'New-AzScheduledQueryRuleTriggerCondition'
'Remove-AzScheduledQueryRule'
'Set-AzScheduledQueryRule'
'Update-AzScheduledQueryRule'
Az.MySql
Az.Network
Az.Resources
Az.SecurityInsights
Az.ServiceBus
Most cmdlets in Az.ServiceBus module have been migrated to a new format and
would witness breaking changes. Please refer our migration guide
https://go.microsoft.com/fwlink/?linkid=2204584 to know breaking changes in
detail.
Az.Sql
Az.StackHCI
Made GraphAccessToken parameter obsolete in Register-AzStackHCI, Unregister-
AzStackHCI and Set-AzStackHCI cmdlets. This is because Az.StackHCI module does
not depend on Azure AD anymore.
Include API version for all Microsoft.AzStackHCI related AZ-Resource calls
Az.Storage
Az.Synapse
[Breaking Change] Updated models of Synapse Link for Azure Sql Database
Updated 'New-AzSynapseWorkspace' and 'Update-AzSynapseWorkspace' to
support for user assigned managed identity (UAMI) by '-
UserAssignedIdentityAction' and '-UserAssignedIdentityId'
Added EnablePublicNetworkAccess parameter to 'New-AzureSynapseWorkspace'
and 'Update-AzSynapseWorkspace'
Az.Accounts
Supported returning all subscriptions with specified name while using 'Get-
AzSubscription' with parameter 'SubscriptionName'. [#19295]
Fixed null reference exception when cmdlet uses AzureRestOperation [#18104]
Updated survey message and settings
Az.Aks
Az.ApiManagement
Added warning message for upcoming breaking change: changed the type of
parameter Sku from Enum to String
Supported GraphQL Specification Format
Az.AppConfiguration
Added cmdlets 'Get-AzAppConfigurationDeletedStore' and 'Clear-
AzAppConfigurationDeletedStore'
Updated ApiVersion to 2022-05-01.
Az.Automation
Az.Batch
Fixed a bug wherein creating a new JobSchedule does not properly submit Output
Files.
Az.Compute
Added Trusted Launch Generic Breaking Change warning for 'New-AzVM', 'New-
AzDisk' and 'New-AzVMSS' cmdlets.
'Get-AzVMRunCommand' now shows all the properties of VMRunCommand in a list
format.
Added new Parameter '-PublicIpSku' to the 'NewAzVM' cmdlet with acceptable
values : 'Basic' and 'Standard'.
Added Generic Breaking Change PublicIpSku Warning and Overridden '-Zone' logic
when '-PublicIpSku' is explicitly provided.
Added Disk Delete Optional parameters 'OsDisk Deletion Option' and 'Delete
Option' to the 'Set-AzVmssStorageProfile' (OS Disk) and 'Add-AzVmssDataDisk'
(Data Disk)
Improved printed output for 'Get-AzComputeResourceSku'
Updated 'Update-AzVm' to give constructive error messages when empty variables
are passed in parameters. [#15081]
Added 'Zone' and 'IntentVMSizeList' optional parameters to the cmdlet 'New-
AzProximityPlacementGroup'.
Added parameters to Gallery cmdlets for Community Galleries
For 'New-AzGalleryImageVersion', 'CVMEncryptionType' and
'CVMDiskEncryptionSetID' added as keys for parameter '-Target'.
Az.DesktopVirtualization
Corrected parameter description of '-Force' in 'Remove-AzWvdUserSession'.
Az.EventGrid
Updated to use the 2021-12-01 API version.
Added new features:
System topic
System topic event subscription
System topic event subscription delivery attributes
Updated cmdlets:
'New-AzEventGridDomain':
Add new optional parameters to support auto creation of topic with first
subscription.
Add new optional parameters to support auto deletion of topic with last
subscription.
Add optional parameters to support azure managed identity
'New-AzEventGridTopic'/'Update-AzEventGridTopic' :
Add optional parameters to support azure managed identity
'New-AzEventGridSubscription '/'Update-AzEventGridSubscription ':
Add new optional parameters to support advanced filtering on arrays.
Add new optional parameters to support delivery attribute mapping.
Add new optional parameters to support storage queue message ttl.
Az.EventHub
In the upcoming major breaking change release in October 2022, Az.EventHub
would be migrating most cmdlets to a new format
for a better powershell
experience and as a result would witness breaking changes. Please refer our
migration guide to know more https://go.microsoft.com/fwlink/?linkid=2204690 .
Az.Functions
Made PowerShell 7.2 the default when creating a PowerShell function app
Az.KeyVault
Az.MarketplaceOrdering
Added a warning message for an upcoming breaking change to 'Get-
AzMarketplaceTerms'.
Az.Monitor
Az.Network
Added breaking change notification for 'Get-AzFirewall', 'New-AzFirewall', 'Set-
AzFirewall' and 'New-AzFirewallHubIpAddress'
Az.OperationalInsights
Az.PolicyInsights
Updated parameter documentation for Get-AzPolicyState
Az.RecoveryServices
Added support for Archive smart tiering for AzureVM and MSSQL workloads.
Az.Resources
Fixed bug '-Password' overwrite '-PasswordProfile' in 'New-AzADUser' [#19265]
Exposed 'EmployeeOrgData' 'Manager' for 'Get-AzADUSer' [#18205]
Exposed parameter '-Count' for 'Get-AzADUser' [#16874]
Az.ServiceBus
In the upcoming major breaking change release in October 2022, Az.ServiceBus
would be migrating most cmdlets to a new format
for a better powershell
experience and as a result would witness breaking changes. Please refer our
migration guide to know more https://go.microsoft.com/fwlink/?linkid=2204584 .
Added -MinimumTlsVersion to New-AzServiceBusNamespace and Set-
AzServiceBusNamespace
Az.Storage
Supported to create or update Storage account with Azure Files Active Directory
Domain Service Kerberos Authentication
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported create/upgrade storage account by enable sftp and enable localuser
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported manage local user of a storage account
'Set-AzStorageLocalUser'
'Get-AzStorageLocalUser'
'Remove-AzStorageLocalUser'
'New-AzStorageLocalUserSshPassword'
'Get-AzStorageLocalUserKey'
'New-AzStorageLocalUserSshPublicKey'
'New-AzStorageLocalUserPermissionScope'
Supported soft delete DataLake Gen2 item
'Get-AzDataLakeGen2DeletedItem'
'Restore-AzDataLakeGen2DeletedItem'
Az.Synapse
Az.Websites
Fixed 'Import-AzWebAppKeyVaultCertificate' to use certificate naming convention
same as Az-CLI
Az.Accounts
Az.Aks
Az.Compute
Az.EventHub
Az.KeyVault
Az.Migrate
Az.Network
Az.RedisEnterpriseCache
Az.Sql
Az.Storage
Added check for storage account sas token is secured with the storage account key.
'New-AzStorageAccountSASToken'
Supported Management Policy rule filter BlobIndexMatch
Added a new cmdlet 'New-
AzStorageAccountManagementPolicyBlobIndexMatchObject'
Added a new parameter 'BlobIndexMatch' in 'New-
AzStorageAccountManagementPolicyFilter'
Az.Synapse
Az.Websites
Az.Accounts
Az.Aks
Added parameter 'CommandContextAttachmentZip' for 'Invoke-
AzAksRunCommand'. [#17454]
Added ManagedIdentity support for Aks[#15656].
Added property 'PowerState' for the output of 'Get-AzAksCluster'[#18271]
Updated the logic of 'Set-AzAksCluster' for parameter 'NodeImageOnly'.
Added parameter 'NodeImageOnly' for 'Update-AzAksNodePool'.
Added parameter 'AvailabilityZone' for 'New-AzAksCluster'. [#18658]
Az.ApplicationInsights
Az.Compute
Az.CosmosDB
Added support for partition key and id paths to be part of client encryption policy.
Fixed bug related to Update-AzCosmosDBSqlContainer command on containers
with Client Encryption Policy.
Az.DataFactory
Updated ADF .Net SDK version to 6.3.0
Az.EventHub
Added cmdlets for CRUD operations on EventHub Application Groups. The added
cmdlets include,
-New-AzEventHubApplicationGroup
-Set-
AzEventHubApplicationGroup
-Remove-AzEventHubApplicationGroup
-Get-
AzEventHubApplicationGroup
-New-AzEventHubThrottlingPolicyConfig
Get-AzEventHubNamespace returned a maximum of 100 namespaces for list by
resource groups or list by subscriptions so far. From here onwards, for resource
groups and subscriptions with over a 100 namespaces, the cmdlet will return all the
namespaces. You will not see a change in the cmdlet behaviour if your resource
groups or subscriptions have less than a 100 namespaces.
Added cmdlets for manual approval of EventHubs Private Endpoint Connections.
The added cmdlets include,
-Approve-AzEventHubPrivateEndpointConnection
-
Deny-AzEventHubPrivateEndpointConnection
-Get-
AzEventHubPrivateEndpointConnection
-Remove-
AzEventHubPrivateEndpointConnection
-Get-AzEventHubPrivateLink
Az.KeyVault
Az.Network
Az.PowerBIEmbedded
Updated SKU allowed values to support A7 and A8
Az.RecoveryServices
Fixed delay in long running operations [#18567]
Az.Resources
Added feedback when deleting role assignments even if passthru is not used
Fixed relative path failure in -AsJob scenario [#18084]
Fixed logic of 'createtime' and 'ChangedTime' in 'Get-AzResource --
ExpandProperties'. [#18206]
Fixed role assignment latency for 'New-AzADServicePrincipal' [#16777]
Az.ServiceBus
Added cmdlets for manual approval of Service Bus Private Endpoint Connections.
The added cmdlets include,
-Approve-AzServiceBusPrivateEndpointConnection
-
Deny-AzServiceBusPrivateEndpointConnection
-Get-
AzServiceBusPrivateEndpointConnection
-Remove-
AzServiceBusPrivateEndpointConnection
-Get-AzServiceBusPrivateLink
Az.ServiceFabric
Fixed typo in verbose log message.
Added Tag support for managed cluster create and update
Az.Sql
Added 'GeoZone' option to 'BackupStorageRedundancy' parameter to 'New-
AzSqlDatabase', 'Set-AzSqlDatabase', 'New-AzSqlDatabaseCopy', 'New-
AzSqlDatabaseSecondary', and 'Restore-AzSqlDatabase' to enable create, update,
copy, geo secondary and PITR support for GeoZone hyperscale databases
Added additional input validation to 'Stop-AzSqlInstanceDatabaseLogReplay'
cmdlet to ensure the target database was created by log replay service
Bug fix for cmdlet 'Restore-AzSqlDatabase'. The optional property 'Tags' was not
working as expected
Added isManagedIdentityInUse get parameter for 'Get-AzSqlServerAudit' and 'Get-
AzSqlDatabaseAudit'
Added new cmdlet 'Set-AzSqlInstanceDatabase'
Az.StackHCI
Added support to Stack HCI Cluster
Added support to Stack HCI Extension
Added support to Stack HCI Arc Settings
Az.Storage
Supported BaseBlob DaysAfterCreationGreaterThan in Management Policy
'Add-AzStorageAccountManagementPolicyAction'
Az.Accounts
Az.Aks
Removed these aliases:
'Get-AzAks'
'New-AzAks'
'Set-AzAks'
'Remove-AzAks'
Az.ApiManagement
[Breaking change] Replaced parameter 'Sample' by 'Examples' in 'New-
AzApiManagementOperation' and 'Set-AzApiManagementOperation'
Updated APIM .Net SDK version to 8.0.0 / Api Version 2021-08-01
Az.ApplicationInsights
Az.Cdn
Az.Compute
Az.ContainerRegistry
Updated parameter types from bool to bool? for 'Update-
AzContainerRegistryRepository' [#17857]
'ReadEnabled'
'ListEnabled'
'WriteEnabled'
'DeleteEnabled'
Az.CosmosDB
Introduced support for creating containers with Client Encryption Policy. The current
supported version of Client Encryption Policy is 1.
Az.DataFactory
Updated ADF .Net SDK version to 6.1.0
Fixed Set-AzDataFactoryV2 -InputObject not correct with PublicNetworkAccess
Parameter
Az.EventHub
Made 'IPRule' and 'VirtualNetworkRule' optional in 'Set-
AzEventHubNetworkRuleSet'.
Deprecated older MSI properties in 'Set-AzEventHubNamespace' and 'New-
AzEventHubNamespace'
Az.Functions
Az.HealthcareApis
Migrated module to generated codebase.
Added cmdlets:
New/Get/Update/Remove-AzHealthcareApisService
New/Get/Update/Remove-AzHealthcareApisWorkspace
New/Get/Update/Remove-AzHealthcareFhirService
New/Get/Update/Remove-AzHealthcareDicomService
New/Get/Update/Remove-AzHealthcareIoTConnector
New/Get/Remove-AzHealthcareIotConnectorFhirDestination
Get-AzHealthcareFhirDestination
Az.KeyVault
Added 'Rotate' into the list of permissions to keys [#17970]
Az.ManagedServiceIdentity
General availability of 'Az.ManagedServiceIdentity'
Az.Network
Supported 'Microsoft.Network/privateLinkServices' in 'Get-
AzPrivateEndpointConnection' [#16984].
Provided friendly message if resource type is not supported for private endpoint
connection features [#17091].
Added 'DisableIPsecProtection' to 'Virtual Network Gateway'.
Added new cmdlets to create/manage authorization objects for ExpressRoutePort:
'Add-AzExpressRoutePortAuthorization'
'Get-AzExpressRoutePortAuthorization'
'Remove-AzExpressRoutePortAuthorization'
Added option parameter 'AuthorizationKey' to cmdlet 'New-AzExpressRouteCircuit'
to allow creating ExpressRoute Circuit on a ExpressRoutePort with a different owner.
Fix bug that can't display CustomIpPrefix in PublicIpPrefix.
Updated cmdlets to add new property of 'HubRoutingPreference' in VirtualHub and
set property of 'PreferredRoutingGateway' deprecated .
'New-AzVirtualHub'
'Update-AzVirtualHub'
Added optional parameter 'AuxiliaryMode' to cmdlet 'New-AzNetworkInterface' to
enable this network interface as Sirius enabled. Allowed values are None(default)
and MaxConnections.
Multipool feature change: Updated cmdlets to add new optional property:
'ConfigurationPolicyGroups' object for associating policy groups.
'Update-AzVpnServerConfiguration'
'New-AzVpnServerConfiguration'
Multipool feature change: Updated cmdlets to add new optional property:
'P2SConnectionConfiguration' object for specifying multiple Connection
configurations.
'Update-AzP2sVpnGateway'
'New-AzP2sVpnGateway'
Multipool feature change: Added new cmdlets to support CRUD of Configuration
policy groups for VpnServerConfiguration.
'Get-AzVpnServerConfigurationPolicyGroup'
'New-AzVpnServerConfigurationPolicyGroup'
'Update-AzVpnServerConfigurationPolicyGroup'
'Remove-AzVpnServerConfigurationPolicyGroup'
Az.RecoveryServices
Added support for Multi-user authorization using Resource Guard for recovery
services vault.
Added support for cross subscription restore for recovery services vault, modified
storage account to be fetched from target subscription.
Az.Resources
Az.Security
Added new cmdlet: 'Get-AzSecuritySolution'
Added Alerts Suppression Rules to cmdlets:
'Get-AlertsSuppressionRule'
'Remove-
AlertsSuppressionRule'
'Set-AlertsSuppressionRule'
'New-
AzAlertsSuppressionRuleScope'
Az.ServiceBus
Az.Sql
Added new cmdlet 'Get-AzSqlInstanceEndpointCertificate'
Added parameter 'HighAvailabilityReplicaCount' to 'New-AzSqlElasticPool' and 'Set-
AzSqlElasticPool'
Az.Storage
Az.Synapse
Added support for Synapse Link for Azure Sql Database
Added 'Get-AzSynapseLinkConnection' cmdlet
Added 'Get-AzSynapseLinkConnectionDetailedStatus' cmdlet
Added 'Set-AzSynapseLinkConnection' cmdlet
Added 'Remove-AzSynapseLinkConnection' cmdlet
Added 'Start-AzSynapseLinkConnection' cmdlet
Added 'Stop-AzSynapseLinkConnection' cmdlet
Added 'Set-AzSynapseLinkConnectionLinkTable' cmdlet
Added 'Get-AzSynapseLinkConnectionLinkTable' cmdlet
Added 'Get-AzSynapseLinkConnectionLinkTableStatus' cmdlet
Added 'Update-AzSynapseLinkConnectionLandingZoneCredential' cmdlet
Set 'UploadedTimestamp' when adding package to spark pool by 'Update-
AzSynapseSparkPool'
Az.Websites
Updated 'Get-AzWebApp' and 'Get-AzWebAppSlot' to expose
'VirtualNetworkSubnetId' property [#18042]
Az.Aks
Az.ApiManagement
Added warning message for upcoming breaking change.
Az.Batch
Updated Az.Batch to use 'Microsoft.Azure.Batch' SDK version 15.3.0
Add ability to assign user-assigned managed identities to 'PSCloudPool'. These
identities will be made available on each node in the pool, and can be used to
access various resources.
Added 'IdentityReference' property to the following models to support accessing
resources via managed identity:
'PSAzureBlobFileSystemConfiguration'
'PSOutputFileBlobContainerDestination'
'PSContainerRegistry'
'PSResourceFile'
'PSUploadBatchServiceLogsConfiguration'
Added new 'extensions' property to 'PSVirtualMachineConfiguration' on
'PSCloudPool' to specify virtual machine extensions for nodes
Added the ability to specify availability zones using a new property
'NodePlacementConfiguration' on 'VirtualMachineConfiguration'
Added new 'OSDisk' property to 'VirtualMachineConfiguration', which contains
settings for the operating system disk of the Virtual Machine.
The 'Placement' property on 'PSDiffDiskSettings' specifies the ephemeral disk
placement for operating system disks for all VMs in the pool. Setting it to
'CacheDisk' will store the ephemeral OS disk on the VM cache.
Added 'MaxParallelTasks' property on 'PSCloudJob' to control the maximum
allowed tasks per job (defaults to -1, meaning unlimited).
Added 'VirtualMachineInfo' property on 'PSComputeNode' which contains
information about the current state of the virtual machine, including the exact
version of the marketplace image the VM is using.
Added 'RecurrenceInterval' property to 'PSSchedule' to control the interval
between the start times of two successive job under a job schedule.
Added a new 'Get-AzBatchComputeNodeExtension' command, which gets a
specific extension by name, or a list of all extensions, for a given compute node.
Updated Az.Batch'Microsoft.Azure.Management.Batch' SDK version 14.0.0.
Added a new 'Get-AzBatchSupportedVirtualMachineSku' command, which gets
the list of Batch-supported Virtual Machine VM sizes available at a given location.
Added a new 'Get-AzBatchTaskSlotCount' command, which gets the number of
task slots required by a given job.
'MaxTasksPerComputeNode' has been renamed to 'TaskSlotsPerNode', to match
a change in functionality.
'MaxTasksPerComputeNode' will remain as an alias but will be removed in a
coming update.
Az.Cdn
Added breaking change messages for all cmdlets in Az.CDN module
Az.CognitiveServices
Updated CognitiveServices PowerShell to use 2022-03-01 version.
Added 'Get-AzCognitiveServicesAccountModel' cmdlet.
Az.Compute
Az.ContainerInstance
Supported empty directory volume and secret volume for creating container group
[#17410]
Az.DataFactory
Updated ADF .Net SDK version to 6.0.0
Az.EventHub
Deprecating older MSI related fields in New-AzEventHubNamespace and Set-
AzEventHubNamespace
Az.KeyVault
Supported getting random number from managed HSM by 'Get-
AzKeyVaultRandomNumber'
Skipped subscription connection status validation for Az.KeyVault.Extension
[#17712]
Enabled public network access setting
Az.Kusto
Supported inline script resource (creation of script with content instead of sas
token)
Added managed identity support to EventGrid
Added databaseRouting (Single/Multi) to all data connections
Added PublicIPType to cluster
Az.Network
Fixed 'ArgumentNullException' in 'Add-AzureRmRouteConfig' when
'RouteTable.Routes' is null.
Az.RecoveryServices
Added support for multiple backups per day (hourly) Enhanced policy for
workloadType AzureVM.
Az.Resources
Az.Security
Added new cmdlets for security Automations API
Az.StackHCI
Updated firewall rules for Attestation network to block all other traffic
Updated cluster to ignore Attestation network
Az.Storage
Supported DaysAfterLastTierChangeGreaterThan in Management Policy
'Add-AzStorageAccountManagementPolicyAction'
Fixed the issue that upload blob might fail on Linux [#17743]
'Set-AzStorageBlobContent'
Supported AllowPermanentDelete when enable blob soft delete
'Enable-AzStorageBlobDeleteRetentionPolicy'
Added breaking change warning message for upcoming cmdlet breaking change
'Get-AzStorageFile'
Az.Synapse
Added support for Synapse Azure Active Directory (Azure AD) only authentication
Added 'Get-AzSynapseActiveDirectoryOnlyAuthentication' cmdlet
Added 'Enable-AzSynapseActiveDirectoryOnlyAuthentication' cmdlet
Added 'Disable-AzSynapseActiveDirectoryOnlyAuthentication' cmdlet
Az.Websites
Updated 'New-AzWebAppContainerPSSession' with CmdletDeprecation Attribute
[#16646]
Updated 'Restore-AzDeletedWebApp' to fix issue that prevents the cmdlet from
working on hosts with a locale is anything different from 'en-US'
Az.Accounts
Az.AppConfiguration
Az.Cdn
Added breaking change messages for upcoming breaking change release of version
2.0.0
Az.Compute
Updated 'New-AzVM' to create a new storage account for boot diagnostics if one
does not exist. This will prevent the cmdlet from using a random storage account in
the current subscription to use for boot diagnostics.
Added 'AutomaticRepairAction' string parameter to the 'New-AzVmssConfig' and
'Update-AzVmss' cmdlets.
Updated 'Get-AzVm' to include 'GetVirtualMachineById' parameter set.
Edited the documentation for the cmdlet 'Set-AzVMADDomainExtension' to ensure
the example is accurate.
Improved description and examples for disk creation.
Added new parameters to 'New-AzRestorePoint' and 'New-
AzRestorePointCollection' for copying Restore Points and Restore Point Collections.
Added 'Zone' and 'PlacementGroupId' Parameters to 'Repair-
AzVmssServiceFabricUpdateDomain'.
Edited 'New-AzVmss' logic to better check for null properties when the parameter
'OrchestrationMode' is used.
Az.CosmosDB
Introduced support for client encryption key resource management required for
CosmosDB Client-Side Encryption by adding support for creating, updating and
retrieving client encryption keys with following cmdlets: 'Get-
AzCosmosDbClientEncryptionKey', 'New-AzCosmosDbClientEncryptionKey' and
'Update-AzCosmosDbClientEncryptionKey'
Az.DataFactory
Az.Functions
Exposed PowerShell 7.2 stack definition for function app creation in Functions V4
only
Az.HDInsight
Az.KeyVault
Fixed a bug to continue visiting 'NextPageLink' when listing key vaults from ARM
API
Az.Network
Added support for retrieving the state of packet capture even when the
provisioning state of the packet capture was failure
'Get-AzNetworkWatcherPacketCapture'
Added support for accepting Vnet, Subnet and NIC resources as the
TargetResourceId for the following cmdlets
'Set-AzNetworkWatcherFlowLog'
'New-AzNetworkWatcherFlowLog'
Az.OperationalInsights
Removed capacity validation in new and update cluster cmdlets as validation exists
on server side.
Extended error message on base class for extended information.
Bug fix - prevent exceptions while using StorageInsight cmdlets.
Bug fix - when updating a cluster, it's SKU was set even if no value was passed.
Az.PostgreSql
Added parameter PublicNetworkAccess for PostgreSQL single server related cmdlets
[#17263]
Az.RecoveryServices
Added support for Trusted VM backup and Enhanced policy for WorkloadType
AzureVM.
Added support for disabling hybrid backup security features in 'Set-
AzRecoveryServicesVaultProperty' cmdlet. The feature can be re-enabled by setting
'DisableHybridBackupSecurityFeature' flag to False.
Az.Resources
Removed '-ApplicationId' from 'New-AzADServicePrincipal' 'SimpleParameterSet'
[#17256]
Added 'New-AzResourceManagementPrivateLink', and 'New-
AzPrivateLinkAssociation' cmdlets
Added authorization related cmdlets:
'Get-AzRoleAssignmentSchedule'
'Get-AzRoleAssignmentScheduleInstance'
'Get-AzRoleAssignmentScheduleRequest'
'Get-AzRoleEligibilitySchedule'
'Get-AzRoleEligibilityScheduleInstance'
'Get-AzRoleEligibilityScheduleRequest'
'Get-AzRoleEligibleChildResource'
'Get-AzRoleManagementPolicy'
'Get-AzRoleManagementPolicyAssignment'
'New-AzRoleAssignmentScheduleRequest'
'New-AzRoleEligibilityScheduleRequest'
'New-AzRoleManagementPolicyAssignment'
'Remove-AzRoleManagementPolicy'
'Remove-AzRoleManagementPolicyAssignment'
'Stop-AzRoleAssignmentScheduleRequest'
'Stop-AzRoleEligibilityScheduleRequest'
'Update-AzRoleManagementPolicy'
Added 'Get-AzResourceManagementPrivateLink', 'Remove-
AzResourceManagementPrivateLink', 'Get-
AzResourceManagementPrivateLinkAssociation' and 'Remove-
AzResourceManagementPrivateLinkAssociation' cmdlets
Az.ServiceBus
Az.ServiceFabric
Az.Storage
Az.Websites
Az.Accounts
Az.Compute
Updated New-AzVM feature for 'vCPUsAvailable' and 'vCPUsPerCore' parameters.
Cmdlets will not try to use the new 'VMCustomizationPreview' feature if the user
does not have access to that feature. [#17370]
Az.Accounts
Fixed the issue that authorization does not work in customized environment
[#17157]
Enabled Continue Access Evaluation for MSGraph
Improved error message when login is blocked by AAD
Improved error message when silent reauthentication failed
Loaded System.Private.ServiceModel and System.ServiceModel.Primitives on
Windows PowerShell [#17087]
Az.Aks
Updated the breaking change warning messages [#16805]
Az.CloudService
Az.Compute
Upgraded Compute .NET SDK package reference to version 52.0.0
Updated 'New-AzSshKey' cmdlet to write file paths to generated keys to the
Warning stream instead of the console.
Added 'vCPUsAvailable' and 'vCPUsPerCore' integer parameters to the 'New-AzVm',
'New-AzVmConfig', and 'Update-AzVm' cmdlets.
Az.ContainerInstance
Az.Databricks
Az.DataFactory
Az.DataShare
Az.EventHub
Az.KeyVault
'New-AzKeyVaultManagedHsm': supported specifying how long a deleted managed
hsm is retained by 'SoftDeleteRetentionInDays' and enabling purge protection by
'EnablePurgeProtection'
'Update-AzKeyVaultManagedHsm': supported enabling purge protection by
'EnablePurgeProtection'
'Get-AzKeyVaultManagedHsm': Supported getting or listing deleted managed
HSM(s)
'Remove-AzKeyVaultManagedHsm': Supported purging a specified deleted
managed HSM
Az.Monitor
Fixed an issue where users could not correctly ignore warning messages after
setting environment variables [#17013]
Az.Network
Added new property 'SqlSetting' for Azure Firewall Policy cmdlets
'Get-AzFirewallPolicy'
'New-AzFirewallPolicy'
'Set-AzFirewallPolicy'
Added new to create new 'SqlSetting' object for creating Azure Firewall Policy
'New-AzFirewallPolicySqlSetting'
Added new cmdlet to support query Load Balancer inbound nat rule port mapping
lists for backend addresses
'Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping'
Also updated cmdlets to support inbound nat rule V2 configurations
'New-AzLoadBalancerInboundNatRuleConfig'
'Set-AzLoadBalancerInboundNatRuleConfig'
'Add-AzLoadBalancerInboundNatRuleConfig'
Az.RecoveryServices
Azure Backup added support for 'Create new virtual machine' and 'Replace existing
virtual machine' experience for Managed VMs in Restore-
AzRecoveryServicesBackupItem cmdlet. To perform a VM restore to
AlternateLocation use TargetVMName, TargetVNetName,
TargetVNetResourceGroup, TargetSubnetName parameters. To perform a restore to
a VM in OriginalLocation, do not provide TargetResourceGroupName and
RestoreAsUnmanagedDisks parameters, refer examples for more details.
Az.Resources
Fixed keycredential key format, from base64url to byte [#17131]
Fixed add key credential overwrite existing one [#17088]
Deleted parameter sets cannot be reached for 'New-AzADSericePrincipal'
Marked 'ObjectType' as 'Unknown' if object is not found or current account has
insufficient privileges to get object type for role assignment [#16981]
Fixed that 'Get-AzRoleAssignment' shows empty RoleDefinitionName for custom
roles when not specifying scope [#16991]
Unified the returned 'RoleDefinitionId' in PSRoleAssignment to GUID [#16991]
Az.ServiceBus
Az.Storage
Supported download blob from managed disk account with Sas Uri and bearer
token
'Get-AzStorageBlobContent'
Supported create/upgrade storage account with ActiveDirectorySamAccountName
and ActiveDirectoryAccountType
'New-AzStorageAccount'
'Set-AzStorageAccount'
Az.StorageSync
Az.Synapse
Az.Resources
Fixed New-AzADServicePrincipal not working [#17054] [#17040]
Az.Accounts
Az.Aks
Fixed the typo in 'New-AzAksCluster' [#16733]
Az.Compute
Remove ProvisioningDetails property from PSRestorePoint object.
Updated 'Set-AzVmExtension' cmdlet to properly display '-Name' and '-Location'
parameters as mandatory.
Edited 'New-AzVmssConfig' second example so it runs successfully by changing the
Tag input to the correct format.
Added 'Hibernate' parameter to 'Stop-AzVm' cmdlet.
Added 'HibernationEnabled' parameter to 'New-AzVm', 'New-AzVmConfig', and
'Update-AzVm' cmdlets.
Added 'EnableHotpatching' parameter to the 'Set-AzVmssOSProfile' cmdlet.
Added 'ForceDeletion' parameter to Remove-AzVM and Remove-AzVMSS.
Az.DataFactory
Az.EventHub
Az.HealthcareApis
HealthcareApis cmdlets will bump up API version which may introduce breaking
change. Please contact us for more information.
Az.KeyVault
Az.OperationalInsights
Az.PolicyInsights
Added support for new remediation properties allowing the remediation of more
resources with better control over the remediation rate and error handling
Added support of fetching very large sets of results by internally using paginated
API calls for policy states and policy events commands
Az.RecoveryServices
Reverted the configure backup per policy limit for VMs from 1000 to 100. This limit
was previously relaxed but as Azure portal has a limit of 100 VMs per policy, we are
reverting this limit.
Added support for multiple backups per day for FileShares.
Segregated some of the CRR and non-CRR flows based on the SDK update.
Add EdgeZone parameter to Azure Site recovery service cmdlet 'New-
AzRecoveryServicesAsrRecoveryPlan'
Az.Resources
Added proeprties 'onPremisesLastSyncDateTime', 'onPremisesSyncEnabled' to 'User'
object [#16892]
Added additional properties when creating request for 'New-AzADServicePrincipal'
and 'Update-AzADServicePrincipal' [#16847] [#16841]
Fixed 'DisplayName' and 'ApplicationId' for 'New-AzADAppCredential' [#16764]
Enabled password reset for 'Update-AzADUser' [#16869]
Updated parameter name 'EnableAccount' to 'AccountEnabled', and added alias
'EnableAccount' for 'Update-AzADUser' [#16753] [#16795]
Fixed 'Set-AzPolicyAssignment' does not remove 'notScope' if empty [#15828]
Az.ServiceBus
Added support to Enable or Disable Public Network Access as optional parameter
'PublicNetworkAccess' to 'Set-AzServiceBusNetworkRuleSet'
Fixed 'Set-AzServiceBusNamespace' with Tags
Az.Sql
Deprecation of Get-AzSqlDatabaseTransparentDataEncryptionActivity cmdlet
Fixed cmdlets for Azure Active Directory Admin
'AzureSqlServerActiveDirectoryAdministratorAdapter' and
'AzureSqlInstanceActiveDirectoryAdministratorAdapter' migrate from
'AzureEnvironment.Endpoint.AzureEnvironment.Endpoint.Graph' to
'AzureEnvironment.ExtendedEndpoint.MicrosoftGraphUrl'
Az.StackHCI
Adding support cmdlet for Remote Support
New cmdlets - Install-AzStackHCIRemoteSupport, Remove-
AzStackHCIRemoteSupport, Enable-AzStackHCIRemoteSupport, Disable-
AzStackHCIRemoteSupport, Get-AzStackHCIRemoteSupportAccess,Get-
AzStackHCIRemoteSupportSessionHistory
Az.Storage
Fixed the issue that output number in console when update/copy blob sometimes
[#16783]
'Set-AzStorageBlobContent'
'Copy-AzStorageBlob'
Updated help file, added more description for the asynchronous blob copy.
'Start-AzStorageBlobCopy'
Az.TrafficManager
Az.Websites
Az.Accounts
Copied 'ServicePrincipalSecret' and 'CertificatePassword' from Az.Accounts buildin
profile to customer set profile. [#16617]
Updated help message and help markdown for parameter 'Tenant' of the cmdlet
'Set-AzContext'. [#16515]
Fixed the issue that Azure PowerShell could not work in a workflow. [#16408]
Fixed the doubled Api Version in the URI of the underlying request issued by
'Invoke-AzRestMethod'. [#16615]
Az.Aks
Added support of 'load balancer' and 'api server access' in 'New-AzAksCluster' and
'Set-AzAksCluster'. [#16575]
Az.Automation
'New-AzAutomationSchedule' allows defnining StartTime with offsets.
Fixed bug: updated 'Set-AzAutomationModule' to use PUT call while updating
modules with specific versions [#12552]
Az.CognitiveServices
Az.Compute
Updated 'UserData' parameter in VM and VMSS cmdlets to pipe by the Property
Name to ensure piping scenarios occur correctly.
Changed 'New-AzVM' cmdlet when using the SimpleParameterSet to not create a
'PublicIPAddress' when a 'PublicIPAddress' name is not provided.
Added 'PlatformFaultDomain' parameter to cmdlets: 'New-AzVM' and 'New-
AzVMConfig'
Added '-Feature' parameter for 'New-AzGalleryImageDefinition'
Added 'DiffDiskPlacement' string parameter to 'Set-AzVmOSDisk' and 'Set-
AzVmssStorageProfile' cmdlets.
Az.CosmosDB
Exposed BackupPolicyMigrationState as a part of Get-AzCosmosDBAccount
response.
This shew the status of a backup policy migration state when an account was
being converted from peroidic backup mode to continuous.
Az.DataFactory
Updated ADF .Net SDK version to 5.0.0
Az.Functions
Removed preview from the PowerShell 7.0 stack on Linux
Az.KeyVault
Added cmdlets: 'Invoke-AzKeyVaultKeyRotation', 'Get-AzKeyVaultKeyRotationPolicy'
and 'Set-AzKeyVaultKeyRotationPolicy'
Az.MySql
General availability of Az.MySql
Az.Network
Used case-insensitive comparison for ResourceId (Set/New-
NetworkWatcherFlowLog)
Added new properties 'ApplicationSecurityGroup', 'IpConfiguration' and
'CustomNetworkInterfaceName' for Private Endpoint cmdlets
'Get-AzPrivateEndpoint'
'New-AzPrivateEndpoint'
Added new cmdlet to create new 'IpConfiguration' object for building Private
Endpoint
'New-AzPrivateEndpointIpConfiguration'
Added OrdinalIgnoreCase for string comparison of 'ResourceIdentifier' type for
FlowLog cmdlets
Fixed typo in error message of 'InvalidWorkspaceResourceId'
Az.PostgreSql
General availability of Az.PostgreSql
Az.RedisCache
Added 'IdentityType' and 'UserAssignedIdentity' parameter in 'New-AzRedisCache'
and 'Set-AzRedisCache' cmdlets.
It is used to assign and modify the Identity of Azure Cache for Redis.
Az.ResourceMover
Az.Resources
Az.SignalR
Fixed the bug of 'Update-AzSignalR' cmdlet that resets the resource states by
mistake.
Az.Sql
Added 'ZoneRedundant' parameter to 'New-AzSqlDatabaseCopy', 'New-
AzSqlDatabaseSecondary' and 'Restore-AzSqlDatabase' to enable zone redundant
copy, geo secondary and PITR support for hyperscale databases
Az.Storage
Fixed the failure of sync copy blob with long destination blob name [#16628]
'Copy-AzStorageBlob'
Supported AAD oauth storage context in storage table cmdlets.
Get-AzStorageCORSRule
Get-AzStorageServiceLoggingProperty
Get-AzStorageServiceMetricsProperty
Get-AzStorageServiceProperty
Get-AzStorageTable
Get-AzStorageTableStoredAccessPolicy
New-AzStorageTable
New-AzStorageTableSASToken
New-AzStorageTableStoredAccessPolicy
Remove-AzStorageCORSRule
Remove-AzStorageTableStoredAccessPolicy
Set-AzStorageCORSRule
Set-AzStorageServiceLoggingProperty
Set-AzStorageServiceMetricsProperty
Set-AzStorageServiceProperty
Set-AzStorageTable
Set-AzStorageTableStoredAccessPolicy
Az.Synapse
General availability of Az.Synapse
Migrated Azure AD features in Az.Synapse to MSGraph APIs. The cmdlets below
called MSGraph API according to input parameters:
'New-AzSynapseRoleAssignment' cmdlet
'Get-AzSynapseRoleAssignment' cmdlet
'Remove-AzSynapseRoleAssignment' cmdlet
'Set-AzSynapseSqlActiveDirectoryAdministrator' cmdlet
Added a default value for [-AutoPauseDelayInMinute] parameter of command
'New-AzSynapseSparkpool' and 'Update-AzSynapseSparkpool'
Thanks to our community contributors
@adishiritwick, Updated Set-AzAutomationModule to use PUT call while updating
modules with specific versions (#16505)
@anuraj, Update the New-AzWebAppCertificate (#16634)
@BrajaMS, Updated the example command with NodeType param (#16670)
@geologyrocks, Principal typo (was princial) (#16699)
Hen Itzhaki (@HenItzhaki), Added more example (#16424)
Chris (@isjwuk), Formatting improvement (#15826)
Jaromir Kaspar (@jaromirk), Added example for password credentials (#16600)
Martin Falkus (@mfalkus), Fix a typo in Update Az-Tags doc where "Repalces" was
specified instead of "Replaces" (#16541)
Radoslav Gatev (@RadoslavGatev), [Az.Accounts] Fix the doubled Api Version in Uri
of the request issued by Invoke-AzRestMethod (#16616)
@Skuldo, Typo fix (#16585)
Sujit Singh (@sujitks), Update Set-AzApplicationGatewayFirewallPolicy.md (#16583)
@trudolf-msft, new example 4/workaround (#16437)
Az.Accounts
Az.Advisor
Az.Aks
[Breaking Change] Updated parameter alias and output type of 'Get-AzAksVersion'
Added 'Invoke-AzAksRunCommand' to support running a shell command (with
kubectl, helm) on aks cluster. [#16104]
Added support of 'EnableNodePublicIp' and 'NodePublicIPPrefixID' for 'New-
AzAksCluster' and 'New-AzAksNodePool'. [#15656]
Migrated the logic of creating service principal in 'New-AzAksCluster' from 'Azure
Active Directory Graph' to 'Microsoft Graph'.
Fixed the issue that 'Set-AzAksCluster' can't upgrade cluster when node pool
version doesn't match cluster version. [#14583]
Added 'ResourceGroupName' in 'PSKubernetesCluster'. [#15802]
Az.ApplicationInsights
Added WebTest function. Below is the new cmdlet
'Get-AzApplicationInsightsWebTest'
'New-AzApplicationInsightsWebTest'
'New-AzApplicationInsightsWebTestGeolocationObject'
'New-AzApplicationInsightsWebTestHeaderFieldObject'
'Remove-AzApplicationInsightsWebTest'
'Update-AzApplicationInsightsWebTestTag'
Az.Automation
Fixed example in reference doc for 'Remove-AzAutomationHybridWorkerGroup'
Updated 'Set-AzAutomationModule' to use PUT call while updating modules with
specific versions [#12552]
Az.CloudService
General availability of 'Az.CloudService' module
Az.Compute
Contains updates to the following powershell cmdlets
'SetAzVmssDiskEncryptionExtension' : Added extension parameters for the
cmdlet to work with test extensions and parameter 'EncryptFormatAll' for Virtual
Machine Scale Sets
'GetAzVmssVMDiskEncryptionStatus' : Modified the functionality of the cmdlet to
properly display the encryption status of data disks of Virtual Machine Scale Sets
'SetAzDiskEncryptionExtension' : Fixed a bug in the cmdlet in the migrate
scenario from 2pass to 1pass encryption
Added 'Add-AzVhd' to convert VHD using Hyper-V
Added 'UserData' parameter to VM and VMSS cmdlets
Added string parameter 'PublicNetworkAccess' to DiskConfig and SnapshotConfig
cmdlets
Added boolean parameter 'AcceleratedNetwork' to DiskConfig and SnapshotConfig
cmdlets
Added 'CompletionPercent' property to the PSSnapshot model so it is visible to the
user.
Az.ContainerInstance
Upgraded API version to 2021-09-01
[Breaking Change] Changed the type of parameter
'LogAnalyticWorkspaceResourceId' in 'New-AzContainerGroup' from Hashtable
to String
[Breaking Change] Removed parameter 'NetworkProfileId' in 'New-
AzContainerGroup', added 'SubnetId' as its alternative
[Breaking Change] Removed parameter
'ReadinessProbeHttpGetHttpHeadersName' and
'ReadinessProbeHttpGetHttpHeadersValue' in 'New-AzContainerInstanceObject',
added 'ReadinessProbeHttpGetHttpHeader' as their alternative
[Breaking Change] Removed parameter
'LivenessProbeHttpGetHttpHeadersName' and
'LivenessProbeHttpGetHttpHeadersValue' in 'New-AzContainerInstanceObject',
added 'LivenessProbeHttpGetHttpHeader' as their alternative
Added 'Zone' in 'New-AzContainerGroup', 'AcrIdentity' in 'New-
AzContainerGroupImageRegistryCredentialObject'
Changed 'Username' in 'New-AzContainerGroupImageRegistryCredentialObject'
from mandatory to optional
For 'Invoke-AzContainerInstanceCommand'
[Breaking Change] Displayed command execution result as the cmdlet output by
connecting websocket in backend [#15754]
Added '-PassThru' to get last execution result when the command succeeds
Changed 'TerminalSizeCol' and 'TerminalSizeRow' from mandatory to optional,
set their default values by current PowerShell window size
Added 'Restart-AzContainerGroup', 'Get-
AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint' and
'New-AzContainerInstanceHttpHeaderObject'
Az.CosmosDB
Fixed when a warning about the value of AnalyticalStorageSchemaType is displayed
when no value was given.
Added support for managed Cassandra.
Az.DataFactory
Updated ADF .Net SDK version to 4.28.0
Az.EventHub
Fixed the issue that 'New-AzEventHubKey' always generates a new primary key
instead of a secondary key since version 1.9.0 [#16362]
Az.Functions
Az.HDInsight
Added two parameters '-Zone' and '-PrivateLinkConfiguration' to cmdlet 'New-
AzHDInsightCluster'
Added parameter '-Zone' to cmdlet 'New-AzHDInsightCluster' to support to
create cluster with availability zones feature
Added parameter '-PrivateLinkConfiguration' to cmdlet 'New-
AzHDInsightCluster' to support to add private link configuration when creating
cluster with private link feature.
Added cmdlet New-AzHDInsightIPConfiguration to create ip configuration object in
memory.
Added cmdlet New-AzHDInsightPrivateLinkConfiguration to create private link
configuration object in memory.
Fixed the output type in help doc of Set-AzHDInsightClusterDiskEncryptionKey
cmdlet from 'Microsoft.Azure.Management.HDInsight.Models.Cluster' to
'Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster' to keep
consistent with the real type of returned object.
Breaking change:
Changed the type of parameter 'OSType' from
'Microsoft.Azure.Management.HDInsight.Models.OSType' to 'System.string' in
cmdlet 'New-AzHDInsightCluster'.
Changed the type of parameter 'ClusterTier' from
'Microsoft.Azure.Management.HDInsight.Models.ClusterTier' to 'System.string' in
cmdlets 'New-AzHDInsightCluster' and 'New-AzHDInsightClusterConfig'.
Changed the type of property 'VmSizes' in class 'AzureHDInsightCapabilities'
from IDictionary<string, AzureHDInsightVmSizesCapability> to IList<string> .
Changed the type of property 'AssignedIdentity' in class 'AzureHDInsightCluster'
from 'Microsoft.Azure.Management.HDInsight.Models.ClusterIdentity' to
'Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightClusterIdentity'.
Az.KeyVault
Az.ManagedServices
[Breaking Change] Updated API version to 2020-02-01-preview
Az.Monitor
Added new properties EventName, Category, ResourceProviderName,
OperationName, Status, SubStatus with type string as output for command Get-
AzLog [#15833]
Supported event hub receiver in action group [#16348]
Added default parameter set 'GetByResourceGroup' for the command 'Get-
AzAlertRule' [#16356]
Az.Network
Bugfix in PSAzureFirewallPolicyThreatIntelWhitelist for FirewallPolicy
Added optional parameter '-IsSecuritySite' to the following cmdlet:
'New-AzVpnSite'
Added support for new Match Variables in WAF Exclusions
Onboard Virtual Network Encryption to Virtual Network Cmdlets
Added support for NAT port range parameters in VPN NAT rule resources
'New-AzVpnGatewayNatRule.md'
'Update-AzVpnGatewayNatRule.md'
'New-AzVirtualNetworkGatewayNatRule.md'
'Update-AzVirtualNetworkGatewayNatRule.md'
Added new cmdlets to support Per Rule Exclusions for Application Gateway WAF
'New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet'
'New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup'
'New-AzApplicationGatewayFirewallPolicyExclusionManagedRule'
Also updated cmdlet to add the property for configuring
ExclusionManagedRuleSet within Exclusions
'New-AzApplicationGatewayFirewallPolicyExclusion'
Bug Fix in Application Gateway Trusted Client Certificate cmdlets to load the entire
cert chain from file.
Az.OperationalInsights
Az.RecoveryServices
Azure Backup updated validate sets for supported BackupManagementType in 'Get-
AzRecoveryServicesBackupItem', 'Get-AzRecoveryServicesBackupContainer', Get-
AzRecoveryServicesBackupJob cmdlets.
Azure Backup added support for SAPHanaDatabase for 'Disable-
AzRecoveryServicesBackupProtection', 'Unregister-
AzRecoveryServicesBackupContainer', 'Get-AzRecoveryServicesBackupItem', 'Get-
AzRecoveryServicesBackupContainer' cmdlets.
Breaking Change: 'Get-AzRecoveryServicesBackupJob', 'Get-
AzRecoveryServicesBackupContainer' and 'Get-AzRecoveryServicesBackupItem'
commands will only support 'BackupManagementType MAB' instead of 'MARS'.
Azure Site Recovery support for capacity reservation for Azure to Azure provider.
Az.Resources
Added 'Get-AzProviderPreviewFeature', 'Register-AzProviderPreviewFeature' and
'Unregister-AzProviderPreviewFeature' cmdlets.
Fixed a bug when running Get-AzPolicyAlias with empty value of NamespaceMatch
parameter [#16370]
[Breaking change] Migrated from AAD Graph to Microsoft Graph
[Breaking change] Changed the returned 'Id' in PSDenyAssignment from GUID
string to fully qualified ID
Allowed parameter 'Id' in 'Get-AzDenyAssignment' to accept fully qualified ID
Added new cmdlet 'Publish-AzBicepModule' for publishing Bicep modules
Added deprecation message for 'AssignIdentity' parameter in '*-
AzPolicyAssignment' cmdlets.
Added support for user assigned managed identities in policy assignments by
adding 'IdentityType' and 'IdentityId' parameters to '*-AzPolicyAssignment' cmdlets.
Updated policy cmdlets to use new api version 2021-06-01 that introduces support
for user assigned managed identities in policy assignments.
Narrowed API permission when get information about active directory object for *-
AzRoleAssignment [#16054]
Az.Sql
Az.StackHCI
Promoted Az.StackHCI to GA
Az.Storage
Fixed the failure of 'Get-AzStorageContainerStoredAccessPolicy' when permission is
null [#15644]
Supported create blob service Sas token or account Sas token with permission i
'New-AzStorageBlobSASToken'
'New-AzStorageContainerSASToken'
'New-AzStorageAccountSASToken'
Fixed creating container SAS token failed from an access policy without expire time,
and set SAS token expire time [#16266]
'New-AzStorageContainerSASToken'
Removed parameter -Name from Get-AzRmStorageShare
ShareResourceIdParameterSet
'Get-AzRmStorageShare'
Supported create or migrate container to enable immutable Storage with
versioning.
'New-AzRmStorageContainer'
'Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration'
Supported set/remove immutability policy on a Storage blob.
'Set-AzStorageBlobImmutabilityPolicy'
'Remove-AzStorageBlobImmutabilityPolicy'
Supported enable/disable legal hold on a Storage blob.
'Set-AzStorageBlobLegalHold'
Supported create storage account with enable account level immutability with
versioning, and create/update storage account with account level immutability
policy.
'New-AzStorageAccount'
'Set-AzStorageAccount'
Az.Websites
Updated the Microsoft.Azure.Management.Websites SDK to 3.1.2
Az.Accounts
Added new version of AAD service client using Microsoft Graph API
Az.Aks
Added support for new parameters 'NetworkPolicy', 'PodCidr', 'ServiceCidr',
'DnsServiceIP', 'DockerBridgeCidr', 'NodePoolLabel', 'AksCustomHeader' in 'New-
AzAksCluster'. [#13795]
Added warnings of upcoming breaking change of migrating to Microsoft Graph.
Added support for changing the number of nodes in a node pool. [#12379]
Az.ApiManagement
Fixed a bug in 'Get-AzApiManagementTenantGitAccess' cmdlet.
Az.Batch
Removed assembly 'System.Text.Encodings.Web.dll' [#16062]
Az.Compute
Az.CosmosDB
Introduced Get-AzCosmosDBMongoDBBackupInformation to retrieve latest backup
information for MongoDB.
Updated New-AzCosmosDBAccount, Update-AzCosmosDBAccount to accept
BackupStorageRedundancy
Introduced Get-AzCosmosDBLocation to list Azure CosmosDB Account and its
locations properties.
Az.DataFactory
Added PublicNetworkAccess to Update_AzDataFactoryV2 Command
Updated ADF .Net SDK version to 4.26.0
Az.DesktopVirtualization
Az.EventHub
Added support for Premium sku and namesapce and optional switch parameter
'DisableLocalAuth' to 'New-AzEventHubNamespace' and 'Set-
AzEventHubNamespace'
Az.Functions
Set site config netFrameworkVersion for Windows V4 apps only
Enabled function app creation for Functions V4 stacks [#15919]
Az.IotHub
Az.KeyVault
Added warning message of upcoming breaking change to 'New-
AzKeyVaultRoleDefinition' and 'Get-AzKeyVaultRoleDefinition'.
To comply with the syntax of 'New-AzRoleDefinition' and 'Get-AzRoleDefinition'
we are going to rename some of the properties of 'PSKeyVaultPermission' model,
which might affect these two cmdlets.
Added warnings of upcoming breaking change of migrating to Microsoft Graph.
Az.Migrate
Added check for invalid IP address
Az.OperationalInsights
Fixed a bug in 'Set-AzOperationalInsightsLinkedService: when linked service does
not exist, perform create(update) instead of failing'
Az.RecoveryServices
Az.RedisCache
Created new examples in documentation of 'New-AzRedisCache' and 'Set-
AzRedisCache'.
Az.Resources
Fixed a bug about the exitcode of Bicep [#16055]
Added breaking change warnings for AAD cmdlets
Added property 'UIFormDefinition' to Template Spec Versions, 'Export-
AzTemplateSpec' will now include a Template Spec Version's UIFormDefinition (if
any) as part of the export.
Added error catching for role assignment creation fail while creating a Service
Principal
Performance improvement for Get-AzPolicyAlias when -NamespaceMatch matches
a single RP namespace
Az.Security
Az.ServiceBus
Az.SignalR
Added Web PubSub cmdlets
'New-AzWebPubSub'
'Get-AzWebPubSub'
'Update-AzWebPubSub'
'Restart-AzWebPubSub'
'Remove-AzWebPubSub'
'New-AzWebPubSubHub'
'Get-AzWebPubSubHub'
'Remove-AzWebPubSubHub'
'New-AzWebPubSubKey'
'Get-AzWebPubSubKey'
'Get-AzWebPubSubSku'
'Get-AzWebPubSubUsage'
'Test-AzWebPubSubNameAvailability'
Az.Accounts
Az.Attestation
General availability of 'Az.Attestation' module
Az.Cdn
Fixed null reference exception and typos in 'New-AzFrontDoorCdnRule' cmdlet
Az.Compute
Updated Compute .NET SDK package reference to version 49.1.0
Fixed a bug in 'Get-AzVM' that caused incorrect power status output.
Az.DataFactory
Added a DataFlowEnableQuickReuse argument for the 'Set-
AzDataFactoryV2IntegrationRuntime' cmdlet to enable quick reuse of clusters in
next pipeline activities.
Updated ADF .Net SDK version to 4.25.0
Added a VNetInjectionMethod argument for the 'Set-
AzDataFactoryV2IntegrationRuntime' cmdlet to support the express virtual network
injection of Azure-SSIS Integration Runtime.
Az.FrontDoor
Allowed rule engine action creation without RouteConfigurationOverride for 'New-
AzFrontDoorRulesEngineActionObject'.
Fixed DynamicCompression parameter being ignored issue of 'New-
AzFrontDoorRulesEngineActionObject'.
Az.KeyVault
Supported custom role definitions on managed HSM:
Create via 'New-AzKeyVaultRoleDefinition',
Delete via 'Remove-AzKeyVaultRoleDefinition',
Filter all custom roles via 'Get-AzKeyVaultRoleDefinition -Custom'.
Supported Encrypt/Decrypt/Wrap/Unwrap using keys [#15679]
Enabled managing resources in other subscriptions without switching the context
by adding -Subscription <String> .
Az.Maintenance
Az.Network
Az.RecoveryServices
Azure Site Recovery bug fixes for VMware to Azure Reprotect, Update policy and
Disable scenarios.
Azure Backup added the support for UserAssigned MSI in RecoveryServices Vault.
Az.Resources
Added a clearer error message for a case in which TemplateUri do not accept bicep
file.
Fixed typos with ManagementGroups breaking change descriptions [#15819].
Fixed resource tags casing issue - resource tags casing not being preserved.
Updated to Microsoft.Azure.Management.Authorization 2.13.0-preview.
Az.Sql
Az.Storage
Az.StorageSync
Fixed a bug where not all properties of PSSyncSessionStatus and
PSSyncActivityStatus objects were being populated properly.
This affected the 'Get-AzStorageSyncServerEndpoint' cmdlet when trying to access
the following properties of the output:
SyncStatus.UploadStatus
SyncStatus.DownloadStatus
SyncStatus.UploadActivity
SyncStatus.DownloadActivity
Az.Websites
Updated 'Import-AzWebAppKeyVaultCertificate1' to set the default name with
combination of keyvault name and cert name
Az.Accounts
Corrected the URLs to Azure Portal in the results of 'Get-AzEnvironment' and 'Get-
AzContext'. [#15429]
Made infrastructural changes to support overriding default subscription via a -
SubscriptionId <String> parameter.
Az.Aks
Made -Subscription <String> available in all Aks cmdlets. You can manage Aks
resources in other subscriptions without switching the context.
Az.ApiManagement
Added new 'Sync-AzApiManagementKeyVaultSecret' cmdlet.
Added new 'New-AzApiManagementKeyVaultObject' cmdlet.
Added new optional [-useFromLocation] parameter to the 'Get-
ApiManagementCache' 'New-ApiManagementCache''Update-
ApiManagementCache' cmdlet.
Updated cmdlet New-AzApiManagement to manage ApiManagement service
Added support for the new 'Isolated' SKU
Added support for managing Availability Zones using 'Zone' property
Added support for Disabling Gateway in a Region using 'DisableGateway'
property
Added support for managing the minimum Api Version to allow for Control Plane
using 'MinimalControlPlaneApiVersion' property.
Updated cmdlet New-AzApiManagementRegion to manage ApiManagement
service
Added support for managing Availability Zones using 'Zone' property
Added support for Disabling Gateway in a Region using 'DisableGateway'
property
Updated cmdlet Add-AzApiManagementRegion to manage ApiManagement
service
Added support for managing Availability Zones using 'Zone' property
Added support for Disabling Gateway in a Region using 'DisableGateway'
property
Updated cmdlet Update-AzApiManagementRegion to manage ApiManagement
service
Added support for managing Availability Zones using 'Zone' property
Added support for Disabling Gateway in a Region using 'DisableGateway'
property
Updated cmdlet New-AzApiManagementCustomHostnameConfiguration to
manage Custom Hostname Configuration
Added support for specifying 'IdentityClientId' to provide Managed Identity User
Assigned ClientId to use with KeyVault
Az.Automation
Fixed bug: Closing in input file handle in Import-AzAutomationRunbook
Az.Cdn
Fixed mandatory parameters issue in 'Get-AzCdnEndpointResourceUsage' cmdlet
Az.Compute
Added new parameters '-LinuxConfigurationPatchMode', '-
WindowsConfigurationPatchMode', and '-LinuxConfigurationProvisionVMAgent' to
'Set-AzVmssOSProfile'
Added new parameters '-SshKeyName' and '-GenerateSshKey' to 'New-AzVM' to
create a VM with SSH
Fixed a bug in 'Add-AzVHD' on Linux that caused uploads to fail for certain
destination URI
Added new cmdlets for Restore Points and Restore Point Collection:
'New-AzRestorePoint'
'New-AzRestorePointCollection'
'Get-AzRestorePoint'
'Get-AzRestorePointCollection'
'Update-AzRestorePointCollection'
'Remove-AzRestorePoint'
'Remove-AzRestorePointCollection'
Added new parameters '-EnableSpotRestore' and '-SpotRestoreTimeout' to 'New-
AzVMSSConfig' to enable Spot Restore Policy
Added new cmdlets: 'Update-AzCapacityReservationGroup' and 'Update-
AzCapacityReservation'
Az.CosmosDB
Fixed a bug where the restore of deleted database accounts fail.
Az.DataFactory
Added a subnetId argument for the 'Set-AzDataFactoryV2IntegrationRuntime'
cmdlet to support RBAC checking for VNet injection against the subnet resource ID
instead of the VNet resource ID.
Added the 'Get-
AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint'
cmdlet to provide a list of outbound network dependencies for SSIS integration
runtime in Azure Data Factory that joins a virtual network.
Added PublicNetworkAccess to Data Factory.
Updated ADF .Net SDK version to 4.23.0
Az.KeyVault
Supported adding EC keys in key vault [#15699]
Az.Migrate
Supported duplicate disk UUID in source disk.
Supported subnets in same VNet for AVSet.
Supported runAsAccount fetching for multiple Vcenters in same site.
Az.Network
Updated cmdlet to add 'Subnet' property for IP based load balancer backend
address pool.
'New-AzLoadBalancerBackendAddressConfig'
Updated cmdlet to add 'TunnelInterface' property for backend pool related
operations.
'New-AzLoadBalancerBackendAddressPool'
'Set-AzLoadBalancerBackendAddressPool'
Az.RecoveryServices
Azure Site Recovery multi appliance support for VMware to Azure disaster recovery
scenarios using RCM as the control plane.
Azure Backup fixed targetPhysicalPath issue with SQL CRR
Azure Backup fixed disable protection for SQL workload
Azure Backup resolved bug in setting CMK properties in latest release
Azure Backup removed special characters from register-
azrecoveryservicesbackupcontainer command help text
Az.Resources
Use JsonExtensions to serialize deserialize JSON objects to ensure the use of custom
serialization settings [#15552]
Added support for 'Unsupported' and 'NoEffect' change types to deployment What-
If cmdlets.
Az.SecurityInsights
Az.Sql
Changed the underlying implementation of 'Get-AzSqlDatabase' to support a
paginated response from the server
Added 'ZoneRedundant' parameter to 'New-AzSqlInstance' and 'Set-AzSqlInstance'
to enable the creation and the update of zone - redundant instances.
Added ZoneRedundant field to the model of the managed instance so that it
displays information about zone - redundancy for instance that are returned by
'Get-AzSqlInstance'.
Extended AuditActionGroups enum in server & database audit. Added
DBCC_GROUP, DATABASE_OWNERSHIP_CHANGE_GROUP and
DATABASE_CHANGE_GROUP.
Added 'AsJob' flag to 'Remove-AzSqlInstance'
Added 'SubnetId' parameter to 'Set-AzSqlInstance' to support the cross-subnet
update SLO
Upgraded to newest SDK version
Az.Storage
Az.StorageSync
Az.Websites
Fixed 'Set-AzWebApp' to return a valid warning message when fails to add -
Hostname #9316
Fixed 'Get-AzWebApp' to return CustomDomainVerificationId in the response.
#9316
Az.Aks
Az.CognitiveServices
[Breaking Change] Changed type of PSCognitiveServicesAccount.Identity.Type from
IdentityType to ResourceIdentityType.
[Breaking Change] Changed type of PSCognitiveServicesAccount.Sku.Tier from
SkuTier to string.
[Breaking Change] Removed ActionRequired from
PrivateLinkServiceConnectionState.
Updated PowerShell to use 2021-04-30 version.
Added 'Undo-AzCognitiveServicesAccountRemoval' cmdlet.
Added parameters '-RestrictOutboundNetworkAccess', '-AllowedFqdnList', '-
DisableLocalAuth', '-KeyVaultIdentityClientId', '-IdentityType', '-
UserAssignedIdentityId' to 'New-AzureCognitiveServicesAccount' and 'Set-
AzureCognitiveServicesAccount'.
Added parameters '-InRemovedState', '-Location' to 'Remove-
AzureCognitiveServicesAccount' and 'Get-AzureCognitiveServicesAccount'.
Az.Compute
Fixed the warning in 'New-AzVM' cmdlet stating the sku of the VM is being
defaulted even if a sku size is provided by the user. Now it only occurs when the
user does not provide a sku size.
Edited 'Set-AzVmOperatingSystem' cmdlet to no longer overwrite any existing
EnableAutomaticUpdates value on the passed in virtual machine if it exists.
Updated Compute module to use the latest .Net SDK version 48.0.0.
Added new cmdlets for the Capacity Reservation Feature:
'New-AzCapacityReservationGroup'
'Remove-AzCapacityReservationGroup'
'Get-AzCapacityReservationGroup'
'New-AzCapacityReservation'
'Remove-AzCapacityReservation'
'Get-AzCapacityReservation'
Added a new parameter '-CapacityReservationGroupId' to the following cmdlets:
'New-AzVm'
'New-AzVmConfig'
'New-AzVmss'
'New-AzVmssConfig'
'Update-AzVm'
'Update-AzVmss'
Az.DataFactory
Az.Migrate
Az.Monitor
Added parameter 'ResourceGroupName' back for 'Add-AzAutoscaleSetting'
parameter set 'AddAzureRmAutoscaleSettingUpdateParamGroup' and made it
optional [#15491]
Az.RecoveryServices
Az.RedisCache
Az.ServiceFabric
Fixed Managed and Classic Application models (Application, Cluster, Service) by
updating constructor to take all new properties
This solves piping related issues where piping the results directly from a Get
cmdlet call into and Update or Set call remove some intentionally set properties
Updated appropriate test files to cover the above mentioned cases
Az.Sql
Az.Storage
Az.Websites
Az.Accounts
Fixed access error when subscripiton has no 'Tags' property [#15425].
Az.Accounts
Az.Aks
Az.ApplicationInsights
Az.CosmosDB
This release introduces the cmdlets for the features of Continuous Backup(Point in
time restore):
Introduced support for creating accounts with continuous mode backup policy.
Introduced support for Point in time restore for accounts with continuous mode
backup policy.
Introduced support to update the backup interval and backup retention for
accounts with periodic mode backup policy.
Introduced support to list the restorable resources in a live database account.
Introduces support to specify analytical storage schema type on account
creation/update.
The following cmdlets are added:
Restore-AzCosmosDBAccount, New-AzCosmosDBDatabaseToRestore, Get-
AzCosmosDBRestorableDatabaseAccount,
Get-AzCosmosDBSqlRestorableDatabase, Get-
AzCosmosDBSqlRestorableContainer, Get-
AzCosmosDBSqlRestorableResource,
Get-AzCosmosDBMongoDBRestorableDatabase, Get-
AzCosmosDBMongoDBRestorableCollection, Get-
AzCosmosDBMongoDBRestorableResource.
Az.DataFactory
Added Customer Managed Key Encryption to DataFactory
Az.Functions
Added two additional app settings (WEBSITE_CONTENTSHARE and
WEBSITE_CONTENTAZUREFILECONNECTIONSTRING) for Linux Consumption apps.
[15124]
Fixed bug with New-AzFunctionApp when created on Azure Gov. [13379]
Added Az.Functions cmdlets need to support creating and copying app settings
with empty values. [14511]
Az.Monitor
Fixed null reference bug for 'Get-AzMetric' when 'ResultType' set to 'Metadata'
Fixed bug for 'Add-AzAutoscaleSetting' not able to pipe result from 'Get-
AzAutoscaleSetting' [#13861]
Az.Network
Added public ip address as an optional parameter to create route server
'New-AzRouteServer'
Updated cmdlets to enable specification of edge zone
'New-AzPublicIpPrefix'
'New-AzLoadBalancer'
'New-AzPrivateLinkService'
'New-AzPrivateEndpoint'
Added support for viewing extended location of virtual network in the console
'New-AzVirtualNetwork'
'Get-AzVirtualNetwork'
Added support for viewing extended location of public IP address in the console
'New-AzPublicIpAddress'
'Get-AzPublicIpAddress'
Az.RecoveryServices
Fixed Disable SQL AG AutoProtection.
Az.Security
Az.Sql
Az.Storage
Supported enable/disable Blob container soft delete
'Enable-AzStorageContainerDeleteRetentionPolicy'
'Disable-AzStorageContainerDeleteRetentionPolicy'
Supported list deleted Blob containers
'Get-AzRmStorageContainer'
'Get-AzStorageContainer'
Supported restore deleted Blob container
'Restore-AzStorageContainer'
Supported secure SMB setting in File service properties
'Update-AzStorageFileServiceProperty'
Supported create account with EnableNfsV3
'New-AzStorageAccount'
Supported input more copy blob parameters from pipeline [#15301]
'Start-AzStorageBlobCopy'
Az.Websites
Fixed 'Import-AzWebAppKeyVaultCertificate' to support ServerFarmId [#15091]
Fixed 'Added an optional parameter to delete or keep Appservice plan when the last
WebApp is removing from plan'
Az.Accounts
Az.Aks
Fixed the issue that 'Set-AzAks' will fail in Automation Runbook. [#15006]
Az.ApplicationInsights
Fixed issue that 'ResourcegroupName' is missed when executing below cmdlets with
'InputObject' parameter [#14848]
'Get-AzApplicationInsightsLinkedStorageAccount'
'New-AzApplicationInsightsLinkedStorageAccount'
'Update-AzApplicationInsightsLinkedStorageAccount'
'Remove-AzApplicationInsightsLinkedStorageAccount'
Az.Cdn
Az.ContainerInstance
Az.DataFactory
Az.EventHub
Added functionality to accept input from pipeline for 'Get-AzEventHub' from 'Get-
AzEventHubNamespace'.
Az.HDInsight
Support new azure monitor feature in HDInsight:
Add cmdlet 'Get-AzHDInsightAzureMonitor' to allow customer to get the Azure
Monitor status of HDInsight cluster.
Add cmdlet 'Enable-AzHDInsightAzureMonitor' to allow customer to enable the
Azure Monitor in HDInsight cluster.
Add cmdlet 'Disable-AzHDInsightAzureMonitor' to allow customer to disable the
Azure Monitor in HDInsight cluster.
Az.KeyVault
Az.Network
Updated cmdlets for route server for a more stable way to add IP configuration.
Added support for getting a single private link resource.
Added more detailed description about GroupId in 'New-
AzPrivateLinkServiceConnection'
Updated cmdlets to enable setting of PrivateRange on AzureFirewallPolicy.
'New-AzFirewallPolicy'
'Set-AzFirewallPolicy'
Updated cmdlets to add NatRules in VirtualNetworkGateway and
BgpRouteTranslationForNat.
'New-AzVirtualNetworkGateway'
'Set-AzVirtualNetworkGateway'
Updated cmdlets to add EngressNatRules and EgressNatRules in
VirtualNetworkGateway Connection.
'New-AzVirtualNetworkGatewayConnection'
'Set-AzVirtualNetworkGatewayConnection'
Updated cmdlet to enable setting of FlowTimeout in VirtualNetwork.
'New-AzVirtualNetwork'
Added cmdlets for Get/Create/Update/Delete VirtualNetworkGatewayNatRules.
'New-AzVirtualNetworkGatewayNatRule'
'Update-AzVirtualNetworkGatewayNatRule'
'Get-AzVirtualNetworkGatewayNatRule'
'Remove-AzVirtualNetworkGatewayNatRule'
Added a new cmdlet for Sync on VirtualNetworkPeering
'Sync-AzVirtualNetworkPeering'
Updated cmdlets to add new properties and redefined an existing property in the
VirtualNetworkPeering
'Add-AzVirtualNetworkPeering'
'Get-AzVirtualNetworkPeering'
Updated cmdlets to enable setting of PreferredRoutingGateway on VirtualHub.
'New-AzVirtualHub'
'Update-AzVirtualHub'
Updated cmdlets to expose two read-only properties of client certificate.
'Get-AzApplicationGatewayTrustedClientCertificate'
Az.RecoveryServices
Az.Resources
Allowed naming the deployment when testing deployments [#11497]
Az.SignalR
Changed to 'Allow' and 'Deny' parameters of 'Update-AzSignalRNetworkAcl' cmdlet:
Accepted 'Trace' as a valid value.
Accepted '@()' as empty collection to clear the list.
Supported 'ResourceGroupCompleter' and 'ResourceNameCompleter' in the
applicable cmdlets.
Deprecated the 'HostNamePrefix' property of output type 'PSSignalRResource' of
following cmdlets:
'Get-AzSignalR'
'New-AzSignalR'
'Update-AzSignalR'
Az.Sql
Added option to support short version of maintenance configuration id for
Managed Instance in 'New-AzSqlInstance' and 'Set-AzSqlInstance' cmdlets
Added HighAvailabilityReplicaCount to 'New-AzSqlDatabaseSecondary'
Added External Administrator and AAD Only Properties to AzSqlServer and
AzSqlInstance
Added option to specify '-ExternalAdminName', '-ExternalAdminSid', '-
EnableActiveDirectoryOnlyAuthentication' in 'New-AzSqlInstance' and 'Set-
AzSqlInstance' cmdlets
Added option to expand external administrators information using '-
ExpandActiveDirectoryAdministrator' in 'Get-AzSqlServer' and 'Get-
AzSqlInstance' cmdlets
Fixed 'Set-AzSqlDatabase' to no longer default ReadScale to Disabled when not
specified
Fixed 'Set-AzSqlServer' and 'Set-AzSqlInstance' for partial PUT with only identity and
null properties
Added parameters related to UMI in 'New-AzSqlServer', 'New-AzSqlInstance', 'Set-
AzSqlServer' and 'Set-AzSqlInstance' cmdlets.
Added -AutoRotationEnabled parameter to following cmdlets:
'Set-AzSqlServerTransparentDataEncryptionProtector'
'Get-AzSqlServerTransparentDataEncryptionProtector'
'Set-AzSqlInstanceTransparentDataEncryptionProtector'
'Get-AzSqlInstanceTransparentDataEncryptionProtector'
Az.Storage
Az.Websites
Fixed issue that prevented removing rules by name and unique identifier in
'Remove-AzWebAppAccessRestrictionRule'
Fixed issue that defaults AlwaysOn to false in 'Set-AzWebAppSlot'
Az.Accounts
Upgraded Azure.Identity to 1.4 and MSAL to 4.30.1
Removed obsolete parameters 'ManagedServiceHostName', 'ManagedServicePort'
and 'ManagedServiceSecret' of cmdlet 'Connect-AzAccount', environment variables
'MSI_ENDPOINT' and 'MSI_SECRET' could be used instead
Customize display format of PSAzureRmAccount to hide secret of service principal
[#14208]
Added optional parameter 'AuthScope' to 'Connect-AzAccount' to support
enhanced authentication of data plane features
Set retry times by environment variable [#14748]
Supported subject name issuer authentication
Az.Compute
Az.ContainerInstance
Az.CosmosDB
Introduced support for Sql data plane RBAC, allowing the creation, updating,
removal, and retrieval of Role Definitions and Role Assignments
The following cmdlets are added:
Get-AzCosmosDBSqlRoleDefinition, Get-AzCosmosDBSqlRoleAssignment,
New-AzCosmosDBSqlRoleDefinition, New-AzCosmosDBSqlRoleAssignment,
Remove-AzCosmosDBSqlRoleDefinition, Remove-
AzCosmosDBSqlRoleAssignment,
Update-AzCosmosDBSqlRoleDefinition, Update-
AzCosmosDBSqlRoleAssignment,
New-AzCosmosDBSqlPermission
Az.DesktopVirtualization
Upgraded api version to 2021-02-01-preview.
Az.Functions
Added support in function app creation for Python 3.9 and Node 14 function apps
Removed support in function app creation for V2, Python 3.6, Node 8, and Node 10
function apps
Updated IdentityID parameter from string to string array in Update-AzFunctionApp.
This is to be consistent with New-AzFunctionApp which has the same parameter as
a string array
Updated FullyQualifiedErrorId for an invalid Functions version from
FunctionsVersionIsInvalid to FunctionsVersionNotSupported
When creating a Node.js function app, if no runtime version is specified, the default
runtime version is set to 14 instead of 12
Az.KeyVault
Az.Kusto
Bumped API version to stable 2021-01-01
Az.Maintenance
Bumped API version to stable 2021-05-01
Az.Migrate
Fixed an issue in Initialize-AzMigrateReplicationInfrastructure.ps1
Az.Network
Updated validation to allow passing zero value for saDataSizeKilobytes parameter
'New-AzureRmIpsecPolicy'
Added optional parameter '-EdgeZone' to the following cmdlets:
'New-AzNetworkInterface'
'New-AzPublicIpAddress'
'New-AzVirtualNetwork'
Az.RecoveryServices
Fixed security issue with SQL restore, this is a necessary breaking change.
TargetContainer becomes mandatory for Alternate Location Restore.
Removed Set-AzRecoveryServicesBackupProperties cmdlet alias, Set-
AzRecoveryServicesBackupProperty is supported.
Removed Get-AzRecoveryServicesBackupJobDetails cmdlet alias, Get-
AzRecoveryServicesBackupJobDetail is supported.
Added support for cross subscription DS Move.
Azure Site Recovery support for VMware to Azure disaster recovery scenarios using
RCM as the control plane.
Az.Resources
Changed '-IdentifierUris' in 'New-AzADApplication' to optional parameter
Removed generated 'DisplayName' of ADApplication created by 'New-
AzADServicePrincipal'
Updated SDK to 3.13.1-preview to use GA TemplateSpecs API version
Added 'AdditionalProperties' to PSADUser and PSADGroup [#14568]
Supported 'CustomKeyIdentifier' in 'New-AzADAppCredential' and 'Get-
AzADAppCredential' [#11457], [#13723]
Changed 'MainTemplate' to be shown by the default formatter for Template Spec
Versions
Az.SecurityInsights
Az.ServiceFabric
Az.Sql
Az.Storage
Supported file share snapshot
'New-AzRmStorageShare'
'Get-AzRmStorageShare'
'Remove-AzRmStorageShare'
Supported remove file share with it's snapshot (leased and not leased), by default
remove file share will fail when share has snapshot
'Remove-AzRmStorageShare'
Supported Set/Get/Remove blob inventory policy
'New-AzStorageBlobInventoryPolicyRule'
'Set-AzStorageBlobInventoryPolicy'
'Get-AzStorageBlobInventoryPolicy'
'Remove-AzStorageBlobInventoryPolicy'
Supported DefaultSharePermission in create/update storage account
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported AllowCrossTenantReplication in create/update storage account
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported Set Object Replication Policy with SourceAccount/DestinationAccount as
Storage account resource Id
'Set-AzStorageObjectReplicationPolicy'
Supported set SasExpirationPeriod as TimeSpan.Zero
'New-AzStorageAccount'
'Set-AzStorageAccount
Make sure the correct account name is used when create account credential
'New-AzStorageContext'
Az.StorageSync
Deprecated 'Invoke-AzStorageSyncFileRecall'
Customers should instead use 'Invoke-StorageSyncFileRecall', a cmdlet that is
shipped with the Azure File Sync agent.
Removed offline data transfer feature in 'New-AzStorageSyncServerEndpoint'.
Az.StreamAnalytics
Az.Websites
updated 'Set-AzAppServicePlan' to keep existing Tags when adding new Tags
Fixed 'Set-AzWebApp' to set the AppSettings
updated 'Set-AzWebAppSlot' to set FtpsState
Added support for StaticSites.
Az.Aks
Added support 'AcrNameToAttach' in 'Set-AzAksCluster'. [#14692]
Added support 'AcrNameToDetach' in 'Set-AzAksCluster'. [#14693]
Added 'Set-AzAksClusterCredential' to reset the ServicePrincipal of an existing AKS
cluster.
Az.Automation
Added support for User Assigned Identities and PublicNetworkAccess flag
Az.Cdn
Added cmdlets to support new AFD Premium / Standard SKUs
Az.Compute
Updated the 'Set-AzVMDiskEncryptionExtension' cmdlet to support ADE extension
migration from two pass (version with AAD input parameters) to single pass (version
without AAD input parameters).
Added a switch parameter '-Migrate' to trigger migration workflow.
Added a switch parameter '-MigrationRecovery' to trigger recovery workflow for
VMs experiencing failures after migration from two pass ADE.
Az.DataFactory
Added User Assigned Identities to Data Factory.
Updated ADF .Net SDK version to 4.18.0
Az.FrontDoor
Az.KeyVault
Fixed a bug for 'Get-AzKeyVaultSecret -IncludeVersions' when current version is
disabled [#14740]
Displayed error code and message when updating purged secret [#14800]
Az.RecoveryServices
Azure Site Recovery support for Multiple IP per NIC for Azure to Azure provider.
Azure Site Recovery support for SqlServerLicenseType for VMware to Azure and
HyperV to Azure providers.
Azure Site Recovery support for Availability set for VMware to Azure and HyperV to
Azure providers.
Azure Site Recovery support for TargetVmSize for VMware to Azure and HyperV to
Azure providers.
Azure Site Recovery support for ResourceTagging for VMware to Azure and HyperV
to Azure providers.
Azure Site Recovery support for Virtual Machine Scale Set for Azure to Azure
provider.
Added support for restoring unmanaged disks vm as managed disks.
Az.Resources
Added parameter 'ObjectType' for 'New-AzRoleAssignment'
Az.ServiceFabric
Upgraded Managed Cluster commands to use Service Fabric Managed Cluster SDK
version 1.0.0 which uses service fabric resource provider api-version 2021-05-01.
'New-AzServiceFabricManagedCluster' add parameters UpgradeCadence and
ZonalResiliency.
'New-AzServiceFabricManagedNodeType' add parameters DiskType,
VmUserAssignedIdentity, IsStateless and MultiplePlacementGroup.
'New-AzServiceFabricManagedClusterService' and 'Set-
AzServiceFabricManagedClusterService' mark parameters for deprecation:
InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName.
They are not supported.
Az.ResourceMover
Az.Storage
Az.Accounts
Fallback to first valid context if current default context key is 'Default' which is
invalid
Az.Automation
Added support for Customer Managed Key Encryption with System Assigned
Identity
Fixed issue that disables the schedule for update deployment if schedule was re-
created with same name
Az.Compute
Az.ContainerRegistry
Fixed bug in 'Get-AzContainerRegistryManifest' showing incorrect image name
Az.HDInsight
Supported getting default vmsize from backend if customer does not provide the
related parameters: '-WorkerNodeSize', '-HeadNodeSize', '-ZookeeperNodeSize', '-
EdgeNodeSize', '-KafkaManagementNodeSize'.
Az.HealthcareApis
Added support for Acr LoginServers
Az.KeyVault
Fixed a bug for 'Get-AzKeyVaultSecret -AsPlainText' if the secret is not found
[#14645]
Az.Migrate
Nullref Bug fixed in get discovered server and initialize replication infrastructure
commandlets.
Az.Monitor
Az.Resources
Added upcoming breaking change warnings on below cmdlets, because the value
of 'IdentifierUris' parameter will need verified domain.
'New-AzADApplication'
'Update-AzADApplication'
'New-AzADServicePrincipal'
'Update-AzADServicePrincipal'
Ignored Bicep warning message in error stream if exitcode equals zero.
Az.Sql
Az.Storage
Fixed copy blob fail with source context as Oauth [#14662]
'Start-AzStorageBlobCopy'
Az.StreamAnalytics
Az.Accounts
Az.DataFactory
Az.EventHub
Az.IotHub
Updated IoT Hub Management SDK and models to version 3.0.0 (api-version 2020-
03-01)
Az.KeyVault
Az.Network
Added new cmdlets to replace old product name 'virtual router' with new name
'route server' in the future.
'Get-AzRouteServerPeerAdvertisedRoute'
'Get-AzRouteServerPeerAdvertisedRoute'
Added deprecation attribute warning to the old cmdlets.
Updated 'set-azExpressRouteGateway' to allow parameter -MinScaleUnits without
specifying -MaxScaleUnits
Updated cmdlets to enable setting of VpnLinkConnectionMode on
VpnSiteLinkConnections.
'New-AzVpnSiteLinkConnection'
'Update-AzVpnConnection'
Added new cmdlet to fetch IKE Security Associations for VPN Site Link Connections.
'Get-VpnSiteLinkConnectionIkeSa'
Added new cmdlet to reset a Virtual Network Gateway Connection.
'Reset-AzVirtualNetworkGatewayConnection'
Added new cmdlet to reset a Vpn Site Link Connection.
'Reset-VpnSiteLinkConnection'
Updated cmdlets to enable setting an optional parameter -TrafficSelectorPolicies
'New-AzVpnConnection'
'Update-AzVpnConnection'
Bug fix for update vpnServerConfiguration.
Add scenarioTest for p2s multi auth VWAN.
Added multi auth feature support for VNG
'Get-AzVpnClientConfiguration'
'New-AzVirtualNetworkGateway'
'Set-AzVirtualNetworkGateway'
Az.RecoveryServices
Added Cross Zonal Restore for managed virtual machines.
Az.RedisEnterpriseCache
GA version of Az.RedisEnterpriseCache
Az.Resources
Redirected bicep message to verbose stream
Removed the logic of copying Bicep template file to temp folder.
Add support of policy exemption resource type
Fixed what-if functionality when using '-QueryString' parameter.
Normalized '-QueryString' starting with '?' for scenarios involving dynamic
parameters.
Az.ServiceBus
Az.ServiceFabric
Added parameters 'VMImagePublisher', 'VMImageOffer', 'VMImageSku',
'VMImageVersion' to 'Add-AzServiceFabricNodeType' to facilitate easy alternate OS
image creation for new node type.
Added parameter 'IsPrimaryNodeType' to 'Add-AzServiceFabricNodeType' to be
able to create an additional primary node type, for the purpose of transitioning the
primary node type to another one in the case of OS migration.
'Add-AzServiceFabricNodeType' now correctly copies the LinuxDiagnostic extension.
This was previously not working for Linux.
'Add-AzServiceFabricNodeType' now correctly copies the RDP/SSH load balancer
inbound NAT port mapping to the new node type.
Added template for 'UbuntuServer1804' for creating Ubuntu 18.04 clusters using
'New-AzServiceFabricCluster'.
'Remove-AzServiceFabricNodeType' was incorrectly blocking Bronze durability node
types for removal, and this has been updated to only block when the Bronze
durability level differs between the SF node type and VMSS setting.
Added cmdlet 'Update-AzServiceFabricVmImage' to update the delivered SF
runtime package type. This must be changed when migrating from Ubuntu 16 to 18.
Added cmdlet 'Update-AzServiceFabricNodeType' to update the properties of a
cluster node type. For now this is solely used to update whether the node type is
primary via bool parameter '-IsPrimaryNodeType False'.
'Update-AzServiceFabricReliability' is now able to update reliability level when the
cluster has more than one primary node type. To do this, the name of the node type
is supplied via the new -NodeType parameter.
Added new cmdlets for managed applications:
'New-AzServiceFabricManagedClusterApplication'
'Get-AzServiceFabricManagedClusterApplication'
'Set-AzServiceFabricManagedClusterApplication'
'Remove-AzServiceFabricManagedClusterApplication'
'New-AzServiceFabricManagedClusterApplicationType'
'Get-AzServiceFabricManagedClusterApplicationType'
'Set-AzServiceFabricManagedClusterApplicationType'
'Remove-AzServiceFabricManagedClusterApplicationType'
'New-AzServiceFabricManagedClusterApplicationTypeVersion'
'Get-AzServiceFabricManagedClusterApplicationTypeVersion'
'Set-AzServiceFabricManagedClusterApplicationTypeVersion'
'Remove-AzServiceFabricManagedClusterApplicationTypeVersion'
'New-AzServiceFabricManagedClusterService'
'Get-AzServiceFabricManagedClusterService'
'Set-AzServiceFabricManagedClusterService'
'Remove-AzServiceFabricManagedClusterService'
Upgraded Managed Cluster commands to use Service Fabric Managed Cluster SDK
version 1.0.0-beta.1 which uses service fabric resource provider api-version 2021-
01-01-preview.
Az.Sql
Added cmdlet 'New-AzSqlServerTrustGroup'
Added cmdlet 'Remove-AzSqlServerTrustGroup'
Added cmdlet 'Get-AzSqlServerTrustGroup'
Az.Storage
Fixed an issue that list account from resource group won't use nextlink
'Get-AzStorageAccount'
Supported ChangeFeedRetentionInDays when Enable ChangeFeed on Blob service
'Update-AzStorageBlobServiceProperty'
Az.Websites
Updated 'Add-AzWebAppAccessRestrictionRule' to allow all supported Service Tags
and validate against Service Tag API.
Az.Accounts
Upgrade Azure.Identity to fix the issue that Connect-AzAccount fails when ADFS
credential is used [#13560]
Az.Automation
Az.ContainerRegistry
Fixed authentication for Connect-AzContainerRegistry
Az.CosmosDB
Introduced NetworkAclBypass and NetworkAclBypassResourceIds for Database
Account cmdlets.
Introduced ServerVersion parameter to Update-AzCosmosDBAccount.
Introduced BackupInterval and BackupRetention for Database Account cmdlets
Az.DataFactory
Updated ADF .Net SDK version to 4.14.0
Az.Migrate
Az.Migrate GA
Incorporated Initialize-AzMigrateReplicationInfrastructure as a cmdlet in the
Az.Migrate module, from the external script that is run currently today.
Made some parameters of New-AzMigrateServerReplication, New-
AzMigrateDiskMapping case insensitive.
Added support for scale appliance change, to handle new V3 keys.
Az.RecoveryServices
Added null check for target storage account in FileShare restore.
Az.Resources
Added support for Azure resources deployment in Bicep language
Fixed issues with TemplateSpec deployments in 'New-AzTenantDeployment' and
'New-AzManagementGroupDeployment'
Added support for '-QueryString' parameter in 'Test-Az*Deployments' cmdlets
Fixed issue with dynamic parameters when 'New-Az*Deployments' is used with '-
QueryString'
Added support for '-TemplateParameterObject' parameter while using '-
TemplateSpecId' parameter in 'New-Az*Deployments' cmdlets
Fixed the inaccurate error message received on trying to deploy a non-existent
template spec
Az.Storage
Az.Websites
Az.Accounts
Az.Aks
Az.Automation
Fixed the issue of processing 'PSCustomObject' and 'Array'.
Az.Compute
Added parameter '-EnableAutomaticUpgrade' to 'Set-AzVmExtension' and 'Add-
AzVmssExtension'.
Removed FilterExpression parameter from 'Get-AzVMImage' cmdlet documentation.
Added deprecation message to the ContainerService cmdlets:
'Add-AzureRmContainerServiceAgentPoolProfileCommand'
'Get-AzContainerService'
'New-AzContainerService'
'New-AzContainerServiceConfig'
'Remove-AzContainerService'
'Remove-AzContainerServiceAgentPoolProfile'
'Update-AzContainerService'
Added parameter '-BurstingEnabled' to 'New-AzDiskConfig' and 'New-
AzDiskUpdateConfig'
Added '-GroupByApplicationId' and '-GroupByUserAgent' parameters to the
'Export-AzLogAnalyticThrottledRequest' and 'Export-
AzLogAnalyticRequestRateByInterval' cmdlets.
Added 'VMParameterSet' parameter set to 'Get-AzVMExtension' cmdlet. Added new
parameter '-VM' to this parameter set.
Az.ContainerRegistry
Added cmdlets to supported repository, manifest, and tag operations:
'Get-AzContainerRegistryRepository'
'Update-AzContainerRegistryRepository'
'Remove-AzContainerRegistryRepository'
'Get-AzContainerRegistryManifest'
'Update-AzContainerRegistryManifest'
'Remove-AzContainerRegistryManifest'
'Get-AzContainerRegistryTag'
'Update-AzContainerRegistryTag'
'Remove-AzContainerRegistryTag'
Az.Databricks
Supported -EnableNoPublicIP when creating a Databricks workspace
Az.FrontDoor
Added FrontDoorId to properties
Added JSON Exclusions and RequestBodyCheck support to managed rules
Az.HDInsight
Added new parameter '-EnableComputeIsolation' and '-ComputeIsolationHostSku'
to the cmdlet 'New-AzHDInsightCluster' to support compute isolation feature
Added property 'ComputeIsolationProperties' and 'ConnectivityEndpoints' in the
class AzureHDInsightCluster.
Az.KeyVault
Supported specifying key type and curve name when importing keys via a BYOK file
Az.Network
Added new cmdlets to replace old product name 'virtual router' with new name
'route server' in the future.
'New-AzRouteServer'
'Get-AzRouteServer'
'Remove-AzRouteServer'
'Update-AzRouteServer'
'Get-AzRouteServerPeer'
'Add-AzRouteServerPeer'
'Update-AzRouteServerPeer'
'Remove-AzRouteServerPeer'
Added deprecation attribute warning to the old cmdlets.
Bug fix in ExpressRouteLink MacSecConfig. Added new property 'SciState' to
'PSExpressRouteLinkMacSecConfig'
Updated format list and format table views for Get-
AzVirtualNetworkGatewayConnectionIkeSa
Az.PolicyInsights
Retracted changes made in powershell that increased request row limit. Removed
incorrect statement of supporting paging
Az.RecoveryServices
modified policy validation limits as per backup service.
Added Zone Redundancy for Recovery Service Vaults.
Azure Site Recovery support for Proximity placement group for VMware to Azure
and HyperV to Azure providers.
Azure Site Recovery support for Availability zone for VMware to Azure and HyperV
to Azure providers.
Azure Site Recovery support for UseManagedDisk for HyperV to Azure provider
Az.Resources
Az.Sql
Az.Storage
Supported RoutingPreference settings in create/update Storage account
'New-AzStorageAccount'
'Set-AzStorageAccount'
Upgraded Azure.Storage.Blobs to 12.8.0
Upgraded Azure.Storage.Files.Shares to 12.6.0
Upgraded Azure.Storage.Files.DataLake to 12.6.0
Az.Websites
Az.Accounts
Az.Automation
Fixed issue where description was not populated for update management schedules
Az.CosmosDB
General availability of 'Az.CosmosDB' module
Restricting New-AzCosmosDBAccount cmdlet to make update calls to existing
Database Accounts.
Introducing AnalyticalStorageTTL in SqlContainer.
Az.IotHub
Az.LogicApp
Az.Monitor
Added cmdlets for data collection rules:
'Get-AzDataCollectionRule'
'New-AzDataCollectionRule'
'Set-AzDataCollectionRule'
'Update-AzDataCollectionRule'
'Remove-AzDataCollectionRule'
Added cmdlets for data collection rules associations
'Get-AzDataCollectionRuleAssociation'
'New-AzDataCollectionRuleAssociation'
'Remove-AzDataCollectionRuleAssociation'
Az.Network
Az.RecoveryServices
Az.Resources
Added support for -QueryString parameter in New-Az*Deployments cmdlets
Az.Sql
Made 'Start-AzSqlInstanceDatabaseLogReplay' cmdlet synchronous, added -AsJob
flag
Az.Storage
Fix ContinuationToken never null when list blob with -IncludeVersion
'Get-AzStorageBlob'
Az.Websites
Added support for App Service Managed certificates
'New-AzWebAppCertificate'
'Remove-AzWebAppCertificate'
Fixed issue that causes Docker Password to be removed from appsettings in 'Set-
AzWebApp' and 'Set-AzWebAppSlot'
Az.Accounts
Fixed the issue that Http proxy is not respected in Windows PowerShell [#13647]
Improved debug log of long running operations in generated modules
Az.Automation
Fixed issue that parameters of 'Start-AzAutomationRunbook' cannot convert
PSObject wrapped string to JSON string [#13240]
Fixed location completer for New-AzAutomationUpdateManagementAzureQuery
cmdlet
Az.Compute
New parameter 'VM' in new parameter set 'VMParameterSet' added to 'Get-
AzVMDscExtensionStatus' and 'Get-AzVMDscExtension' cmdlets.
Edited 'New-AzSnapshot' cmdlet to check for existing snapshot with the same name
in the same resource group.
Throws an error if a duplicate snapshot exists.
Az.Databricks
Fixed an issue that may cause 'New-AzDatabricksVNetPeering' to return before it is
fully provisioned (https://github.com/Azure/autorest.powershell/issues/610 )
Az.DataFactory
Fixed the command 'Invoke-AzDataFactoryV2Pipeline' for SupportsShouldProcess
issue
Az.DesktopVirtualization
Az.HDInsight
Az.KeyVault
Added a new parameter '-AsPlainText' to 'Get-AzKeyVaultSecret' to directly return
the secret in plain text [#13630]
Supported selective restore a key from a managed HSM full backup [#13526]
Fixed some minor issues [#13583] [#13584]
Added missing return objects of 'Get-Secret' in SecretManagement module
Fixed an issue that may cause vault to be created without default access policy
[#13687]
Az.Kusto
Updated API version to 2020-09-18.
Az.Network
Fixed issue in remove peering and connection cmdlet for ExpressRouteCircuit
scenario
'Remove-AzExpressRouteCircuitPeeringConfig' and 'Remove-
AzExpressRouteCircuitConnectionConfig'
Az.PolicyInsights
Added support for returning paginated results for Get-AzPolicyState
Az.RecoveryServices
Az.Resources
Fixed a NullRef exception issue in 'New-AzureManagedApplication' and 'Set-
AzureManagedApplication'.
Updated Azure Resource Manager SDK to use latest DeploymentScripts GA api-
version: 2020-10-01.
Az.ServiceFabric
Fixed 'Add-AzServiceFabricNodeType'. Added node type to service fabric cluster
before creating virtual machine scale set.
Az.Sql
Az.Storage
Supported create/update/get/list EncryptionScope of a Storage account
'New-AzStorageEncryptionScope'
'Update-AzStorageEncryptionScope'
'Get-AzStorageEncryptionScope'
Supported create container and upload blob with Encryption Scope setting
'New-AzRmStorageContainer'
'New-AzStorageContainer'
'Set-AzStorageBlobContent'
Az.Accounts
Managed to parse ExpiresOn time from raw token if could not get from underlying
library
Improved warning message if Interactive authentication is unavailable
Az.ApiManagement
[Breaking change] 'New-AzApiManagementProduct' by default has no subscription
limit.
Az.Compute
Edited Get-AzVm to filter by '-Name' prior to checking for throttling due to too
many resources.
New cmdlet 'Start-AzVmssRollingExtensionUpgrade'.
Az.ContainerRegistry
Supported parameter 'Name' for and value from pipeline input for 'Get-
AzContainerRegistryUsage' [#13605]
Polished exceptions for 'Connect-AzContainerRegistry'
Az.DataFactory
Updated ADF .Net SDK version to 4.13.0
Az.HealthcareApis
Added support for customer managed keys
Az.IotHub
Fixed an issue of SAS token.
Az.KeyVault
Supported 'all' as an option when setting key vault access policies
Supported new version of SecretManagement module [#13366]
Supported ByteArray, String, PSCredential and Hashtable for 'SecretValue' in
SecretManagementModule [#12190]
[Breaking change] redesigned the API surface of cmdlets related to managed HSM.
Az.Monitor
Az.RecoveryServices
Made help text and parameter set name changes to 'Restore-
AzRecoveryServicesBackupItem' cmdlet.
Az.Resources
Az.ServiceFabric
Az.Sql
Added SecondaryType to the following:
'New-AzSqlDatabase'
'Set-AzSqlDatabase'
'New-AzSqlDatabaseSecondary'
Added HighAvailabilityReplicaCount to the following:
'New-AzSqlDatabase'
'Set-AzSqlDatabase'
Made ReadReplicaCount an alias of HighAvailabilityReplicaCount in the following:
'New-AzSqlDatabase'
'Set-AzSqlDatabase'
Az.Storage
Az.Websites
Az.Accounts
Fixed an issue that TenantId may be not respected if using 'Connect-AzAccount -
DeviceCode'[#13477]
Added new cmdlet 'Get-AzAccessToken'
Fixed an issue that error happens if user profile path is inaccessible
Fixed an issue causing Write-Object error during Connect-AzAccount [#13419]
Added parameter 'ContainerRegistryEndpointSuffix' to: 'Add-AzEnvironment', 'Set-
AzEnvironment'
Supported interrupting login by hitting CTRL + C
Az.AppConfiguration
General availability of 'Az.AppConfiguration' module
Az.DataFactory
Improved error message of 'New-
AzDataFactoryV2LinkedServiceEncryptedCredential' command
Az.DataLakeStore
Az.DesktopVirtualization
Added new MSIX Package cmdlets and updated Applications cmdlets.
Az.EventHub
Fixed Cluster commands for EventHub cluster without tags
Updated help text for PartnerNamespace of AzEventHubGeoDRConfiguration
commands
Az.HDInsight
Add parameters 'ResourceProviderConnection' and 'PrivateLink' to cmdlet 'New-
AzHDInsightCluster' to support relay outbound and private link feature
Add parameter 'AmbariDatabase' to cmdlet 'New-AzHDInsightCluster' to support
custom Ambari database feature
Add accept value 'AmbariDatabase' to the parameter 'MetastoreType' of the cmdlet
'Add-AzHDInsightMetastore'
Az.IotHub
Allowed tags in IoT Hub create cmdlet.
Az.KeyVault
Supported updating key vault tag
Az.LogicApp
Fixed for Get-AzLogicAppRunHistory only retrieving the first page of results
Az.Network
Updated below cmdlet
'New-AzLoadBalancerFrontendIpConfigCommand', 'Set-
AzLoadBalancerFrontendIpConfigCommand', 'Add-
AzLoadBalancerFrontendIpConfigCommand':
Added PublicIpAddressPrefix property
Added PublicIpAddressPrefixId property
Added new properties to the following cmdlets to allow for global load balancing
'New-AzLoadBalancer':
Added Sku Tier property
'New-AzPuplicIpAddress':
Added Sku Tier property
'New-AzPublicIpPrefix':
Added Sku Tier property
'New-AzLoadBalancerBackendAddressConfig':
Added LoadBalancerFrontendIPConfigurationId property
Updated planning to deprecate warnings for the following cmdlets
-'New-
AzVirtualHubRoute'
-'New-AzVirtualHubRouteTable'
-'Add-AzVirtualHubRoute'
-
'Add-AzVirtualHubRouteTable'
-'Get-AzVirtualHubRouteTable'
-'Remove-
AzVirtualHubRouteTable'
Added planning to deprecate warnings on the argument 'RouteTable' for the
following cmdlets
-'New-AzVirtualHub'
-'Set-AzVirtualHub'
-'Update-AzVirtualHub'
Made arguments '-MinScaleUnits' and '-MaxScaleUnits' optional in 'Set-
AzExpressRouteGateway'
Added new cmdlets to support Mutual Authentication and SSL Profiles on
Application Gateway
'Get-AzApplicationGatewayClientAuthConfiguration'
'New-AzApplicationGatewayClientAuthConfiguration'
'Remove-AzApplicationGatewayClientAuthConfiguration'
'Set-AzApplicationGatewayClientAuthConfiguration'
'Add-AzApplicationGatewayTrustedClientCertificate'
'Get-AzApplicationGatewayTrustedClientCertificate'
'New-AzApplicationGatewayTrustedClientCertificate'
'Remove-AzApplicationGatewayTrustedClientCertificate'
'Set-AzApplicationGatewayTrustedClientCertificate'
'Add-AzApplicationGatewaySslProfile'
'Get-AzApplicationGatewaySslProfile'
'New-AzApplicationGatewaySslProfile'
'Remove-AzApplicationGatewaySslProfile'
'Set-AzApplicationGatewaySslProfile'
'Get-AzApplicationGatewaySslProfilePolicy'
'Remove-AzApplicationGatewaySslProfilePolicy'
'Set-AzApplicationGatewaySslProfilePolicy'
Az.RecoveryServices
Specifying policy BackupTime is in UTC.
Modifying breaking change warning in Get-AzRecoveryServicesBackupJobDetails
cmdlet.
Updating sample script help text for Set-AzRecoveryServicesBackupProtectionPolicy
cmdlet.
Az.Resources
Fixed an issue where What-If shows two resource group scopes with different casing
Updated 'Export-AzResourceGroup' to use the SDK.
Added culture info to parse methods
Az.Sql
Az.Websites
Added support for new access restriction features: ServiceTag, multi-ip and http-
headers
Thanks to our community contributors
John Q. Martin (@johnmart82), Adding firewall prerequisite information (#13385)
Manikandan Duraisamy (@madurais-msft), Corrected the PublicSubnetName
argument (#13417)
@mahortas, Update for -HostNames parameter values (#13349)
@MariachiForHire, added supported TrafficAnalyticsInterval values (#13304)
Michael James (@mikejwhat), Allow Get-AzLogicAppRunHistory to return more than
30 entries (#13393)
Shashikant Shakya (@shshakya), Update Restore-AzSqlInstanceDatabase.md
(#13404)
Az.Accounts
[Breaking Change] Removed 'Get-AzProfile' and 'Select-AzProfile'
Replaced Azure Directory Authentication Library with Microsoft Authentication
Library(MSAL)
Az.Aks
[Breaking Change] Removed parameter alias 'ClientIdAndSecret' in 'New-
AzAksCluster' and 'Set-AzAksCluster'.
[Breaking Change] Changed the default value of 'NodeVmSetType' in 'New-
AzAksCluster' from 'AvailabilitySet' to 'VirtualMachineScaleSets'.
[Breaking Change] Changed the default value of 'NetworkPlugin' in 'New-
AzAksCluster' from 'None' to 'azure'.
[Breaking Change] Removed parameter 'NodeOsType' in 'New-AzAksCluster' as it
supports only one value Linux.
Az.Billing
Az.CognitiveServices
Az.Compute
Az.ContainerRegistry
[Breaking Change] Updates API version to 2019-05-01
[Breaking Change] Removed SKU 'Classic' and parameter 'StorageAccountName'
from 'New-AzContainerRegistry'
Added New cmdlets: 'Connect-AzContainerRegistry', 'Import-AzContainerRegistry',
'Get-AzContainerRegistryUsage', 'New-AzContainerRegistryNetworkRule', 'Set-
AzContainerRegistryNetworkRule'
Added new parameter 'NetworkRuleSet' to 'Update-AzContainerRegistry'
Az.Databricks
Az.DataFactory
Updated ADF .Net SDK version to 4.12.0
Updated ADF encryption client SDK version to 4.14.7587.7
Added 'Stop-AzDataFactoryV2TriggerRun' and 'Invoke-AzDataFactoryV2TriggerRun'
commands
Az.DesktopVirtualization
Require Location property for creating top level arm objects.
* Made
ApplicationGroupType required for New-AzWvdApplicationGroup .
* Made
Az.Functions
[Breaking Change] Removed 'IncludeSlot' switch parameter from all but one
parameter set of 'Get-AzFunctionApp'. The cmdlet now supports retrieving
deployment slots in the results when '-IncludeSlot' is specified.
Updated 'New-AzFunctionApp':
Fixed -DisableApplicationInsights so that no application insights project is
created when this option is specified. [#12728]
[Breaking Change] Removed support to create PowerShell 6.2 function apps.
[Breaking Change] Changed the default runtime version in Functions version 3 on
Windows for PowerShell function apps from 6.2 to 7.0 when the RuntimeVersion
parameter is not specified.
[Breaking Change] Changed the default runtime version in Functions version 3 on
Windows and Linux for Node function apps from 10 to 12 when the
RuntimeVersion parameter is not specified.
[Breaking Change] Changed the default runtime version in Functions version 3 on
Linux for Python function apps from 3.7 to 3.8 when the RuntimeVersion
parameter is not specified.
Az.HDInsight
For New-AzHDInsightCluster cmdlet:
Replaced parameter 'DefaultStorageAccountName' with
'StorageAccountResourceId'
Replaced parameter 'DefaultStorageAccountKey' with 'StorageAccountKey'
Replaced parameter 'DefaultStorageAccountType' with 'StorageAccountType'
Removed parameter 'PublicNetworkAccessType'
Removed parameter 'OutboundPublicNetworkAccessType'
Added new parameters: 'StorageFileSystem' and
'StorageAccountManagedIdentity' to support ADLSGen2
Added new parameter 'EnableIDBroker' to Support HDInsight ID Broker
Added new parameters: 'KafkaClientGroupId', 'KafkaClientGroupName' and
'KafkaManagementNodeSize' to support Kafka Rest Proxy
For New-AzHDInsightClusterConfig cmdlet:
Replaced parameter 'DefaultStorageAccountName' with
'StorageAccountResourceId'
Replaced parameter 'DefaultStorageAccountKey' with 'StorageAccountKey'
Replaced parameter 'DefaultStorageAccountType' with 'StorageAccountType'
Removed parameter 'PublicNetworkAccessType'
Removed parameter 'OutboundPublicNetworkAccessType'
For Set-AzHDInsightDefaultStorage cmdlet:
Replaced parameter 'StorageAccountName' with 'StorageAccountResourceId'
For Add-AzHDInsightSecurityProfile cmdlet:
Replaced parameter 'Domain' with 'DomainResourceId'
Removed the mandatory requirement for parameter 'OrganizationalUnitDN'
Az.KeyVault
[Breaking Change] Deprecated parameter DisableSoftDelete in 'New-AzKeyVault'
and EnableSoftDelete in 'Update-AzKeyVault'
[Breaking Change] Removed attribute SecretValueText to avoid displaying
SecretValue directly [#12266]
Supported new resource type: managed HSM
CRUD of managed HSM and cmdlets to operate keys on managed HSM
Full HSM backup/restore, AES key creation, security domain backup/restore,
RBAC
Az.ManagedServices
[Breaking Change] Updated parameters naming conventions and associated
examples
Az.Network
Az.RecoveryServices
Fixing Workload Restore for contributor permissions.
Added new parameter sets and validations for Restore-
AzRecoveryServicesBackupItem cmdlet.
Az.Resources
Fixed parsing bug
Updated ARM template What-If cmdlets to remove preview message from results
Fixed an issue where template deployment cmdlets crash if '-WhatIf' is set at a
higher scope [#13038]
Fixed an issue where template deployment cmdlets does not preserve case for
template parameters
Added a default API version to be used in 'Export-AzResourceGroup' cmdlet
Added cmdlets for Template Specs ('Get-AzTemplateSpec', 'Set-AzTemplateSpec',
'New-AzTemplateSpec', 'Remove-AzTemplateSpec', 'Export-AzTemplateSpec')
Added support for deploying Template Specs using existing deployment cmdlets
(via the new -TemplateSpecId parameter)
Updated 'Get-AzResourceGroupDeploymentOperation' to use the SDK.
Removed '-ApiVersion' parameter from '*-AzDeployment' cmdlets.
Az.Sql
Added DiffBackupIntervalInHours to 'Set-
AzSqlDatabaseBackupShortTermRetentionPolicy'
Fixed issue where New-AzSqlDatabaseExport fails if networkIsolation not specified
[#13097]
Fixed issue where New-AzSqlDatabaseExport and New-AzSqlDatabaseImport were
not returning OperationStatusLink in the result object [#13097]
Update Azure Paired Regions URL in Backup Storage Redundancy Warnings
Az.Storage
Removed obsolete property RestorePolicy.LastEnabledTime
'Enable-AzStorageBlobRestorePolicy'
'Disable-AzStorageBlobRestorePolicy'
'Get-AzStorageBlobServiceProperty'
'Update-AzStorageBlobServiceProperty'
Change Type of DaysAfterModificationGreaterThan from int to int?
'Set-AzStorageAccountManagementPolicy'
'Get-AzStorageAccountManagementPolicy'
'Add-AzStorageAccountManagementPolicyAction'
'New-AzStorageAccountManagementPolicyRule'
Supported create/update file share with access tier
'New-AzRmStorageShare'
'Update-AzRmStorageShare'
Supported set/update/remove Acl recursively on Datalake Gen2 item
'Set-AzDataLakeGen2AclRecursive'
'Update-AzDataLakeGen2AclRecursive'
'Remove-AzDataLakeGen2AclRecursive'
Supported Container access policy with new permission x,t
'New-AzStorageContainerStoredAccessPolicy'
'Set-AzStorageContainerStoredAccessPolicy'
Changed the output of get/set Container access policy cmdlet, by change the child
property Permission type from enum to String
'Get-AzStorageContainerStoredAccessPolicy'
'Set-AzStorageContainerStoredAccessPolicy'
Fixed a sample script issue of set management policy with json
'Set-AzStorageAccountManagementPolicy'
Az.Websites
Added support for Premium V3 pricing tier
Updated the WebSites SDK to 3.1.0
Az.Accounts
Fixed DateTime parse issue in common libraries [#13045]
Az.CognitiveServices
Added 'New-AzCognitiveServicesAccountApiProperty' cmdlet.
Supported 'ApiProperty' parameter for 'New-AzCognitiveServicesAccount' and 'Set-
AzCognitiveServicesAccount'
Az.Compute
Fixed issue in 'Update-ASRRecoveryPlan' by populating FailoverTypes
Added the '-Top' and '-OrderBy' optional parameters to the 'Get-AzVmImage'
cmdlet.
Az.Databricks
Az.DataFactory
Fixed typo in output messages
Az.EventHub
Added optional switch parameter 'TrustedServiceAccessEnabled' to 'Set-
AzEventHubNetworkRuleSet' cmdlet
Az.HDInsight
Added warning message for planning to deprecate the parameters
'PublicNetworkAccessType' and 'OutboundPublicNetworkAccessType'
Added warning message for planning to replace the parameter
'DefaultStorageAccountName' with 'StorageAccountResourceId'
Added warning message for planning to replace the parameter
'DefaultStorageAccountKey' with 'StorageAccountKey'
Added warning message for planning to replace the parameter
'DefaultStorageAccountType' with 'StorageAccountType'
Added warning message for planning to replace the parameter
'DefaultStorageContainer' with 'StorageContainer'
Added warning message for planning to replace the parameter
'DefaultStorageRootPath' with 'StorageRootPath'
Az.IotHub
Az.KeyVault
Az.ManagedServices
Az.Monitor
Fixed the bug that warning message cannot be suppressed. [#12889]
Supported 'SkipMetricValidation' parameter in alert rule criteria. Allows creating an
alert rule on a custom metric that isn't yet emitted, by causing the metric validation
to be skipped.
Az.Network
Added Office365 Policy to VPNSite Resource
'New-AzO365PolicyProperty'
Az.RecoveryServices
Added container name validation for workload backup.
Az.RedisCache
Made 'New-AzRedisCache' and 'Set-AzRedisCache' cmdlets not fail because of
permission issue related to registering Microsoft.Cache RP
Az.Sql
Az.Storage
Supported enable/disable/get share soft delete properties on file Service of a
Storage account
'Update-AzStorageFileServiceProperty'
'Get-AzStorageFileServiceProperty'
Supported list file shares include the deleted ones of a Storage account, and Get
single file share usage
'Get-AzRmStorageShare'
Supported restore a deleted file share
'Restore-AzRmStorageShare'
Changed the cmdlets for modify blob service properties, won't get the original
properties from server, but only set the modified properties to server.
'Enable-AzStorageBlobDeleteRetentionPolicy'
'Disable-AzStorageBlobDeleteRetentionPolicy'
'Enable-AzStorageBlobRestorePolicy'
'Disable-AzStorageBlobRestorePolicy'
'Update-AzStorageBlobServiceProperty'
Fixed help issue for New-AzStorageAccount parameter -Kind default value [#12189]
Fixed issue by add example to show how to set correct ContentType in blob upload
[#12989]
Az.Accounts
Formatted the upcoming breaking change messages
Updated Azure.Core to 1.4.1
Az.Aks
Added client side parameter validation logic for 'New-AzAksCluster', 'Set-
AzAksCluster' and 'New-AzAksNodePool'. [#12372]
Added support for add-ons in 'New-AzAksCluster'. [#11239]
Added cmdlets 'Enable-AzAksAddOn' and 'Disable-AzAksAddOn' for add-ons.
[#11239]
Added parameter 'GenerateSshKey' for 'New-AzAksCluster'. [#12371]
Updated api version to 2020-06-01.
Az.CognitiveServices
Az.Compute
Az.DataFactory
Updated ADF .Net SDK version to 4.11.0
Az.EventHub
Added new Cluster cmdlets - 'New-AzEventHubCluster', 'Set-AzEventHubCluster',
'Get-AzEventHubCluster', 'Remove-AzEventHubCluster', 'Get-
AzEventHubClustersAvailableRegions'.
Fixed for issue #10722 : Fix for assigning only 'Listen' to AuthorizationRule rights.
Az.Functions
Removed the ability to create v2 Functions in regions that do not support it.
Deprecated PowerShell 6.2. Added a warning for when a user creates a PowerShell
6.2 function app that advises them to create a PowerShell 7.0 function app instead.
Az.HDInsight
Supported creating cluster with Autoscale configuration
Add new parameter 'AutoscaleConfiguration' to the cmdlet 'New-
AzHDInsightCluster'
Supported operating cluster's Autoscale configuration
Add new cmdlet 'Get-AzHDInsihgtClusterAutoscaleConfiguration'
Add new cmdlet 'New-AzHDInsihgtClusterAutoscaleConfiguration'
Add new cmdlet 'Set-AzHDInsihgtClusterAutoscaleConfiguration'
Add new cmdlet 'Remove-AzHDInsihgtClusterAutoscaleConfiguration'
Add new cmdlet 'New-AzHDInsihgtClusterAutoscaleScheduleCondition'
Az.KeyVault
Added support for RBAC authorization [#10557]
Enhanced error handling in 'Set-AzKeyVaultAccessPolicy' [#4007]
Az.Kusto
Az.Network
[Breaking Change] Updated below cmdlets to align resource virtual router and
virtual hub
'New-AzVirtualRouter':
Added -HostedSubnet parameter to support IP configuration child resource
deleted -HostedGateway and -HostedGatewayId
'Get-AzVirtualRouter':
Added subscription level parameter set
'Remove-AzVirtualRouter'
'Add-AzVirtualRouterPeer'
'Get-AzVirtualRouterPeer'
'Remove-AzVirtualRouterPeer'
Added new cmdlet for Azure Express Route Port
'New-AzExpressRoutePortLOA'
Added RemoteBgpCommunities property to the VirtualNetwork Peering Resource
Modified the warning message for 'New-AzLoadBalancerFrontendIpConfig', 'New-
AzPublicIpAddress' and 'New-AzPublicIpPrefix'.
Added VpnGatewayIpConfigurations to 'Get-AzVpnGateway' output
Fixed bug for 'Set-AzApplicationGatewaySslCertificate' [#9488]
Added 'AllowActiveFTP' parameter to 'AzureFirewall'
Updated below commands for feature: Enable internet security set/remove on
VirtualWan P2SVpnGateway.
Az.RecoveryServices
Az.Resources
Az.ServiceFabric
Az.Sql
Added BackupStorageRedundancy to 'New-AzSqlInstance' and 'Get-AzSqlInstance'
Added cmdlet 'Get-AzSqlServerActiveDirectoryOnlyAuthentication'
Added cmdlet 'Enable-AzSqlServerActiveDirectoryOnlyAuthentication'
Added Force parameter to 'New-AzSqlInstance'
Added cmdlets for Managed Database Log Replay service
'Start-AzSqlInstanceDatabaseLogReplay'
'Get-AzSqlInstanceDatabaseLogReplay'
'Complete-AzSqlInstanceDatabaseLogReplay'
'Stop-AzSqlInstanceDatabaseLogReplay'
Added cmdlet 'Get-AzSqlInstanceActiveDirectoryOnlyAuthentication'
Added cmdlet 'Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication'
Added cmdlet 'Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication'
Updated cmdlets 'New-AzSqlDatabaseImport' and 'New-AzSqlDatabaseExport' to
support network isolation functionality
Added cmdlet 'New-AzSqlDatabaseImportExisting'
Updated Databases cmdlets to support backup storage type specification
Added Force parameter to 'New-AzSqlDatabase'
Added warning for BackupStorageRedundancy configuration in select regions in
'New-AzSqlDatabase'
Updated ActiveDirectoryOnlyAuthentication cmdlets for server and instance to
include ResourceId and InputObject
Az.Storage
Fixed upload blob fail by upgrade to Microsoft.Azure.Storage.DataMovement 2.0.0
[#12220]
Supported Point In Time Restore
'Enable-AzStorageBlobRestorePolicy'
'Disable-AzStorageBlobRestorePolicy'
'New-AzStorageBlobRangeToRestore'
'Restore-AzStorageBlobRange'
Supported get blob restore status of Storage account by run get-
AzureRMStorageAccount with parameter -IncludeBlobRestoreStatus
'Get-AzureRMStorageAccount'
Added breaking change warning message for upcoming cmdlet output change
'Get-AzStorageContainerStoredAccessPolicy'
'Set-AzStorageContainerStoredAccessPolicy'
'Set-AzStorageAccountManagementPolicy'
'Get-AzStorageAccountManagementPolicy'
'Add-AzStorageAccountManagementPolicyAction'
'New-AzStorageAccountManagementPolicyRule'
Upgraded Microsoft.Azure.Cosmos.Table SDK to 1.0.8
Az.Compute
Patched '-EncryptionAtHost' parameter in 'New-AzVm' to remove default value of
false [#12776]
Az.Accounts
Loaded all public cloud environments when discovery endpoint doesn't return
default AzureCloud or other public environments [#12633]
Exposed SubscriptionPolicies in 'Get-AzSubscription' [#12551]
Az.Automation
Added '-RunOn' parameters to 'Set-AzAutomationWebhook' to specify a Hybrid
Worker Group
Az.Compute
Az.DataFactory
Added missing properties to PSPipelineRun class.
Az.HDInsight
Supported creating cluster with encryption at host feature.
Az.KeyVault
Added warning messages for planning to disable soft delete
Added warning messages for planning to remove attribute SecretValueText
Az.Maintenance
Added optional schedule related fields to 'New-AzMaintenanceConfiguration'
Added new cmdlet for 'Get-AzMaintenancePublicConfiguration'
Az.ManagedServices
Az.Resources
Az.SignalR
Fixed 'Restart-AzSignalR' and 'Update-AzSignalR' help files errors
Added cmdlets 'Update-AzSignalRNetworkAcl', 'Set-AzSignalRUpstream'
Az.Storage
Az.Accounts
Az.Aks
Az.ApiManagement
Az.CognitiveServices
Az.FrontDoor
Fixed an issue where an exception is being thrown when Enum.Parse tries to coerce
a null value to an Enabled or Disabled enum values [#12344]
Az.HDInsight
Supported creating cluster with encryption in transit feature.
Add new parameter 'EncryptionInTransit' to the cmdlet 'New-AzHDInsightCluster'
Add new parameter 'EncryptionInTransit' to the cmdlet 'New-
AzHDInsightClusterConfig'
Supported creating cluster with private link feature:
Add new parameter 'PublicNetworkAccessType' and
'OutboundPublicNetworkAccessType' to the cmdlet 'New-AzHDInsightCluster'
Add new parameter 'PublicNetworkAccessType' and
'OutboundPublicNetworkAccessType' to the cmdlet 'New-
AzHDInsightClusterConfig'
Returned virtual network information when calling 'New-AzHDInsightCluster' or
'Get-AzHDInsightCluster'
Az.Network
Az.OperationalInsights
Added '-ForceDelete' option for 'Remove-AzOperationalInsightsworkspace'
Added new cmdlet 'Get-AzOperationalInsightsDeletedWorkspace'
Added new cmdlet 'Restore-AzOperationalInsightsWorkspace'
Az.RecoveryServices
Az.Resources
Az.Sql
Fixed potential server name case insensitive error in 'New-AzSqlServer' and 'Set-
AzSqlServer'
Fixed wrong database name returned on existing database error in 'New-
AzSqlDatabaseSecondary'
Az.Storage
Az.Accounts
Az.Aks
Fixed bug 'Get-AzAks' doesn't get all clusters [#12296]
Az.AnalysisServices
Removed project reference to Authentication
Az.Automation
Fixed the issue that string with escape chars cannot be converted into json object.
Az.Compute
Added warning when using 'New-AzVmss' without 'latest' image version
Az.DataFactory
Added global parameters to Data Factory.
Az.EventGrid
Updated to use the 2020-06-01 API version.
Added new features:
Input mapping
Event Delivery Schema
Private Link
Cloud Event V10 Schema
Service Bus Topic As Destination
Azure Function As Destination
WebHook Batching
Secure webhook (AAD support)
IpFiltering
Updated cmdlets:
'New-AzEventGridSubscription'/'Update-AzEventGridSubscription':
Add new optional parameters to support webhook batching.
Add new optional parameters to support secured webhook using AAD.
Add new enum for EndpointType parameter to support azure function and
service bus topic as new destinations.
Add new optional parameter for delivery schema.
'New-AzEventGridTopic'/'Update-AzEventGridTopic' and 'New-
AzEventGridDomain'/'Update-AzEventGridDomain':
Add new optional parameters to support IpFiltering.
'New-AzEventGridTopic'/'New-AzEventGridDomain':
Add new optional parameters to support Input mapping.
Az.FrontDoor
Az.HDInsight
Supported creating cluster with ADLSGen1/2 storage in national clouds.
Az.Monitor
Fixed bug for 'Get-AzDiagnosticSetting' when metrics or logs are null [#12272]
Az.Network
Fixed parameters swap in VWan HubVnet connection
Added new cmdlets for Azure Network Virtual Appliance Sites
'Get-AzVirtualApplianceSite'
'New-AzVirtualApplianceSite'
'Remove-AzVirtualApplianceSite'
'Update-AzVirtualApplianceSite'
'New-AzOffice365PolicyProperty'
Added new cmdlets for Azure Network Virtual Appliance
'Get-AzNetworkVirtualAppliance'
'New-AzNetworkVirtualAppliance'
'Remove-AzNetworkVirtualAppliance'
'Update-AzNetworkVirtualAppliance'
'Get-AzNetworkVirtualApplianceSku'
'New-AzVirtualApplianceSkuProperty'
Onboarded Application Gateway to Private Link Common Cmdlets
Onboarded StorageSync to Private Link Common Cmdlets
Onboarded SignalR to Private Link Common Cmdlets
Az.RecoveryServices
Az.Resources
Az.Sql
Added support for Service principal and guest users in Set-
AzSqlInstanceActiveDirectoryAdministrator cmdlet'
Fixed a bug in Data Classification cmdlets.'
Added support for Azure SQL Managed Instance failover: 'Invoke-
AzSqlInstanceFailover'
Az.Storage
Fixed the issue that UserAgent is not added for some data plane cmdlets.
Supported create/update Storage account with MinimumTlsVersion and
AllowBlobPublicAccess
'New-AzStorageAccount'
'Set-AzStorageAccount'
Support enable/disable versioning on Blob Service of a Storage account
'Update-AzStorageBlobServiceProperty'
Support list blobs with blob versions
'Get-AzStorageBlob'
Support get/remove single blob snapshot or blob version
'Get-AzStorageBlob'
'Remove-AzStorageBlob'
Support pipeline from blob object generated from Azure.Storage.Blobs V12
'Get-AzStorageBlobContent'
'New-AzStorageBlobSASToken'
'Remove-AzStorageBlob'
'Set-AzStorageBlobContent'
'Start-AzStorageBlobCopy'
Az.StorageSync
Az.Websites
Added support to perform operations for Slots not in the same resource group as
the App Service Plan
Az.Accounts
Supported discovering environment setting by default and adding environment via
'Add-AzEnvironment'
Update preloaded assemblies [#12024], [#11976]
Updated Azure.Core assembly
Fixed an issue that may cause 'Connect-AzAccount' to fail in multi-threaded
execution [#11201]
Az.Aks
Replaced usage of old AccessProfile API with calls to ListClusterAdmin and
ListClusterUser APIs
Az.Batch
Updated Az.Batch to use 'Microsoft.Azure.Management.Batch' SDK version to 11.0.0
Added the ability to set the BatchAccount Identity in the 'New-AzBatchAccount'
cmdlet
Az.CognitiveServices
Supported displaying account capabilities.
Supported modifying PublicNetworkAccess.
Az.Compute
Az.DataFactory
Updated ADF .Net SDK version to 4.9.0
Az.EventHub
Added Managed Identity parameters to 'New-AzEventHubNamespace' and 'Set-
AzEventHubNamespace' cmdlets
Az.Functions
Az.HDInsight
Supported listing hosts and restart specific hosts of the HDInsight cluster.
Az.HealthcareApis
Az.Monitor
Fixed input object parameter for 'Set-AzActivityLogAlert'
Fixed 'InputObject' parameter for 'Set-AzActionGroup' [#10868]
Az.Network
Added support for AddressPrefixType parameter to 'Remove-
AzExpressRouteCircuitConnectionConfig'
Added new cmdlets for Azure FirewallPolicy
'New-AzFirewallPolicyDnsSetting'
Support for Destination FQDN in Network Rules for Firewall Policy
Added support for backend address pool operations
'New-AzLoadBalancerBackendAddressConfig'
'New-AzLoadBalancerBackendAddressPool'
'Set-AzLoadBalancerBackendAddressPool'
'Remove-AzLoadBalancerBackendAddressPool'
'Get-AzLoadBalancerBackendAddressPool'
Added name validation for 'New-AzIpGroup'
Added new cmdlets for Azure FirewallPolicy
'New-AzFirewallPolicyThreatIntelWhitelist'
Updated below commands for feature: Custom dns servers set/remove on
VirtualWan P2SVpnGateway.
Updated New-AzP2sVpnGateway: Added optional parameter '-CustomDnsServer'
for customers to specify their dns servers to set on P2SVpnGateway, which can
be used by Point to site clients.
Updated Update-AzP2sVpnGateway: Added optional parameter '-
CustomDnsServer' for customers to specify their dns servers to set on
P2SVpnGateway, which can be used by Point to site clients.
Updated 'Update-AzVpnGateway'
Added optional parameter '-BgpPeeringAddress' for customers to specify their
custom bgps to set on VpnGateway.
Added new cmdlet to support resetting the routing state of a VirtualHub resource:
'Reset-AzHubRouter'
Updated below things based on recent swagger change for Firewall Policy
Changes names for RuleGroup, RuleCollectionGroup and RuleType
Added support for Firewall Policy NAT Rule Collections to support multiple NAT
Rule Collection
[Breaking Change] Added mandatory parameter 'SourceIpGroup' for 'New-
AzFirewallPolicyApplicationRule' and 'New-AzFirewallPolicyNetworkRule'.
[Breaking Change] Fixed 'New-AzFirewallPolicyApplicationRule', parameter
'SourceAddress' to be mandatory.
[Breaking Change] Fixed 'New-AzFirewallPolicyApplicationRule', parameter
'SourceAddress' to be mandatory.
[Breaking Change] Removed mandatory parameters: 'TranslatedAddress',
'TranslatedPort' for 'New-AzFirewallPolicyNatRuleCollection'.
Added new cmdlets to support PrivateLink On Application Gateway
'New-AzApplicationGatewayPrivateLinkConfiguration'
'Get-AzApplicationGatewayPrivateLinkConfiguration'
'New-AzApplicationGatewayPrivateLinkConfiguration'
'Set-AzApplicationGatewayPrivateLinkConfiguration'
'Remove-AzApplicationGatewayPrivateLinkConfiguration'
'New-AzApplicationGatewayPrivateLinkIpConfiguration'
Added new cmdlets for HubRouteTables child resource of VirtualHub.
'New-AzVHubRoute'
'New-AzVHubRouteTable'
'Get-AzVHubRouteTable'
'Update-AzVHubRouteTable'
'Remove-AzVHubRouteTable'
Updated existing cmdlets to support optional RoutingConfiguration input
parameter for custom routing in VirtualWan.
'New-AzExpressRouteConnection'
'Set-AzExpressRouteConnection'
'New-AzVirtualHubVnetConnection'
'Update-AzVirtualHubVnetConnection'
'New-AzVpnConnection'
'Update-AzVpnConnection'
'New-AzP2sVpnGateway'
'Update-AzP2sVpnGateway'
Az.OperationalInsights
Az.RecoveryServices
Azure Backup added support for fetching MAB items.
Azure Site Recovery supports disk type 'StandardSSD_LRS'
Az.Resources
Az.Sql
Added support for service principal for Set SQL Server Azure Active Directory Admin
cmdlet
Fixed sync issue in Data Classification cmdlets.
Supported searching user by mail on 'Set-AzSqlServerActiveDirectoryAdministrator'
[#12192]
Az.Storage
Az.Websites
Added safeguard to delete created webapp if restore failed in 'Restore-
AzDeletedWebApp'
Added 'SourceWebApp.Location' for 'New-AzWebApp' and 'New-AzWebAppSlot'
Fixed bug that prevented changing Container settings in 'Set-AzWebApp' and 'Set-
AzWebAppSlot'
Fixed bug to get SiteConfig when -Name is not given for Get-AzWebApp
Added a support to create ASP for Linux Apps
Added exceptions for clone across resource groups
Az.Accounts
Fixed an issue that may cause Az to skip logs in Azure Automation or PowerShell
jobs [#11492]
Az.AnalysisServices
Updated assembly version of data plane cmdlets
Az.ApiManagement
Updated assembly version of service management cmdlets
Az.Billing
Updated assembly version of consumption cmdlets
Az.CognitiveServices
Support PrivateEndpoint and PublicNetworkAccess control.
Az.DataFactory
Updated assembly version of data factory V2 cmdlets
Az.DataShare
General availability of ''Az.DataShare'' module
Az.DesktopVirtualization
General availability of ''Az.DesktopVirtualization'' module
Az.OperationalInsights
Upgraded SDK to 0.21.0
Added optional parameters to
'New-AzOperationalInsightsSavedSearch'
'Set-AzOperationalInsightsSavedSearch'
Az.PolicyInsights
Corrected example 3 for 'Start-AzPolicyComplianceScan'
Az.PowerBIEmbedded
Updated assembly version of PowerBI cmdlets
Az.PrivateDns
Corrected verbose output string formatting for Remove-AzPrivateDnsRecordSet
Az.RecoveryServices
Azure Site Recovery support for creating recovery plan for zone to zone replication
from xml input.
Updated assembly version of SiteRecovery and Backup cmdlets
Az.Resources
Az.Sql
Added UsePrivateLinkConnection to 'New-AzSqlSyncGroup', 'Update-
AzSqlSyncGroup', 'New-AzSqlSyncMember' and 'Update-AzSqlSyncMember'
Added SyncMemberAzureDatabaseResourceId to 'New-AzSqlSyncMember' and
'Update-AzSqlSyncMember'
Added Guest user lookup support to Set SQL Server Azure Active Directory Admin
cmdlet
Az.Storage
Updated assembly version of data plane cmdlets
Az.Accounts
Az.Aks
Upgraded API Version to 2019-10-01
Supported to create AKS using Windows container
Provided new cmdlets: 'New-AzAksNodePool', 'Update-AzAksNodePool', 'Remove-
AzAksNodePool',
'Get-AzAksNodePool', 'Install-AzAksKubectl', 'Get-AzAksVersion'
Az.ApiManagement
Az.ApplicationInsights
Az.Batch
Az.Compute
Added HostId parameter to 'Update-AzVM' cmdlet
Updated Help documents for 'New-AzVMConfig', 'New-AzVmssConfig', 'Update-
AzVmss', 'Set-AzVMOperatingSystem' and 'Set-AzVmssOsProfile' cmdlets.
Breaking changes
FilterExpression parameter is removed from 'Get-AzVMImage' cmdlet.
AssignIdentity parameter is removed from 'New-AzVmssConfig', 'New-
AzVMConfig' and 'Update-AzVM' cmdlets.
AutomaticRepairMaxInstanceRepairsPercent is removed from 'New-
AzVmssConfig' and 'Update-AzVmss' cmdlets.
AvailabilitySetsColocationStatus, VirtualMachinesColocationStatus and
VirtualMachineScaleSetsColocationStatus properties are removed from
ProximityPlacementGroup.
MaxInstanceRepairsPercent property is removed from AutomaticRepairsPolicy.
The types of AvailabilitySets, VirtualMachines and VirtualMachineScaleSets are
changed from IList<SubResource> to IList<SubResourceWithColocationStatus> .
Description for 'Get-AzVM' cmdlet has been updated to better describe it.
Az.DataFactory
Supported CRUD of data flow runtime properties in Managed IR.
Az.FrontDoor
Added new cmdlets for creation, update, retreival, and deletion of Front Door Rules
Engine object
Added helper cmdlets for construction of Front Door Rules Engine object
Added Rules Engine reference to Front Door Routing Rule object.
Added Private Link parameters to Front Door Backend object
Az.Functions
General availability of ''Az.Functions'' module
Az.HDInsight
Az.HealthcareApis
Az.IotHub
Added cmdlet to invoke a query in an IoT hub to retrieve information using a SQL-
like language.
Fix issue that 'Add-AzIotHubDevice' fails to create Edge Enabled Device without
child devices [#11597]
Added cmdlet to generate SAS token for Iot Hub, device or module.
Added cmdlet to invoke configuration metrics query.
Manage IoT Edge automatic deployment at scale. New cmdlets are:
'Add-AzIotHubDeployment'
'Get-AzIotHubDeployment'
'Remove-AzIotHubDeployment'
'Set-AzIotHubDeployment'
Added cmdlet to invoke an IoT Edge deployment metrics query.
Added cmdlet to apply the configuration content to the specified edge device.
Az.KeyVault
Removed two aliases: 'New-AzKeyVaultCertificateAdministratorDetails' and 'New-
AzKeyVaultCertificateOrganizationDetails'
Enabled soft delete by default when creating a key vault
Network rules can be set to govern the accessibility from specific network locations
when creating a key vault
Added support to bring your own key (BYOK)
'Add-AzKeyVaultKey' supports generating a key exchange key
'Get-AzKeyVaultKey' supports downloading a public key in PEM format
Updated the 'KeyOps' part of the help document of 'Add-AzKeyVaultKey'
Az.Monitor
Az.Network
Added breaking change attribute to notify that Zone default behaviour will be
changed
'New-AzPublicIpAddress'
'New-AzPublicIpPrefix'
'New-AzLoadBalancerFrontendIpConfig'
Added support for a new top level resource SecurityPartnerProvider
New cmdlets added:
New-AzSecurityPartnerProvider
Remove-AzSecurityPartnerProvider
Get-AzSecurityPartnerProvider
Set-AzSecurityPartnerProvider
Added 'RequiredZoneNames' on 'PSPrivateLinkResource' and 'GroupId' on
'PSPrivateEndpointConnection'
Fixed incorrect type of SuccessThresholdRoundTripTimeMs parameter for New-
AzNetworkWatcherConnectionMonitorTestConfigurationObject
Updated VirtualWan cmdlets to set default value of AllowVnetToVnetTraffic
argument to True.
'New-AzVirtualWan'
'Update-AzVirtualWan'
Added new cmdlets to support DNS zone group for private endpoint
'New-AzPrivateDnsZoneConfig'
'Get-AzPrivateDnsZoneGroup'
'New-AzPrivateDnsZoneGroup'
'Set-AzPrivateDnsZoneGroup'
'Remove-AzPrivateDnsZoneGroup'
Added 'DNSEnableProxy', 'DNSRequireProxyForNetworkRules' and 'DNSServers'
parameters to 'AzureFirewall'
Added 'EnableDnsProxy', 'DnsProxyNotRequiredForNetworkRule' and 'DnsServer'
parameters to 'AzureFirewall'
Updated cmdlet:
New-AzFirewall
Az.OperationalInsights
Updated legacy code to apply new generated SDK
Deleted cmdlets due to deprecated APIs
'Get-AzOperationalInsightsSavedSearchResult' (alias 'Get-
AzOperationalInsightsSavedSearchResults')
'Get-AzOperationalInsightsSearchResult' (alias 'Get-
AzOperationalInsightsSearchResults')
'Get-AzOperationalInsightsLinkTarget' (alias 'Get-
AzOperationalInsightsLinkTargets')
Added parameters for 'Set-AzOperationalInsightsWorkspace' and 'New-
AzOperationalInsightsWorkspace'
Created cmdlets for Linked Stoarge Account
Created cmdlets for Clusters and Linked Service
Az.RecoveryServices
Azure Site Recovery added support for protecting proximity placement group virtual
machines for Azure to Azure provider.
Azure Site Recovery added support for zone to zone replication.
Azure Backup Added Long term retention support for Azure FileShare Recovery
Points.
Azure Backup Added disk exclusion properties to 'Get-
AzRecoveryServicesBackupItem' cmdlet output.
Added private endpoint for Vault credential file for site recovery service.
Az.Resources
Added message warning about view delay when creating a new Role Definition
Changed policy cmdlets to output strongly-typed objects
Removed '-TenantLevel' parameter used for on the 'Get-AzResourceLock' cmdlet
[#11335]
Fixed 'Remove-AzResourceGroup -Id ResourceId'[#9882]
Added new cmdlet for getting ARM template What-If results at resource group
scope: 'Get-AzDeploymentResourceGroupWhatIfResult'
Added new cmdlet for getting ARM template What-If results at subscription scope:
'Get-AzDeploymentWhatIfResult'
Alias: 'Get-AzSubscriptionDeploymentWhatIf'
Overrode '-WhatIf' and '-Confirm' parameters for 'New-AzDeployment' and 'New-
AzResourceGroupDeployment' to use ARM template What-If results
Added deprecation message for 'ApiVersion' parameter in deployment cmdlets
Added capability to show improved error messages for deployment failures
Added correlationId logging for deployment failures
Added 'error' property to the deployment script output
Updated nuget Microsoft.Azure.Management.ResourceManager to '3.7.1-preview'
Removed specific test cases as Error property in DeploymentValidateResult has
changed to readonly from nuget 3.7.1-preview
Brought GenericResourceExpanded from SDK ResourceManager 3.7.1-preview
Added tag support for all Get cmdlets for deployment, as well as
'New-AzDeployment'
'New-AzManagementGroupDeployment'
'New-AzResourceGroupDeployment'
'New-AzTenantDeployment'
Az.ServiceFabric
Fixed bug in add certificate using --SecretIdentifier that was getting the wrong
certificate thumbprint
Az.Sql
Enhance performance of:
'Set-AzSqlDatabaseSensitivityClassification'
'Set-AzSqlInstanceDatabaseSensitivityClassification'
'Remove-AzSqlDatabaseSensitivityClassification'
'Remove-AzSqlInstanceDatabaseSensitivityClassification'
'Enable-AzSqlDatabaseSensitivityRecommendation'
'Enable-AzSqlInstanceDatabaseSensitivityRecommendation'
'Disable-AzSqlDatabaseSensitivityRecommendation'
'Disable-AzSqlInstanceDatabaseSensitivityRecommendation'
Removed client-side validation of 'RetentionDays' parameter from cmdlet 'Set-
AzSqlDatabaseBackupShortTermRetentionPolicy'
Auditing to a storage account in Vnet, fixing a bug when creating a Storage Blob
Data Contributor role.
Az.Storage
Added '-AsJob' to get/list account cmdlet 'Get-AzStorageAccount'
Make KeyVersion to optional when update Storage account with
KeyvaultEncryption, to support key auto-rotation
'Set-AzStorageAccount'
Fixed remove Azure File Directory fail with pipeline
'Remove-AzStorageDirectory'
Fixed [#9880]: Change NetWorkRule DefaultAction value defination to align with
swagger.
'Update-AzStorageAccountNetworkRuleSet'
'Get-AzStorageAccountNetworkRuleSet'
Fixed [#11624]: Skip duplicated rules when add NetworkRules, to avoid server
failure
'Add-AzStorageAccountNetworkRule'
Upgraded Microsoft.Azure.Cosmos.Table SDK to 1.0.7
Added a warning message to remind user to list again with ContinuationToken
when only part items are returned in list DataLake Gen2 Items,
'Get-AzDataLakeGen2ChildItem'
Supported to create or update Storage account with Azure Files Active Directory
Domain Service Authentication
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported to new or list Kerberos keys of Storage account
'New-AzStorageAccountKey'
'Get-AzStorageAccountKey'
Supported failover Storage account
'Invoke-AzStorageAccountFailover'
Updated help of 'Get-AzStorageBlobCopyState'
Updated help of 'Get-AzStorageFileCopyState' and 'Start-AzStorageBlobCopy'
Integrated Storage client library v12 to Queue and File cmdlets
Changed output type from CloudFile to AzureStorageFile, the original output will
become a child property of the new output
'Get-AzStorageFile'
'Remove-AzStorageFile'
'Get-AzStorageFileContent'
'Set-AzStorageFileContent'
'Start-AzStorageFileCopy'
Changed output type from CloudFileDirectory to AzureStorageFileDirectory, the
original output will become a child property of the new output
'New-AzStorageDirectory'
'Remove-AzStorageDirectory'
Changed output type from CloudFileShare to AzureStorageFileShare, the original
output will become a child property of the new output
'Get-AzStorageShare'
'New-AzStorageShare'
'Remove-AzStorageShare'
Changed output type from FileShareProperties to AzureStorageFileShare, the
original output will become a sub child property of the new output
'Set-AzStorageShareQuota'
Az.TrafficManager
Az.Websites
Az.Accounts
Az.ApiManagement
Added breaking change notice for Azure File cmdlets output change in a future
release
'Set-AzApiManagementGroup' Updated documentation to specify the GroupId
parameter
Az.Cdn
Az.CognitiveServices
Az.Compute
Az.IotHub
Az.KeyVault
Added a new cmdlet 'Update-AzKeyVault' that can enable soft delete and purge
protection on a vault
Added support to Microsoft.PowerShell.SecretManagement [#11178]
Fixed error in the examples of 'Remove-AzKeyVaultManagedStorageSasDefinition'
[#11479]
Added support to private endpoint
Az.Maintenance
Publishing release version of Maintenance cmdlets for GA
Az.Monitor
Added cmdlets for private link scope
'Get-AzInsightsPrivateLinkScope'
'Remove-AzInsightsPrivateLinkScope'
'New-AzInsightsPrivateLinkScope'
'Update-AzInsightsPrivateLinkScope'
'Get-AzInsightsPrivateLinkScopedResource'
'New-AzInsightsPrivateLinkScopedResource'
'Remove-AzInsightsPrivateLinkScopedResource'
Az.Network
Updated cmdlets to enable connection on private IP for Virtual Network Gateway.
'New-AzVirtualNetworkGateway'
'Set-AzVirtualNetworkGateway'
'New-AzVirtualNetworkGatewayConnection'
'Set-AzVirtualNetworkGatewayConnection'
Updated cmdlets to enable FQDN based LocalNetworkGateways and VpnSites
'New-AzLocalNetworkGateway'
'New-AzVpnSiteLink'
Added support for IPv6 address family in ExpressRouteCircuitConnectionConfig
(Global Reach)
Added 'Set-AzExpressRouteCircuitConnectionConfig'
allows setting of all the existing properties including the
IPv6CircuitConnectionProperties
Updated 'Add-AzExpressRouteCircuitConnectionConfig'
Added another optional parameter AddressPrefixType to specify the address
family of address prefix
Updated cmdlets to enable setting of DPD Timeout on Virtual Network Gateway
Connections.
New-AzVirtualNetworkGatewayConnection
Set-AzVirtualNetworkGatewayConnection
Az.PolicyInsights
Az.ServiceFabric
Improved code formatting and usability of 'New-AzServiceFabricCluster' examples
Az.Sql
Added cmdlets 'Get-AzSqlInstanceOperation' and 'Stop-AzSqlInstanceOperation'
Supported auditing to a storage account in VNet.
Az.Storage
Added breaking change notice for Azure File cmdlets output change in a future
release
Supported new SkuName StandardGZRS, StandardRAGZRS when create/update
Storage account
'New-AzStorageAccount'
'Set-AzStorageAccount'
Supported DataLake Gen2
'New-AzDataLakeGen2Item'
'Get-AzDataLakeGen2Item'
'Get-AzDataLakeGen2ChildItem'
'Move-AzDataLakeGen2Item'
'Set-AzDataLakeGen2ItemAclObject'
'Update-AzDataLakeGen2Item'
'Get-AzDataLakeGen2ItemContent'
'Remove-AzDataLakeGen2Item'
0.10.0-preview - April 2020
General
Az modules is now available in preview on Azure Stack Hub. This allows for cross-
platform compatibility with Linux and macOs. Azure Stack Hub now supports
PowerShell core with the Az modules, more information here
Az modules support profile 2019-03-01-hybrid:
Az.Billing
Az.Compute
Az.DataBoxEdge
Az.EventHub
Az.IotHub
Az.KeyVault
Az.Monitor
Az.Network
Az.Resources
Az.Storage
Az.Websites
Three new PowerShell modules for az have been introduced that work with Azure
Stack Hub, which are Az.Databox, Az.IotHub, and Az.EventHub
Commands remain relatively the same, with minor changes such as changing
AzureRM to Az
Updated link to PowerShell documentation for Azure Stack Hub can be found
here
Az.Accounts
Upgrade from ADAL to MSAL
Az.Accounts
Az.Compute
Added the following parameters to 'New-AzDiskConfig' cmdlet:
DiskIOPSReadOnly, DiskMBpsReadOnly, MaxSharesCount, GalleryImageReference
Allowed Encryption property to Target parameter of 'New-AzGalleryImageVersion'
cmdlet.
Fixed tempDisk issue for 'Set-AzVmss' -Reimage and 'Invoke-AzVMReimage'
cmdlets. [#11354]
Added support to below cmdlets for new SAP Extension
'Set-AzVMAEMExtension'
'Get-AzVMAEMExtension'
'Remove-AzVMAEMExtension'
'Update-AzVMAEMExtension'
Fixed errors in examples of help document
Showed the exact string value for VM PowerState in the table format.
'New-AzVmssConfig': fixed serialization of AutomaticRepairs property when
SinglePlacementGroup is disabled. [#11257]
Az.DataFactory
Updated ADF .Net SDK version to 4.8.0
Added optional parameters to 'Invoke-AzDataFactoryV2Pipeline' command to
support rerun
Az.DataLakeStore
Az.HDInsight
Supported specifying minimal supported TLS version when creating cluster.
Az.IotHub
Added support to manage distributed settings per-device. New Cmdlets are:
'Get-AzIotHubDistributedTracing'
'Set-AzIotHubDistributedTracing'
Az.KeyVault
Added breaking change attributes to 'New-AzKeyVault'
Az.Monitor
Updated documentation for 'New-AzScheduledQueryRuleLogMetricTrigger'
Az.Network
Updated cmdlets to allow cross-tenant VirtualHubVnetConnections
'New-AzVirtualHubVnetConnection'
'Update-AzVirtualHubVnetConnection'
'New-AzVirtualHub'
'Update-AzVirtualHub'
Removed Sql Management SDK dependency
Updated cmdlets to allow force firewallPolicy association
'New-AzApplicationGateway'
Az.PolicyInsights
Improved error messages
Az.RecoveryServices
Azure Site Recovery added support for doing reprotect and updated vm properties
for Azure disk encrypted Virtual Machines.
Added Azure Site Recovery VmwareToAzure properties DR monitoring
Azure Backup added support for retrying policy update for failed items.
Azure Backup Added support for disk exclusion settings during backup and restore.
Azure Backup Added Support for Restoring Multiple files/folders in AzureFileShare
Azure Backup Added support for User-specified Resourcegroup support while
updating IaasVM Policy
Az.Resources
Az.Sql
Added readable secondary parameter to 'Invoke-AzSqlDatabaseFailover'
Added cmdlet 'Disable-AzSqlServerActiveDirectoryOnlyAuthentication'
Saved sensitivity rank when classifying columns in the database.
Az.Support
General availability of 'Az.Support' module
Az.Websites
Added support for working with webapp Traffic Routing Rules via below new
cmdlets
'Get-AzWebAppTrafficRouting'
'Update-AzWebAppTrafficRouting'
'Add-AzWebAppTrafficRouting'
'Remove-AzWebAppTrafficRouting'
Az.Accounts
Open Azure PowerShell survey page in 'Send-Feedback' [#11020]
Display Azure PowerShell survey URL in 'Resolve-Error' [#11021]
Added Az version in UserAgent
Az.ApiManagement
Added support for retrieving and configuring Custom Domain on the
DeveloperPortal Endpoint [#11007]
'Export-AzApiManagementApi' Added support for downloading Api Definition in
Json format [#9987]
'Import-AzApiManagementApi' Added support for importing OpenApi 3.0 definition
from Json document
'New-AzApiManagementIdentityProvider' and 'Set-
AzApiManagementIdentityProvider' Added support for configuring 'Signin Tenant'
for AAD B2C Provider [#9784]
Az.DataLakeStore
Added reference to System.Buffers explicitly in csproj and psd1.
Az.IotHub
Added support to manage devices in an Iot Hub. New Cmdlets are:
'Add-AzIotHubDevice'
'Get-AzIotHubDevice'
'Remove-AzIotHubDevice'
'Set-AzIotHubDevice'
Added support to manage modules on a target Iot device in an Iot Hub. New
Cmdlets are:
'Add-AzIotHubModule'
'Get-AzIotHubModule'
'Remove-AzIotHubModule'
'Set-AzIotHubModule'
Added cmdlet to get the connection string of a target IoT device in an Iot Hub.
Added cmdlet to get the connection string of a module on a target IoT device in an
Iot Hub.
Added support to get/set parent device of an IoT device. New Cmdlets are:
'Get-AzIotHubDeviceParent'
'Set-AzIotHubDeviceParent'
Added support to manage device parent-child relationship.
Az.Monitor
Fixed output value for 'Get-AzMetricDefinition' [#9714]
Az.Network
Updated Sql Management SDK.
Fixed a naming-difference issue in PrivateLinkServiceConnectionState class.
Mapping the field ActionsRequired to ActionRequired.
Added PublicNetworkAccess to 'New-AzSqlServer' and 'Set-AzSqlServer'
Az.Resources
Fixed for null reference bug in 'Get-AzRoleAssignment'
Marked switch '-Force' and '-PassThru' optional in 'Remove-AzADGroup' [#10849]
Fixed issue that 'MailNickname' doesn't return in 'Remove-AzADGroup' [#11167]
Fixed issue that 'Remove-AzADGroup' pipe operation doesn't work [#11171]
Fixed for null reference bug in GetAzureRoleAssignmentCommand
Added breaking change attributes for upcoming changes to policy cmdlets
Updated 'Get-AzResourceGroup' to perform resource group tag filtering on server-
side
Extended Tag cmdlets to accept -ResourceId
Get-AzTag -ResourceId
New-AzTag -ResourceId
Remove-AzTag -ResourceId
Added new Tag cmdlet
Update-AzTag -ResourceId
Brought ScopedDeployment from SDK 3.3.0
Az.Sql
Az.Storage
Supported AllowProtectedAppendWrite in ImmutabilityPolicy
'Set-AzRmStorageContainerImmutabilityPolicy'
Added breaking change warning message for AzureStorageTable type change in a
future release
'New-AzStorageTable'
'Get-AzStorageTable'
Az.Websites
Added Tag parameter for 'New-AzAppServicePlan' and 'Set-AzAppServicePlan'
Stop cmdlet execution if an exception is thrown when adding a custom domain to a
website
Added support to perform operations for App Services not in the same resource
group as the App Service Plan
Applied access restriction to WebApp/Function in different resource groups
Fixed issue to set custom hostnames for WebAppSlots
Az.Resource
Az.Accounts
Added SubscriptionId, TenantId, and execution time into data of client side
telemetry
Az.Automation
Fixed typo in Example 1 in reference documentation for 'New-
AzAutomationSoftwareUpdateConfiguration'
Az.CognitiveServices
Az.Compute
Allowed empty value for ProximityPlacementGroupId during update
Az.FrontDoor
Added cmdlet to get managed rule definitions that can be used in WAF
Az.IotHub
Az.KeyVault
Az.Monitor
Fixed description of the Get-AzLog cmdlet.
A new parameter called ActionGroupId was added to 'New-AzMetricAlertRuleV2'
command.
The user can provide either ActionGroupId(string) or
ActionGorup(ActivityLogAlertActionGroup).
Az.Network
Added one extra parameter note for parameter '-EnableProxyProtocol' for 'New-
AzPrivateLinkService' cmdlet.
Fixed FilterData example in Start-
AzVirtualNetworkGatewayConnectionPacketCapture.md and Start-
AzVirtualnetworkGatewayPacketCapture.md.
Added Packet Capture example for capture all inner and outer packets in Start-
AzVirtualNetworkGatewayConnectionPacketCapture.md and Start-
AzVirtualnetworkGatewayPacketCapture.md.
Supported Azure Firewall Policy on VNet Firewalls
No new cmdlets are added. Relaxing the restriction for firewall policy on VNet
firewalls
Az.RecoveryServices
Added Support for Restore-as-files for SQL Databases.
Az.Resources
Refactored template deployment cmdlets
Added new cmdlets for managing deployments at management group: *-
AzManagementGroupDeployment
Added new cmdlets for managing deployments at tenant scope: *-
AzTenantDeployment
Refactored *-AzDeployment cmdlets to work specifically at subscription scope
Created aliases *-AzSubscriptionDeployment for *-AzDeployment cmdlets
Fixed 'Update-AzADApplication' when parameter 'AvailableToOtherTenants' is not
set
Removed ApplicationObjectWithoutCredentialParameterSet to avoid
AmbiguousParameterSetException.
Regenerated help files
Az.Sql
Added support for cross subscription point in time restore on Managed Instances.
Added support for changing existing Sql Managed Instance hardware generation
Fixed 'Update-AzSqlServerVulnerabilityAssessmentSetting' help examples:
parameter/property output - EmailAdmins
Az.SqlVirtualMachine
Az.StorageSync
Az.CosmosDB
Added cmdlets for Gremlin, MongoDB, Cassandra and Table APIs.
Updated .NET SDK Version to 1.0.1
Added parameters ConflictResolutionPolicyMode, ConflictResolutionPolicyPath and
ConflictResolutionPolicyPath in Set-AzCosmosDBSqlContainer.
Added new cmdlets for Sql API : New-CosmosDBSqlSpatialSpec, New-
CosmosDBSqlCompositePath, New-CosmosDBSqlIncludedPathIndex, New-
CosmosDBSqlIncludedPath
Az.Accounts
Disable context auto saving when AzureRmContext.json not available
Update the reference to Azure Powershell Common to 1.3.5-preview
Az.ApiManagement
Az.Compute
Limit the number of VM status to 100 to avoid throttling when Get-AzVM -Status is
performed without VM name.
Add Update-AzDiskEncryptionSet cmdlet
Add EncryptionType and DiskEncryptionSetId parameters to the following cmdlets:
New-AzDiskUpdateConfig, New-AzSnapshotUpdateConfig
Add ColocationStatus parameter to Get-AzProximityPlacementGroup cmdlet.
Az.DataFactory
Update ADF .Net SDK version to 4.7.0
Az.DeploymentManager
Adds LIST operations for resources
Adds capability for performing operations on Health Check steps
Az.HDInsight
Fix document error of New-AzHDInsightCluster.
Az.KeyVault
Add Name alias to VaultName attribute to make Remove-AzureKeyVault consistent
with New-AzureKeyVault.
Az.Network
Az.PolicyInsights
Az.RecoveryServices
Azure Site Recovery support for removing a replicated disk.
Azure Backup added support for adding tags while creating a Recovery Services
Vault.
Az.Resources
Make -Scope optional in *-AzPolicyAssignment cmdlets with default to context
subscription
Add examples of creating ADServicePrincipal with password and key credential
Az.Sql
Az.Storage
Support set Table/Queue Encryption Keytype in Create Storage Account
New-AzStorageAccount
Show RequestId when StorageException don't have ExtendedErrorInformation
Fix the Example 6 of cmdlet Start-AzStorageBlobCopy
Az.Websites
Set-AzWebapp and Set-AzWebappSlot supports AlwaysOn, MinTls and FtpsState
properties
Fixing issue where setting HttpsOnly along with changing AppservicePlan at the
same time using the single Set-AzWebApp Command, was resetting HttpsOnly to
default value
Az.Accounts
Updated Add-AzEnvironment and Set-AzEnvironment to accept parameters
AzureAttestationServiceEndpointResourceId and
AzureAttestationServiceEndpointSuffix
Az.Cdn
Display error response detail in New-AzCdnEndpoint cmdlet
Az.Compute
Fix Set-AzVMCustomScriptExtension cmdlet for a VM with managed OD disk which
does not have OS profile.
Az.ContainerInstance
Az.DataBoxEdge
Az.DataFactory
Az.DevTestLabs
Remove the broken link in Get-AzDtlAllowedVMSizesPolicy.md
Az.EventHub
Fix for issue 10634 : Fix the null Object reference for remove eventhubnamespace
Az.HDInsight
Az.MachineLearning
Az.Network
Upgrade dependency of Microsoft.Azure.Management.Sql from 1.36-preview to
1.37-preview
Az.RecoveryServices
Azure Site Recovery change support for managed disk vms encrypted at rest with
customer managed leys for Azure to Azure provider.
Azure Site Recovery support to input disk encryption Set Id as optional input at
enabling protection for Vmware to Azure.
Azure Site Recovery support to input disk encryption Set Id as optional input at disk
level to enable protection for Vmware to Azure.
Azure Site Recovery support to update replication protected item with disk
encryption set Map for HyperV to Azure.
Az.Resources
Fix an error in help document of 'Remove-AzTag'.
Az.Sql
Fix vulnerability assessment set baseline cmdlets functionality to work on master db
for azure database and limit it on managed instance system databases.
Fix an error when creating SQL instance failover group
Az.SqlVirtualMachine
Az.Storage
Add breaking change warning message for DefaultAction Value change in a future
release
Update-AzStorageAccountNetworkRuleSet
Support Get last sync time of Storage account by run get-AzStorageAccount with
parameter -IncludeGeoReplicationStats
Get-AzStorageAccount
General
Update references in .psd1 to use relative path for all modules
Az.Accounts
Az.Batch
Fix issue #10602, where New-AzBatchPool did not properly send
'VirtualMachineConfiguration.ContainerConfiguration' or
'VirtualMachineConfiguration.DataDisks' to the server.
Az.DataFactory
Az.HealthcareApis
Exception Handling
Az.KeyVault
Fixed error accessing value that is potentially not set
Elliptic Curve Cryptography Certificate Managment
Added support to specify the Curve for Certificate Policies
Az.Monitor
Adding optional argument to the Add Diagnostic Settings command. A switch
argument that if present indicates that the export to Log Analytics must be to a
fixed schema (a.k.a. dedicated, data type)
Az.Network
Az.RecoveryServices
Az.Resources
Fix an issue where template deployment fails to read a template parameter if its
name conflicts with some built-in parameter name.
Updated policy cmdlets to use new api version 2019-09-01 that introduces
grouping support within policy set definitions.
Az.Sql
Upgraded storage creation in Vulnerability Assessment auto enablement to
StorageV2
Az.Storage
Support generate Blob/Constainer Idenity based SAS token with Storage Context
based on Oauth authentication
New-AzStorageContainerSASToken
New-AzStorageBlobSASToken
Support revoke Storage Account User Delegation Keys, so all Idenity SAS tokens are
revoked
Revoke-AzStorageAccountUserDelegationKeys
Upgrade to Microsoft.Azure.Management.Storage 14.2.0, to support new API
version 2019-06-01.
Support Share QuotaGiB more than 5120 in Management plane File Share cmdlets,
and add parameter alias 'Quota' to parameter 'QuotaGiB'
New-AzRmStorageShare
Update-AzRmStorageShare
Add parameter alias 'QuotaGiB' to parameter 'Quota'
Set-AzStorageShareQuota
Fix the issue that Set-AzStorageContainerAcl can clean up the stored Access Policy
Set-AzStorageContainerAcl
Az.Compute
VM Reapply feature
Add Reapply parameter to Set-AzVM cmdlet
VM Scale Set AutomaticRepairs feature:
Add EnableAutomaticRepair, AutomaticRepairGracePeriod, and
AutomaticRepairMaxInstanceRepairsPercent parameters to the following cmdlets:
New-AzVmssConfig
Update-AzVmss
Cross tenant gallery image support for New-AzVM
Add 'Spot' to the argument completer of Priority parameter in New-AzVM, New-
AzVMConfig and New-AzVmss cmdlets
Add DiskIOPSReadWrite and DiskMBpsReadWrite parameters to Add-
AzVmssDataDisk cmdlet
Change SourceImageId parameter of New-AzGalleryImageVersion cmdlet to
optional
Add OSDiskImage and DataDiskImage parameters to New-AzGalleryImageVersion
cmdlet
Add HyperVGeneration parameter to New-AzGalleryImageDefinition cmdlet
Add SkipExtensionsOnOverprovisionedVMs parameters to New-AzVmss, New-
AzVmssConfig and Update-AzVmss cmdlets
Az.DataBoxEdge
Az.DataFactory
Az.DataLakeStore
Az.FrontDoor
Az.Network
Change 'Start-AzVirtualNetworkGatewayConnectionPacketCapture.md' and 'Start-
AzVirtualnetworkGatewayPacketCapture.md' FilterData option examples.
Az.PrivateDns
Az.RecoveryServices
Az.RedisCache
Added 'MinimumTlsVersion' parameter in 'New-AzRedisCache' and 'Set-
AzRedisCache' cmdlets. Also, added 'MinimumTlsVersion' in the output of 'Get-
AzRedisCache' cmdlet.
Added validation on '-Size' parameter for 'Set-AzRedisCache' and 'New-
AzRedisCache' cmdlets
Az.Resources
Updated policy cmdlets to use new api version 2019-06-01 that has new
EnforcementMode property in policy assignment.
Updated create policy definition help example
Fix bug Remove-AZADServicePrincipal -ServicePrincipalName, throw null reference
when service principal name not found.
Fix bug New-AZADServicePrincipal, throw null reference when tenant doesn't have
any subscription.
Change New-AzAdServicePrincipal to add credentials only to associated application.
Az.Sql
Added support for database ReadReplicaCount.
Fixed Set-AzSqlDatabase when zone redundancy not set
General
Az.PrivateDns 1.0.0 released
Az.Accounts
Az.Advisor
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-
Added ability to mount remote file-systems on each node of a pool via the new
MountConfiguration parameter of New-AzBatchPool.
Now support network security rules blocking network access to a pool based on the
source port of the traffic. This is done via the SourcePortRanges property on
PSNetworkSecurityGroupRule .
When running a container, Batch now supports executing the task in the container
working directory or in the Batch task working directory. This is controlled by the
WorkingDirectory property on PSTaskContainerSettings .
Added ability to specify a collection of public IPs on PSNetworkConfiguration via the
new PublicIPs property. This guarantees nodes in the Pool will have an IP from the
list user provided IPs.
When not specified, the default value of WaitForSuccess on PSSTartTask is now
$True (was $False ).
When not specified, the default value of Scope on PSAutoUserSpecification is now
Pool (was Task on Windows and Pool on Linux).
Az.Cdn
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
Move FileUris of custom script extension from public setting to protected setting
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 passing the original syncflag for badoffset recovery
Fix EnumerateDirectory to retrieve continuation token once response is checked
Fix Concat Bug
Az.FrontDoor
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.
Fixed cmdlet Get-AzHDInsightProperties to support get capabilities information
from a specific location.
Removed parameter sets('Spark1', 'Spark2') from Add-AzHDInsightConfigValue.
Add examples to the help documents of cmdlet Add-AzHDInsightSecurityProfile.
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.
Added some scenario test cases.
Remove some alias: 'Add-AzHDInsightConfigValues', 'Get-AzHDInsightProperties'.
Az.IotHub
Breaking changes:
The cmdlet 'Add-AzIotHubEventHubConsumerGroup' no longer supports the
parameter 'EventHubEndpointName' and no alias was found for the original
parameter name.
The parameter set '__AllParameterSets' for cmdlet 'Add-
AzIotHubEventHubConsumerGroup' has been removed.
The cmdlet 'Get-AzIotHubEventHubConsumerGroup' no longer supports the
parameter 'EventHubEndpointName' and no alias was found for the original
parameter name.
The parameter set '__AllParameterSets' for cmdlet 'Get-
AzIotHubEventHubConsumerGroup' has been removed.
The property 'OperationsMonitoringProperties' of type
'Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubProperties'
has been removed.
The property 'OperationsMonitoringProperties' of type
'Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubInputProperties'
has been removed.
The cmdlet 'New-AzIotHubExportDevice' no longer supports the alias 'New-
AzIotHubExportDevices'.
The cmdlet 'New-AzIotHubImportDevice' no longer supports the alias 'New-
AzIotHubImportDevices'.
The cmdlet 'Remove-AzIotHubEventHubConsumerGroup' no longer supports the
parameter 'EventHubEndpointName' and no alias was found for the original
parameter name.
The parameter set '__AllParameterSets' for cmdlet 'Remove-
AzIotHubEventHubConsumerGroup' has been removed.
The cmdlet 'Set-AzIotHub' no longer supports the parameter
'OperationsMonitoringProperties' and no alias was found for the original
parameter name.
The parameter set 'UpdateOperationsMonitoringProperties' for cmdlet 'Set-
AzIotHub' has been removed.
Az.RecoveryServices
Azure Site Recovery support to configure networking resources like NSG, public IP
and internal load balancers for Azure to Azure.
Azure Site Recovery Support to write to managed disk for vMWare to Azure.
Azure Site Recovery Support to NIC reduction for vMWare to Azure.
Azure Site Recovery Support to accelerated networking for Azure to Azure.
Azure Site Recovery Support to agent auto update for Azure to Azure.
Azure Site Recovery Support to Standard SSD for Azure to Azure.
Azure Site Recovery Support to Azure Disk Encryption two pass for Azure to Azure.
Azure Site Recovery Support to protect newly added disk for Azure to Azure.
Added SoftDelete feature for VM and added tests for softdelete
Az.Resources
Update dependency assembly Microsoft.Extensions.Caching.Memory from 1.1.1 to
2.2
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.
Fix incorrect parameter description in 'New-AzApplicationGatewaySku' reference
documentation
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 EnableInternetSecurity property for HubVnetConnection,
VpnConnection and ExpressRouteConnection
New cmdlets added:
Update-AzVirtualHubVnetConnection
Cmdlets updated with optional parameters:
New-AzVirtualHubVnetConnection : added parameter EnableInternetSecurity
New-AzVpnConnection : added parameter EnableInternetSecurity
Update-AzVpnConnection : added parameter EnableInternetSecurity
New-AzExpressRouteConnection : added parameter EnableInternetSecurity
Set-AzExpressRouteConnection : added parameter EnableInternetSecurity
Add support for Configuring TopLevel WebApplicationFirewall Policy
New cmdlets added:
New-AzApplicationGatewayFirewallPolicySetting
New-AzApplicationGatewayFirewallPolicyExclusion
New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride
New-AzApplicationGatewayFirewallPolicyManagedRuleOverride
New-AzApplicationGatewayFirewallPolicyManagedRule
New-AzApplicationGatewayFirewallPolicyManagedRuleSet
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
Fix required subnet with name AzureBastionSubnet in 'PSBastion' can be case
insensitive
Support for Destination FQDNs in Network Rules and Translated FQDN in NAT Rules
for Azure Firewall
Add support for top level resource RouteTables of IpGroup
New cmdlets added:
New-AzIpGroup
Remove-AzIpGroup
Get-AzIpGroup
Set-AzIpGroup
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
2.8.0 - October 2019
General
Az.HealthcareApis 1.0.0 release
Az.Accounts
Update telemetry and url rewriting for generated modules, fix windows unit tests.
Az.ApiManagement
Set-AzApiManagementApi - Added support for Updating Api into ApiVersionSet
Fix for issue https://github.com/Azure/azure-powershell/issues/10068
Az.Automation
Fixed New-AzureAutomationSoftwareUpdateConfiguration cmdlet for Linux reboot
setting parameter.
Az.Batch
Az.Compute
Add Priority, EvictionPolicy, and MaxPrice parameters to New-AzVM and New-
AzVmss cmdlets
Fix warning message and help document for Add-AzVMAdditionalUnattendContent
and Add-AzVMSshPublicKey cmdlets
Fix -skipVmBackup exception for Linux VMs with managed disks for Set-
AzVMDiskEncryptionExtension.
Fix bug in update encryption settings in Set-AzVMDiskEncryptionExtension, two
pass scenario.
Az.DataFactory
Az.DataLakeStore
Fix account validation so that accounts with '-' can be passed without domain
Az.HealthcareApis
Az.IotHub
Add new routing source: DigitalTwinChangeEvents
Minor bug fix: Get-AzIothub not returning subscriptionId
Az.Monitor
New action group receivers added for action group
-ItsmReceiver
-VoiceReceiver
-
ArmRoleReceiver
-AzureFunctionReceiver
-LogicAppReceiver
-
AutomationRunbookReceiver
-AzureAppPushReceiver
Use common alert schema enabled for the receivers. This is not applicable for SMS,
Azure App push , ITSM and Voice recievers
Webhooks now supports Azure active directory authentication .
Az.Network
Add new cmdlet Get-AzAvailableServiceAlias which can be called to get the aliases
that can be used for Service Endpoint Policies.
Added support for the adding traffic selectors to Virtual Network Gateway
Connections
New cmdlets added:
New-AzureRmTrafficSelectorPolicy
Cmdlets updated with optional parameter -TrafficSelectorPolicies
-New-
AzVirtualNetworkGatewayConnection
-Set-AzVirtualNetworkGatewayConnection
Add support for ESP and AH protocols in network security rule configurations
Updated cmdlets:
Add-AzNetworkSecurityRuleConfig
New-AzNetworkSecurityRuleConfig
Set-AzNetworkSecurityRuleConfig
Improve handling of exceptions in Cortex cmdlets
New Generations and SKUs for VirtualNetworkGateways
Introduce new Generations for VirtualNetworkGateways.
Introduce new high throughput SKUs for VirtualNetworkGateways.
Az.RedisCache
Updated 'Set-AzRedisCache' reference documentation to include missing values for
'-Size' parameter
Az.Sql
Az.Storage
Az.StorageSync
Fix Issue 9810 in Reset-AzStorageSyncServerCertificate.
Az.Websites
Set-AzWebApp updating ASP of an app was failing
Az.Automation
Fixed example typo in reference documentation for 'Register-
AzAutomationDscNode'
Added clarification on OS restriction to Register-AzAutomationDSCNode
Fixed Start-AzAutomationRunbook cmdlet Null reference exception for -Wait
option.
Az.Compute
Az.DataFactory
Az.HDInsight
Az.IotHub
Add support to invoke failover for an IotHub to the geo-paired disaster recovery
region.
Add support to manage message enrichment for an IotHub. New cmdlets are:
Add-AzIotHubMessageEnrichment
Get-AzIotHubMessageEnrichment
Remove-AzIotHubMessageEnrichment
Set-AzIotHubMessageEnrichment
Az.Monitor
Cmdlets will accept 'Location' paramater in both formats, either the location (e.g.
eastus) or the location display name (e.g. East US)
Illustrated 'Enabled' parameter in help files properly
Added examples for 'ActionGroup' optional parameter
Overall improved help files
Az.RecoveryServices
Az.Resources
Fix bug where New-AzRoleAssignment could not be called without parameter
Scope.
Az.ServiceFabric
Fixed typo in example for 'Update-AzServiceFabricReliability' reference
documentation
Adding new cmdlets to manage appliaction and services:
New-AzServiceFabricApplication
New-AzServiceFabricApplicationType
New-AzServiceFabricApplicationTypeVersion
New-AzServiceFabricService
Update-AzServiceFabricApplication
Get-AzServiceFabricApplication
Get-AzServiceFabricApplicationType
Get-AzServiceFabricApplicationTypeVersion
Get-AzServiceFabricService
Remove-AzServiceFabricApplication
Remove-AzServiceFabricApplicationType
Remove-AzServiceFabricApplicationTypeVersion
Remove-AzServiceFabricServic
Upgraded Service Fabric SDK to version 1.2.0 which uses service fabric resource
provider api-version 2019-03-01.
Az.SignalR
Add Update, Restart, CheckNameAvailability, GetUsage Cmdlets
Az.Sql
Update example in reference documentation for 'Get-AzSqlElasticPool'
Added vCore example to creating an elastic pool (New-AzSqlElasticPool).
Remove the validation of EmailAddresses and the check that EmailAdmins is not
false in case EmailAddresses is empty in Set-
AzSqlServerAdvancedThreatProtectionPolicy and Set-
AzSqlDatabaseAdvancedThreatProtectionPolicy
Enabled removal of server/database auditing settings when multiple diagnostic
settings that enable audit category exist.
Fix email addresses validation in multiple Sql Vulnerability Assessment cmdlets
(Update-AzSqlDatabaseVulnerabilityAssessmentSetting, Update-
AzSqlServerVulnerabilityAssessmentSetting, Update-
AzSqlInstanceDatabaseVulnerabilityAssessmentSetting and Update-
AzSqlInstanceVulnerabilityAssessmentSetting).
Az.Storage
Updated example in reference documentation for 'Get-AzStorageAccountKey'
In upload/Downalod Azure File,support perserve the source File SMB properties (File
Attributtes, File Creation Time, File Last Write Time) in the destination file
Set-AzStorageFileContent
Get-AzStorageFileContent
Fix Upload block blob with properties/metadate fail on container enabled
ImmutabilityPolicy.
Set-AzStorageBlobContent
Support manage Azure File shares with Management plane API
New-AzRmStorageShare
Get-AzRmStorageShare
Update-AzRmStorageShare
Remove-AzRmStorageShare
Az.Websites
Fixing issue where webapp Tags were getting deleted when migrating App to new
ASPwhere webapp Tags were getting deleted when migrating App to new ASP
Fixing the Publish-AzureWebapp to work across Linux and windows
Update example in 'Get-AzWebAppPublishingProfile' reference documentation
General
Fixed miscellaneous typos across numerous modules
Az.Accounts
Az.Aks
Az.ApiManagement
Az.Batch
Az.Cdn
Az.Compute
Az.DataFactory
Fixed typos in New-AzDataFactoryEncryptValue documentation
Updated ADF .Net SDK version to 4.1.2
Added parameters to Set-AzureRmDataFactoryV2IntegrationRuntime to enable
Self-Hosted Integration Runtime as a proxy for SSIS Integration Runtime:
DataProxyIntegrationRuntimeName
DataProxyStagingLinkedServiceName
DataProxyStagingPath
Az.DataLakeStore
Fixed issue where Get-DataLakeStoreDeletedItem would hang on errors and
remote exceptions
Az.EventHub
Fixed typo VirtualNteworkRule in Set-AzEventHubNetworkRuleSet (#9658 )
Fixed issue where Set-AzEventHubNamespace used PATCH instead of PUT
(#9558 )
Added EnableKafka parameter to Set-AzEventHubNamespace cmdlet
Fixed issue with creating rules with Listen rights (#9786 )
Az.MarketplaceOrdering
Fixed documentation typos
Az.Monitor
Az.Network
Updated New-AzPrivateLinkServiceIpConfig:
Deprecated the parameter PublicIpAddress since this is never used in the server
side.
Added optional parameter Primary that indicates if the current IP configuration
is the primary one
Improved handling of request error exception from SDK
Fixed validation logic for Ipv6 IP Prefix to check for correct IPv6 prefix length
Added parameter set to get by subnet resource id to Get-
AzVirtualNetworkSubnetConfig
Updated description of Location parameter for AzNetworkServiceTag
Az.OperationalInsights
Updated documentation for New-AzOperationalInsightsLinuxSyslogDataSource:
Added example
Updated description for -Name parameter
Added an example for New-AzOperationalInsightsWindowsEventDataSource
Changed the description of the -Name parameter for New-
AzOperationalInsightsWindowsEventDataSource
Az.RecoveryServices
Updated documentation for Get-AzRecoveryServicesBackupJobDetail
Az.Resources
Az.ServiceBus
Az.ServiceFabric
Fixed NullReferenceException when a resource group has a VMSS not related to the
service fabric cluster (#8681 )
Fixed bug where cmdlets failed if virtualNetwork was in a different resource group
than the cluster (#8407 )
Deprecated Add-AzServiceFabricApplicationCertificate cmdlet
Az.Sql
Az.Websites
Added clarification around -AppSettings parameter for Set-AzWebApp and Set-
AzWebAppSlot
Az.Accounts
Update common code to use latest version of ClientRuntime
Az.ApplicationInsights
Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation
Az.Automation
Az.CognitiveServices
Az.Compute
Az.ContainerRegistry
Fix typo in Remove-AzContainerRegistryReplication for Replication parameter
More information here https://github.com/Azure/azure-
powershell/issues/9633
Az.DataFactory
Updated ADF .Net SDK version to 4.1.0
Fix typo in documentation for 'Get-AzDataFactoryV2PipelineRun'
Az.EventHub
Added new cmmdlet added for generating SAS token : New-
AzEventHubAuthorizationRuleSASToken
added verification and error message for authorizationrules rights if only 'Manage'
is assigned
Az.KeyVault
Az.LogicApp
Fix for Get-AzIntegrationAccountMap to list all map types
Added new MapType parameter for filtering
Az.ManagedServices
Az.Network
Az.OperationalInsights
Updated default version for saved searches to be 1.
Fixed custom log null regex handling
Az.RecoveryServices
Update 'Get-AzRecoveryServicesBackupJob.md'
Update 'Get-AzRecoveryServicesBackupContainer.md'
Update 'Get-AzRecoveryServicesVault.md'
Update 'Wait-AzRecoveryServicesBackupJob.md'
Update 'Set-AzRecoveryServicesVaultContext.md'
Update 'Get-AzRecoveryServicesBackupItem.md'
Update 'Get-AzRecoveryServicesBackupRecoveryPoint.md'
Update 'Restore-AzRecoveryServicesBackupItem.md'
Updated service call for Unregistering container for Azure File Share
Update 'Set-AzRecoveryServicesAsrAlertSetting.md'
Az.Resources
Az.ServiceBus
Added new cmmdlet added for generating SAS token : New-
AzServiceBusAuthorizationRuleSASToken
added verification and error message for authorizationrules rights if only 'Manage'
is assigned
Az.Sql
Az.Storage
Az.StorageSync
Adding Invoke-AzStorageSyncChangeDetection cmdlet.
Fix Issue 9551 for honoring TierFilesOlderThanDays
Az.Websites
Fixing a bug where some SiteConfig properties were not returned by Get-
AzWebApp and Set-AzWebApp
Adds a new Location parameter to Get-AzDeletedWebApp and Restore-
AzDeletedWebApp
Fixes a bug with cloning web app slots using New-AzWebApp -
IncludeSourceWebAppSlots
Az.Accounts
Add support for profile cmdlets
Add support for environments and data planes in generated cmdlets
Fix bug where incorrect endpoint was being used in some cases for data plane
cmdlets in Windows PowerShell
Az.Advisor
GA release of Az.Advisor
This module is now included as a part of the roll-up Az module
Az.ApiManagement
Az.Automation
Fixed Set-AzAutomationConnectionFieldValue cmdlet bug to handle string value.
Az.Compute
Add HyperVGeneration parameter to New-AzImageConfig
Az.DataFactory
Updating the output of get activity runs, get pipeline runs, and get trigger runs ADF
cmdlets to support Select-Object pipe.
Az.EventGrid
Az.IotHub
Az.Network
Az.PolicyInsights
Fix null reference issue in Get-AzPolicyState
More information here: https://github.com/Azure/azure-
powershell/issues/9446
Az.OperationalInsights
Az.RecoveryServices
Fix for get-policy command for IaaSVMs
Az.Resources
Fix help text for Get-AzPolicyState -Top parameter
Add client-side paging support for Get-AzPolicyAlias
Add new parameters for Set-AzPolicyAssignment , -PolicyParameters and -
PolicyParametersObject
Az.ServiceBus
Fix for issue #4938 - New-AzServiceBusQueue returns BadRequest when setting
MaxSizeInMegabytes
Az.Sql
Add Instance Failover Group cmdlets from preview release to public release
Support Azure SQL Server\Database Auditing with new cmdlets.
Set-AzSqlServerAudit
Get-AzSqlServerAudit
Remove-AzSqlServerAudit
Set-AzSqlDatabaseAudit
Get-AzSqlDatabaseAudit
Remove-AzSqlDatabaseAudit
Remove email constraints from Vulnerability Assessment settings
Az.Storage
Change 2 parameters '-IndexDocument' and '-ErrorDocument404Path' from
required to optional in cmdlet:
Enable-AzStorageStaticWebsite
Update help of Get-AzStorageBlobContent by add an example
Show more error information when cmdlet failed with StorageException
Support create or update Storage account with Azure Files AAD DS Authentication
New-AzStorageAccount
Set-AzStorageAccount
Support list or close file handles of a file share, file directory or a file
Get-AzStorageFileHandle
Close-AzStorageFileHandle
Az.StorageSync
This module is now included as a part of the roll-up Az module
Az.Accounts
Fix bug with incorrect URL being used in some cases for Functions calls
More information here: https://github.com/Azure/azure-
powershell/issues/8983
Fix Issue with aliases from AzureRM to Az cmdlets
Set-AzureRmVMBootDiagnostics -> Set-AzVMBootDiagnostic
Export-AzureRMLogAnalyticThrottledRequests -> Export-
AzLogAnalyticThrottledRequest
Az.Compute
Az.Dns
Fixed a typo in 'Set-AzDnsZone' help examples.
Az.EventGrid
Updated to use the 2019-06-01 API version.
New cmdlets:
New-AzEventGridDomain
Creates a new Azure Event Grid Domain.
Get-AzEventGridDomain
Gets the details of an Event Grid Domain, or gets a list of all Event Grid
Domains in the current Azure subscription.
Remove-AzEventGridDomain
Removes an Azure Event Grid Domain.
New-AzEventGridDomainKey
Regenerates the shared access key for an Azure Event Grid Domain.
Get-AzEventGridDomainKey
Gets the shared access keys used to publish events to an Event Grid Domain.
New-AzEventGridDomainTopic:
Creates a new Azure Event Grid Domain Topic.
Get-AzEventGridDomainTopic
Gets the details of an Event Grid Domain Topic, or gets a list of all Event Grid
Domain Topics under specific Event Grid Domain in the current Azure
Remove-AzEventGridDomainTopic:
Removes an existing Azure Event Grid Domain Topic.
Updated cmdlets:
New-AzEventGridSubscription/Update-AzEventGridSubscription:
Add new mandatory parameters to support piping for the new Event Grid
Domain and Event Grid Domain Topic to allow creating new event subscription
under these resources.
Add new mandatory parameters for specifying the new Event Grid Domain
name and/or Event Grid Domain Topic name to allow creating new event
subscription under these resources.
Add new Parameter sets for domains and domain topics to allow reusing
existing parameters (e.g., EndPointType, SubjectBeginsWith, etc).
Add new optional parameters for specifying:
Event subscription expiration date,
Advanced filtering parameters.
Add new enum for servicebusqueue as destination.
Disallow usage of 'All' in -IncludedEventType option and replace it with
Get-AzEventGridTopic, Get-AzEventGridDomain, Get-AzEventGridDomainTopic,
Get-AzEventGridSubscription:
Add new optional parameters (Top, ODataQuery and NextLink) to support
results pagination and filtering.
Remove-AzEventGridSubscription
Add new mandatory parameters to support piping for Event Grid Domain and
Event Grid Domain Topic to allow removing existing event subscription under
these resources.
Add new mandatory parameters for specifying the Event Grid Domain name
and/or Event Grid Domain Topic name to allow removing existing event
subscription under these resources.
Az.FrontDoor
New-AzFrontDoorWafMatchConditionObject
Add transforms support and new operator auto-complete value (RegEx)
New-AzFrontDoorWafManagedRuleObject
Add new auto-complete values
Az.Network
Add support for Virtual Network Gateway Resource
New cmdlets
Get-AzVirtualNetworkGatewayVpnClientConnectionHealth
Add AvailablePrivateEndpointType
New cmdlets
Get-AzAvailablePrivateEndpointType
Add PrivatePrivateLinkService
New cmdlets
Get-AzPrivateLinkService
New-AzPrivateLinkService
Remove-AzPrivateLinkService
New-AzPrivateLinkServiceIpConfig
Set-AzPrivateEndpointConnection
Add PrivateEndpoint
New cmdlets
Get-AzPrivateEndpoint
New-AzPrivateEndpoint
Remove-AzPrivateEndpoint
New-AzPrivateLinkServiceConnection
Updated below commands for feature: UseLocalAzureIpAddress flag on
VpnConnection
Updated New-AzVpnConnection: Added optional parameter -
UseLocalAzureIpAddress to indicate that local azure ip address should be used as
source address while initiating connection.
Updated Set-AzVpnConnection: Added optional parameter -
UseLocalAzureIpAddress to indicate that local azure ip address should be used as
source address while initiating connection.
Added readonly field PeeredConnections in ExpressRoute peering.
Added readonly field GlobalReachEnabled in ExpressRoute.
Added breaking change attribute to call out deprecation of AllowGlobalReach field
in ExpressRouteCircuit model
Fixed Issue 8756 Error using TargetListenerID with
AzApplicationGatewayRedirectConfiguration cmdlets
Fixed bug in New-AzApplicationGatewayPathRuleConfig that prevented the rewrite
ruleset from being set.
Fixed displaying of VirtualNetworkTaps in NetworkInterfaceIpConfiguration
Fixed Cortex Get cmdlets for list all part
Fixed VirtualHub reference creation for ExpressRouteGateways, VpnGateway
Added support for Availability Zones in AzureFirewall and NatGateway
Added cmdlet Get-AzNetworkServiceTag
Add support for multiple public IP addresses for Azure Firewall
Updated New-AzFirewall cmdlet:
Added parameter -PublicIpAddress which accepts one or more Public IP
Address objects
Added parameter -VirtualNetwork which accepts a Virtual Network object
Added methods AddPublicIpAddress and RemovePublicIpAddress on firewall
object - these accept a Public IP Address object as input
Deprecated parameters -PublicIpName and -VirtualNetworkName
Updated below commands for feature: Set VpnClient AAD authentication options to
Virtual network gateway resource.
Updated New-AzVirtualNetworkGateway: Added optional parameters
AadTenantUri,AadAudienceId,AadIssuerUri to set VpnClient AAD authentication
options on Gateway.
Updated Set-AzVirtualNetworkGateway: Added optional parameter
AadTenantUri,AadAudienceId,AadIssuerUri to set VpnClient AAD authentication
options on Gateway.
Updated Set-AzVirtualNetworkGateway: Added optional switch parameter
RemoveAadAuthentication to remove VpnClient AAD authentication options
from Gateway.
Az.OperationalInsights
Az.Resources
Az.ServiceFabric
Fix add certificate ByExistingKeyVault getting the wrong thumbprint in some cases
Az.Sql
Az.Storage
Support Kind FileStorage and SkuName Premium_ZRS when create Storage account
New-AzStorageAccount
Clarified description of blob immutability cmdlet
Remove-AzRmStorageContainerImmutabilityPolicy
Az.Websites
Az.Cdn
Az.Compute
Added NoWait parameter that starts the operation and returns immediately, before
the operation is completed.
Updated cmdlets:
Export-AzLogAnalyticRequestRateByInterval
Export-
AzLogAnalyticThrottledRequest
Remove-AzVM
Remove-AzVMAccessExtension
Remove-AzVMAEMExtension
Remove-AzVMChefExtension
Remove-
AzVMCustomScriptExtension
Remove-AzVMDiagnosticsExtension
Remove-
AzVMDiskEncryptionExtension
Remove-AzVMDscExtension
Remove-
AzVMSqlServerExtension
Restart-AzVM
Set-AzVM
Set-AzVMAccessExtension
Set-
AzVMADDomainExtension
Set-AzVMAEMExtension
Set-AzVMBginfoExtension
Set-AzVMChefExtension
Set-AzVMCustomScriptExtension
Set-
AzVMDiagnosticsExtension
Set-AzVMDscExtension
Set-AzVMExtension
Start-
AzVM
Stop-AzVM
Update-AzVM
Az.EventHub
Fix for #9231 - Get-AzEventHubNamespace does not return tags
Fix for #9230 - Get-AzEventHubNamespace returns ResourceGroup instead of
ResourceGroupName
Az.Network
Update ResourceId and InputObject for Nat Gateway
Add alias for ResourceId and InputObject
Az.PolicyInsights
Az.RecoveryServices
Az.ServiceBus
Az.ServiceFabric
Fix typo in error message for 'Update-AzServiceFabricReliability'
Fix missing character in Service Fabric cmdlines
Az.Sql
Add DnsZonePartner Parameter for New-AzureSqlInstance cmdlet to support
AutoDr for Managed Instance.
Deprecating Get-AzSqlDatabaseSecureConnectionPolicy cmdlet
Rename Threat Detection cmdlets to Advanced Threat Protection
New-AzSqlInstance -StorageSizeInGB and -LicenseType parameters are now
optional.
Az.Websites
fixes the issue where using Set-AzWebApp and Set-AzWebAppSlot with -WebApp
property was removing the tags
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 -
nt/service/contoso
'Get-AzApiManagementApiRelease'
Get-AzApiManagementApiRelease -ResourceId
/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManageme
nt/service/contoso/apis/echo-api/releases/releaseId
'Get-AzApiManagementApiVersionSet'
Get-AzApiManagementApiVersionSet -ResourceId
/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManageme
nt/service/constoso/apiversionsets/pathversionset
'Get-AzApiManagementAuthorizationServer'
'Get-AzApiManagementBackend'
Get-AzApiManagementBackend -ResourceId
/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManageme
nt/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
Az.Network
Az.Resources
Add new cmdlet Get-AzDenyAssignment for retrieving deny assignments
Az.Sql
Rename Advanced Threat Protection cmdlets to Advanced Data Security and enable
Vulnerability Assessment by default
Az.CognitiveServices
Az.Compute
Proximity placement group feature.
The following new cmdlets are added:
New-AzProximityPlacementGroup
Get-
AzProximityPlacementGroup
Remove-AzProximityPlacementGroup
The new parameter, ProximityPlacementGroupId, is added to the following
cmdlets:
New-AzAvailabilitySet
New-AzVMConfig
New-AzVmssConfig
StorageAccountType parameter is added to New-AzGalleryImageVersion.
TargetRegion of New-AzGalleryImageVersion can contain StorageAccountType.
SkipShutdown switch parameter is added to Stop-AzVM and Stop-AzVmss
Breaking changes
Set-AzVMBootDiagnostics is changed to Set-AzVMBootDiagnostic.
Export-AzLogAnalyticThrottledRequests is changed to Export-
AzLogAnalyticThrottledRequests.
Az.DeploymentManager
Az.Dns
Az.FrontDoor
AzFrontDoorWafManagedRuleOverrideObject
New-AzFrontDoorMatchConditionObject --> New-
AzFrontDoorWafMatchConditionObject
Az.HDInsight
Removed two cmdlets:
Grant-AzHDInsightHttpServicesAccess
Revoke-AzHDInsightHttpServicesAccess
Added a new cmdlet Set-AzHDInsightGatewayCredential to replace Grant-
AzHDInsightHttpServicesAccess
Update cmdlet Get-AzHDInsightJobOutput to distinguish reader role and hdinsight
operator role:
Users with reader role need to specify 'DefaultStorageAccountKey' parameter
explicitly, otherwise error occurs.
Users with hdinsight operator role will not be affected.
Az.Monitor
Az.Network
Az.PolicyInsights
Support for querying policy evaluation details.
Add '-Expand' parameter to Get-AzPolicyState. Support '-Expand
PolicyEvaluationDetails'.
Az.RecoveryServices
Az.Relay
Fix typos in customer-facing messages
Az.ServiceBus
Added new cmdlets for NetworkRuleSet of Namespace
Az.Storage
Upgrade to Storage Client Library 10.0.1 (the namespace of all objects from this SDK
change from 'Microsoft.WindowsAzure.Storage.' to 'Microsoft.Azure.Storage.')
Upgrade to Microsoft.Azure.Management.Storage 11.0.0, to support new API
version 2019-04-01.
The default Storage account Kind in Create Storage account change from 'Storage'
to 'StorageV2'
New-AzStorageAccount
Change the Storage account cmdlet output Sku.Name to be aligned with input
SkuName by add '-', like 'StandardLRS' change to 'Standard_LRS'
New-AzStorageAccount
Get-AzStorageAccount
Set-AzStorageAccount
Az.Websites
'Kind' property will now be set for PSSite objects returned by Get-AzWebApp
Get-AzWebApp*Metrics and Get-AzAppServicePlanMetrics marked deprecated
Az.Batch
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.Cdn
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.CognitiveServices
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.Compute
Fix issue with AEM installation if resource ids of disks had lowercase resourcegroups
in resource id
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Fix documentation for wildcards
Az.DataFactory
Add SsisProperties if NodeCount not null for managed integration runtime.
Az.DataLakeStore
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.EventGrid
Updated the help text for endpoint to indicate that resources should be created
before using the create/update event subscription cmdlets.
Az.EventHub
Added new cmdlets for NetworkRuleSet of Namespace
Az.HDInsight
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.IotHub
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.KeyVault
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Fix documentation for wildcards
Az.MachineLearning
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.Media
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.Monitor
New cmdlets for GenV2(non classic) metric-based alert rule
New-AzMetricAlertRuleV2DimensionSelection
New-AzMetricAlertRuleV2Criteria
Remove-AzMetricAlertRuleV2
Get-AzMetricAlertRuleV2
Add-AzMetricAlertRuleV2
Updated Monitor SDK to version 0.22.0-preview
Az.Network
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Fix documentation for wildcards
Az.NotificationHubs
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.OperationalInsights
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.PowerBIEmbedded
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.RecoveryServices
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Updated table format for SQL in azure VM
Added alternate method to fetch location in AzureFileShare
Updated ScheduleRunDays in SchedulePolicy object according to timezone
Az.RedisCache
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Az.Resources
Fix documentation for wildcards
Az.Sql
Replace dependency on Monitor SDK with common code
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Enhanced process of multiple columns classification.
Include sku properties (sku name, family, capacity) in response from Get-
AzSqlServerServiceObjective and format as table by default.
Ability to Get-AzSqlServerServiceObjective by location without needing a
preexisting server in the region.
Support for time zone parameter in Managed Instance create.
Fix documentation for wildcards
Az.Websites
fixes the Set-AzWebApp and Set-AzWebAppSlot to not remove the tags on
execution
Updated cmdlets with plural nouns to singular, and deprecated plural names.
Updated the WebSites SDK.
Removed the AdminSiteName property from PSAppServicePlan.
Az.Accounts
Az.AnalysisServices
Az.Automation
Fixed New-AzAutomationSoftwareUpdateConfiguration cmdlet bug for Inclusions.
Now parameter IncludedKbNumber and IncludedPackageNameMask should work.
Bug fix for azure automation update management dynamic group
Az.Compute
Az.ContainerInstance
Fixed issue in the -Command parameter of New-AzContainerGroup which added a
trailing empty argument
Az.DataFactory
Az.Resources
Az.Sql
Az.Storage
Az.Automation
Az.Compute
Az.KeyVault
Az.RecoveryServices
Az.Resources
Update wildcard support for Get-AzResource and Get-AzResourceGroup
Update credentials used when making generic calls to ARM
Az.Sql
Az.Storage
Az.Websites
Fix ARM template bug that breaks cloning all slots using 'New-AzWebApp -
IncludeSourceWebAppSlots'
Az.Accounts
Az.Automation
Fixed issue when retreiving certain monthly schedules in several Azure Automation
cmdlets
Fix Get-AzAutomationDscNode returning just top 20 nodes. Now it returns all nodes
Az.Cdn
Added new Powershell cmdlets for Enable/Disable Custom Domain Https and
deprecated the old ones
Az.Compute
Add wildcard support to Get cmdlets
Az.DataFactory
Updated ADF .Net SDK version to 3.0.1
Az.LogicApp
Az.Network
Az.RecoveryServices
Az.Resources
Add -TemplateObject parameter to deployment cmdlets
More information here: https://github.com/Azure/azure-
powershell/issues/2933
Fix issue when piping the result of Get-AzResource to Set-AzResource
More information here: https://github.com/Azure/azure-
powershell/issues/8240
Fix issue with JSON data type change when running Set-AzResource
More information here: https://github.com/Azure/azure-
powershell/issues/7930
Az.Sql
Updating AuditingEndpointsCommunicator.
Fixing the behavior of an edge case while creating new diagnostic settings.
Az.Storage
Az.AnalysisServices
Az.Automation
Az.CognitiveServices
Az.Compute
Fix issue with ID parameter sets
Update Get-AzVMExtension to list all installed extension if Name parameter is not
provided
Add Tag and ResourceId parameters to Update-AzImage cmdlet
Get-AzVmssVM without instance ID and with InstanceView can list VMSS VMs with
instance view.
Az.DataLakeStore
Add cmdlets for ADL deleted item enumerate and restore
Az.EventHub
Az.KeyVault
Fix tagging on Set-AzKeyVaultSecret
Az.LogicApp
Add in Basic sku for Integration Accounts
Add in XSLT 2.0, XSLT 3.0 and Liquid Map Types
New cmdlets for Integration Account Assemblies
Get-AzIntegrationAccountAssembly
New-AzIntegrationAccountAssembly
Remove-AzIntegrationAccountAssembly
Set-AzIntegrationAccountAssembly
New cmdlets for Integration Account Batch Configuration
Get-AzIntegrationAccountBatchConfiguration
New-AzIntegrationAccountBatchConfiguration
Remove-AzIntegrationAccountBatchConfiguration
Set-AzIntegrationAccountBatchConfiguration
Update Logic App SDK to version 4.1.0
Az.Monitor
Update help for Get-AzMetric
Az.Network
Update help example for Add-AzApplicationGatewayCustomError
Az.OperationalInsights
Additional support for New and Get ApplicationInsights data source.
Added new 'ApplicationInsights' kind to support Get specific and Get all
ApplicationInsights data sources for given workspace.
Added New-AzOperationalInsightsApplicationInsightsDataSource cmdlet for
creating data source by given Application-Insights resource parameters:
subscription Id, resourceGroupName and name.
Az.Resources
Fix for issue https://github.com/Azure/azure-powershell/issues/8166
Fix for issue https://github.com/Azure/azure-powershell/issues/8235
Fix for issue https://github.com/Azure/azure-powershell/issues/6219
Fix bug preventing repeat creation of KeyCredentials
Az.Sql
Add support for SQL DB Hyperscale tier
Fixed bug where restore could fail due to setting unnecessary properties in restore
request
Az.Websites
Correct example in Get-AzWebAppSlotMetrics
Az.Accounts
Az.Compute
AEM extension: Add support for UltraSSD and P60,P70 and P80 disks
Update help description for Set-AzVMBootDiagnostics
Update help description and example for Update-AzImage
Az.RecoveryServices
Az.Resources
Az.Sql
Az.Accounts
Release with correct version of Authentication
Az.AnalysisServices
Release with updated Authentication dependency
Az.RecoveryServices
Release with updated Authentication dependency
Az.Accounts
Add interactive and username/password authentication for Windows PowerShell 5.1
only
Update incorrect online help URLs
Add warning message in PS Core for Uninstall-AzureRm
Az.Aks
Update incorrect online help URLs
Az.Automation
Added support for Python 2 runbooks
Update incorrect online help URLs
Az.Cdn
Update incorrect online help URLs
Az.Compute
Add Invoke-AzVMReimage cmdlet
Add TempDisk parameter to Set-AzVmss
Fix the warning message of New-AzVM
Az.ContainerRegistry
Update incorrect online help URLs
Az.DataFactory
Updated ADF .Net SDK version to 3.0.0
Az.DataLakeStore
Fix issue with ADLS endpoint when using MSI
More information here: https://github.com/Azure/azure-
powershell/issues/7462
Update incorrect online help URLs
Az.IotHub
Add Encoding format to Add-IotHubRoutingEndpoint cmdlet.
Az.KeyVault
Update incorrect online help URLs
Az.Network
Update incorrect online help URLs
Az.Resources
Fix incorrect examples in 'New-AzADAppCredential' and 'New-AzADSpCredential'
reference documentation
Fix issue where path for '-TemplateFile' parameter was not being resolved before
executing resource group deployment cmdlets
Az.Resources: Correct documentation for New-AzPolicyDefinition -Mode default
value
Az.Resources: Fix for issue https://github.com/Azure/azure-
powershell/issues/7522
Az.Resources: Fix for issue https://github.com/Azure/azure-
powershell/issues/5747
Fix formatting issue with 'PSResourceGroupDeployment' object
More information here: https://github.com/Azure/azure-
powershell/issues/2123
Az.ServiceFabric
Rollback when a certificate is added to VMSS model but an exception is thrown this
is to fix bug: https://github.com/Azure/service-fabric-issues/issues/932
Fix some error messages.
Fix create cluster with default ARM template for New-AzServiceFabriCluster which
was not working with migration to Az.
Fix add cluster/application certificate to only add to VM Scale Sets that correspond
to the cluster by checking cluster id in the extension.
Az.SignalR
Update incorrect online help URLs
Az.Sql
Update incorrect online help URLs
Updated parameter description for LicenseType parameter with possible values
Fix for updating managed instance identity not working when it is the only updated
property
Support for custom collation on managed instance
Az.Storage
Az.TrafficManager
Az.Websites
Az.Accounts
Az.Compute
Az.DataLakeStore
Update the sdk version of dataplane to 1.1.14 for SDK fixes.
Fix handling of negative acesstime and modificationtime for getfilestatus and
liststatus, Fix async cancellation token
Az.EventGrid
Updated to use the 2019-01-01 API version.
Update the following cmdlets to support new scenario in 2019-01-01 API version
New-AzEventGridSubscription: Add new optional parameters for specifying:
Event Time-To-Live,
Maximum number of delivery attempts for the events,
Dead letter endpoint.
Update-AzEventGridSubscription: Add new optional parameters for specifying:
Event Time-To-Live,
Maximum number of delivery attempts for the events,
Dead letter endpoint.
Add new enum values (namely, storageQueue and hybridConnection) for
EndpointType option in New-AzEventGridSubscription and Update-
AzEventGridSubscription cmdlets.
Show warning message if creating or updating the event subscription is expected to
entail manual action from user.
Az.IotHub
Az.LogicApp
Az.Resources
Fix parameter set issue when providing '-ODataQuery' and '-ResourceId' parameters
for 'Get-AzResource'
More information here: https://github.com/Azure/azure-
powershell/issues/7875
Fix handling of the -Custom parameter in New/Set-AzPolicyDefinition
Fix typo in New-AzDeployment documentation
Made '-MailNickname' parameter mandatory for 'New-AzADUser'
More information here: https://github.com/Azure/azure-
powershell/issues/8220
Az.SignalR
Fix backward compatibility issue with Az.Accounts module
Az.Sql
Az.Storage
Set the StorageAccountName of Storage context as the real Storage Account Name,
when it's created with Sas Token, OAuth or Anonymous
New-AzStorageContext
Create Sas Token of Blob Snapshot Object with '-FullUri' parameter, fix the returned
Uri to be the sanpshot Uri
New-AzStorageBlobSASToken
Az.Websites
Fixed a date parsing bug in 'Get-AzDeletedWebApp'
Fix backward compatibility issue with Az.Accounts module
General
Beginning with Az version 10.2, Azure PowerShell will no longer include the *.deps.json
files in
the modules' binary because of two major reasons:
Az.Aks
New-AzAksCluster
Az.Compute
New-AzDisk
New-AzVM
New-AzVmss
New-AzWvdScalingPlan
Az.PowerBIEmbedded
Get-AzPowerBIWorkspace
Get-AzPowerBIWorkspaceCollection
Get-AzPowerBIWorkspaceCollectionAccessKey
New-AzPowerBIWorkspaceCollection
Reset-AzPowerBIWorkspaceCollectionAccessKey
Az.RecoveryServices
Get-AzRecoveryServicesVaultSettingsFile
Az.Storage
New-AzDataLakeGen2SasToken
New-AzStorageAccount
New-AzStorageAccountSASToken
New-AzStorageBlobSASToken
New-AzStorageContainerSASToken
New-AzStorageContext
New-AzStorageQueueSASToken
New-AzStorageShareSASToken
New-AzStorageTableSASToken
Set-AzStorageAccount
Azure PowerShell supports several global settings like disabling breaking change
warning messages.
Before Az PowerShell module version 9, there wasn't a centralized or
granular way to configure
global settings for Azure PowerShell.
Centralized configuration
The Az PowerShell module version 9 and higher includes cmdlets for managing the
configuration of
global settings for Azure PowerShell. These *-AzConfig cmdlets are
part of the Az.Accounts
PowerShell module:
Get-AzConfig
Update-AzConfig
Export-AzConfig
Import-AzConfig
Clear-AzConfig
Granular settings
You can apply settings that are only effective in a particular scope. The valid values for
the
Scope parameter are:
Default . Readonly scope where the default value hasn't been changed.
Environment . Readonly scope where the value has been configured via an
environment variable.
Besides scopes, you can apply the settings to all Az PowerShell modules or only a single
module.
With the AppliesTo parameter, you can specify how broad you want the setting
applied. The value
Az indicates the setting is applied to all modules available that are
part of Azure PowerShell.
To disable the breaking change warning message for cmdlets in the Az.Compute
module, use the
Update-AzConfig cmdlet with the DisplayBreakingChangeWarning and
AppliesTo parameters as
shown in the following example.
Azure PowerShell
In this scenario, the breaking change warning message remains active for cmdlets in all
Az
PowerShell modules except Az.Compute.
Default subscription
By default, when you authenticate to Azure, all subscriptions that you can access are
retrieved. The
first subscription that's returned by Azure is used unless you specify a
subscription with
Connect-AzAccount . This behavior can be dangerous, for example if the
first subscription returned
is a production environment.
To configure your default subscription, you use the Update-AzConfig cmdlet with the
DefaultSubscriptionForLogin parameter as shown in the following example.
Azure PowerShell
7 Note
Azure PowerShell
Update-AzConfig -DisplayRegionIdentified $false
Replicating settings
To replicate your settings from one environment to another, you use the Export-
AzConfig cmdlet to
export the settings to a JSON file.
Azure PowerShell
To import your settings, use the Import-AzConfig cmdlet and reference the previously
exported
JSON file.
Azure PowerShell
Clearing configuration
To reset the configuration setting of one or more Azure PowerShell global settings to
the default,
use the Clear-AzConfig cmdlet. In the following example, the
DefaultSubscriptionForLogin
setting is cleared.
Azure PowerShell
Clear-AzConfig -DefaultSubscriptionForLogin
Overview
Az Predictor is a PowerShell
module that helps you navigate the cmdlets and
parameters of the
Az PowerShell module . It provides intelligent
context-aware
suggestions for command completion when using Azure PowerShell.
Requirements
Required configuration for Az Predictor:
PowerShell
Getting started
Install Az Predictor
Install the Az.Tools.Predictor PowerShell module
PowerShell
Enable Az Predictor
1. Enable Az Predictor for the current and future PowerShell sessions.
PowerShell
Enable-AzPredictor -AllSession
PowerShell
PowerShell
7 Note
Uninstallation
Once installed and enabled, Az Predictor is loaded in the PowerShell profile.
To uninstall
the Az.Tools.Predictor module:
PowerShell
pwsh -noprofile
3. Uninstall Az Predictor
PowerShell
4. Close PowerShell
Privacy
Az predictor uses the previous two Az cmdlets to make suggestions and ignores any
cmdlet that's not
part of the Az PowerShell module. Only the names of
cmdlets and
parameters are sent to our API to obtain the suggestion. Parameter values are
discarded.
The resource group name and location used are kept locally and reused with
subsequent cmdlets for
convenience but are never sent to the API. In the preview
version, the module generates and sends
anonymized information about the current
session used for predictions to the API. This information
is used to assess the quality of
suggestions.
Data collection
The current version of Az Predictor collects anonymized information about its usage to
identify
common issues and improve the experience of future releases. Az Predictor
doesn't collect any
private or personal data.
For example, the usage data helps identify inaccurate suggestions and issues like
interferences with
PSReadLine. While we appreciate the insights this data provides, we
understand not everyone wants to
send usage data. You can disable data collection with
the
Disable-AzDataCollection
cmdlet. You can also read our
privacy statement to learn
more.
Use the Az PowerShell module behind a
proxy
Article • 07/04/2023
If a proxy is necessary for HTTP request, the Azure PowerShell team recommends the
following proxy
configuration for different platforms:
Windows System proxy settings Use the system proxy settings (internet
PowerShell options).
5.1
PowerShell Set both HTTP_PROXY and The environment variables should be set
7 on Linux HTTPS_PROXY environment before starting PowerShell, otherwise they
variables, plus optional NO_PROXY may not be respected.
On systems where environment variables are case-sensitive, the variable names may be
all lowercase
or all uppercase. The lowercase names are checked first.
Sign in with Azure PowerShell
Article • 07/04/2023
Azure PowerShell supports several authentication methods. The easiest way to get
started is with
Azure Cloud Shell, which automatically logs you in. With a local
install,
you can sign in interactively through your browser. When writing scripts for automation,
the recommended approach is to use a service principal
with the necessary permissions.
When you restrict sign-in permissions as much as possible for your
use case, you help
keep your Azure resources secure.
Initially, you're signed into the first subscription Azure returns if you have access to
more than
one subscription. Commands are run against this subscription by default. To
change your active
subscription for a session, use the Set-AzContext
cmdlet. To change
your active subscription and have it persist between sessions on the same system,
use
the Select-AzContext cmdlet.
) Important
Your credentials are shared among multiple PowerShell sessions as long as you
remain signed in.
For more information, see Azure PowerShell context objects.
Sign in interactively
To sign in interactively, use the
Connect-AzAccount cmdlet.
Azure PowerShell
Connect-AzAccount
Azure PowerShell
$tenantId = (Get-AzContext).Tenant.Id
Azure PowerShell
Connect-AzAccount -UseDeviceAuthentication
To learn how to create a service principal for use with Azure PowerShell, see
Create an
Azure service principal with Azure PowerShell.
To sign in with a service principal, use the ServicePrincipal parameter of the Connect-
AzAccount
cmdlet. You'll also need the service principal's application ID, sign-in
Password-based authentication
Create a service principal to be used in the examples in this section. For more
information on
creating service principals, see
Create an Azure service principal with
Azure PowerShell.
Azure PowerShell
2 Warning
To get the service principal's credentials as the appropriate object, use the
Get-
Credential cmdlet. This
cmdlet presents a prompt for a username and password. Use the
service principal's applicationID
for the username and convert its secret to plain text
for the password.
Azure PowerShell
# Retrieve the plain text password for use with `Get-Credential` in the next
command.
$sp.PasswordCredentials.SecretText
For automation scenarios, you need to create credentials from a service principal's
AppId and
SecretText :
Azure PowerShell
Make sure that you use good password storage practices when automating service
principal connections.
Certificate-based authentication
Certificate-based authentication requires that Azure PowerShell can retrieve information
from a
local certificate store based on a certificate thumbprint.
Azure PowerShell
Azure PowerShell
Connect-AzAccount -ServicePrincipal -ApplicationId $servicePrincipalId -
Tenant $tenantId -CertificateThumbprint <thumbprint>
In Windows PowerShell 5.1, the certificate store can be managed and inspected with the
PKI module. For PowerShell 7.x and later, the process is more complicated.
The following
scripts show you how to import an existing certificate into the certificate store
accessible
by PowerShell.
PowerShell
# Import a PFX
PowerShell
# Import a PFX
$storeName = [System.Security.Cryptography.X509Certificates.StoreName]::My
$storeLocation =
[System.Security.Cryptography.X509Certificates.StoreLocation]::CurrentUser
$store =
[System.Security.Cryptography.X509Certificates.X509Store]::new($storeName,
$storeLocation)
$flag =
[System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::Exporta
ble
$certificate =
[System.Security.Cryptography.X509Certificates.X509Certificate2]::new($certP
ath, $credentials.Password, $flag)
$store.Open([System.Security.Cryptography.X509Certificates.OpenFlags]::ReadW
rite)
$store.Add($Certificate)
$store.Close()
This example connects using the managed identity of the host environment. For
example, if executed
on a VirtualMachine with an assigned Managed Service Identity,
this allows the code to sign in using
that assigned identity.
Azure PowerShell
Connect-AzAccount -Identity
Azure PowerShell
Azure PowerShell
Connect-AzAccount -Tenant '00000000-0000-0000-0000-000000000000'
Azure PowerShell
Azure PowerShell
Automated tools that use Azure services should always have restricted permissions.
Instead of having
applications sign in as a fully privileged user, Azure offers service
principals.
An Azure service principal is an identity created for use with applications, hosted
services, and
automated tools to access Azure resources. This access is restricted by the
roles assigned to the
service principal, giving you control over which resources can be
accessed and at which level. For
security reasons, it's always recommended to use
service principals with automated tools rather than
allowing them to log in with a user
identity.
This article shows you the steps for creating, getting information about, and resetting a
service
principal with Azure PowerShell.
2 Warning
Prerequisites
If you choose to use Azure PowerShell locally:
Install the Az PowerShell module.
Connect to your Azure account using the
Connect-AzAccount cmdlet.
If you choose to use Azure Cloud Shell:
See Overview of Azure Cloud Shell for more information.
) Important
Beginning with Az PowerShell module version 7.x,
New-AzADServicePrincipal no
longer
assigns the Contributor role to the
service principal by default. To assign a
specific role to a service principal, see
Steps to add a role assignment.
7 Note
There are two types of authentication available for service principals: Password-based
authentication, and certificate-based authentication.
Password-based authentication
) Important
Azure PowerShell
Azure PowerShell
$sp.PasswordCredentials.SecretText
) Important
Signing in with a service principal requires the tenant ID which the service principal
was created
under. To get the active tenant when the service principal was created,
run the following command
immediately after service principal creation:
Azure PowerShell
(Get-AzContext).Tenant.Id
Certificate-based authentication
) Important
Service principals using certificate-based authentication are created with the CertValue
parameter. This parameter takes a base64-encoded ASCII string of the public certificate.
This is
represented by a PEM file, or a text-encoded CRT or CER. Binary encodings of the
public certificate
aren't supported. These instructions assume that you already have a
certificate available.
Azure PowerShell
Signing in with a service principal requires the tenant ID which the service principal
was created
under. To get the active tenant when the service principal was created,
run the following command
immediately after service principal creation:
Azure PowerShell
(Get-AzContext).Tenant.Id
DisplayNameBeginsWith requests service principals that have a prefix that match the
provided
value. The display name of a service principal is the value set with
DisplayName during
creation.
Get-AzRoleAssignment
New-AzRoleAssignment
Remove-AzRoleAssignment
For more information on Role-Based Access Control (RBAC) and roles, see
RBAC: Built-in
roles.
The following example adds the Reader role and removes the Contributor role:
Azure PowerShell
) Important
Role assignment cmdlets don't take the service principal object ID. They take the
associated
application ID, which is generated at creation time. To get the
application ID for a service
principal, use Get-AzADServicePrincipal .
7 Note
If your account doesn't have permission to assign a role, you see an error message
that your
account "doesn't have authorization to perform action
'Microsoft.Authorization/roleAssignments/write'". Contact your Azure Active
Directory admin to
manage roles.
Adding a role doesn't restrict previously assigned permissions. When restricting a service
principal's permissions, the Contributor role should be removed.
Azure PowerShell
Azure PowerShell
$credentials = Get-Credential
Azure PowerShell
Connect-AzAccount -ServicePrincipal -Tenant <TenantId> -
CertificateThumbprint <Thumbprint> -ApplicationId <ApplicationId>
Reset credentials
If you forget the credentials for a service principal, use
New-AzADSpCredential to add a
new credential
with a random password. This cmdlet doesn't support user-defined
credentials when resetting the
password.
) Important
Before assigning any new credentials, you may want to remove existing credentials
to prevent sign
in with them. To do so, use the
Remove-AzADSpCredential cmdlet:
Azure PowerShell
Azure PowerShell
Troubleshooting
If you receive the error: "New-AzADServicePrincipal: Another object with the same value
for
property identifierUris already exists.", verify that a service principal with the same
name
doesn't already exist.
Azure PowerShell
If the existing service principal is no longer needed, you can remove it using the
following
example.
Azure PowerShell
Remove-AzAdServicePrincipal -DisplayName ServicePrincipalName
This error can also occur when you've previously created a service principal for an Azure
Active
Directory application. If you remove the service principal, the application is still
available. This
application prevents you from creating another service principal with the
same name.
You can use the following example to verify that an Azure Active Directory application
with the same
name doesn't exist:
Azure PowerShell
If an application with the same name does exist and is no longer needed, it can be
removed using the
following example.
Azure PowerShell
Otherwise, choose an alternate name for the new service principal that you're
attempting to create.
Azure PowerShell context objects
Article • 07/04/2023
Azure PowerShell uses Azure PowerShell context objects (Azure contexts) to hold
subscription and
authentication information. If you have more than one subscription,
Azure contexts let you select
the subscription to run Azure PowerShell cmdlets on. Azure
contexts are also used to store sign-in
information across multiple PowerShell sessions
and run background tasks.
This article covers managing Azure contexts, not the management of subscriptions or
accounts. If
you're looking to manage users, subscriptions, tenants, or other account
information, see the
Azure Active Directory documentation. To learn about using
contexts for
running background or parallel tasks, see
Run Azure PowerShell cmdlets in
PowerShell Jobs after becoming familiar with
Azure contexts.
When you sign in with Connect-AzAccount , at least one Azure context is created for your
default
subscription. The object returned by Connect-AzAccount is the default Azure
context used for the
rest of the PowerShell session.
Get Azure contexts
Available Azure contexts are retrieved with the
Get-AzContext cmdlet. List the available
contexts
with the ListAvailable parameter:
Azure PowerShell
Get-AzContext -ListAvailable
Azure PowerShell
Context names may be different from the name of the associated subscription.
) Important
The available Azure contexts aren't always your available subscriptions. Azure
contexts only
represent locally stored information. You can get your subscriptions
with the
Get-AzSubscription cmdlet.
Azure PowerShell
Azure PowerShell
Set-AzContext -Name 'MyContextName' -Subscription 'MySubscriptionName' -
Tenant '00000000-0000-0000-0000-000000000000'
If the Name parameter is omitted, then the subscription's name and ID are used as the
context name
in the format Subscription Name (subscription-id).
Select-AzContext is meant to be used only with existing Azure contexts and works
similarly to
using Set-AzContext -Context , but is designed for use with piping:
Azure PowerShell
Like many other account and context management commands in Azure PowerShell,
Set-AzContext and
Select-AzContext support the Scope parameter so that you can
control how long the context is
active. Scope lets you change a single session's active
context without changing your default:
Azure PowerShell
Azure PowerShell
The other main use of contexts with Azure PowerShell cmdlets is to run background
commands. To learn
more about running PowerShell Jobs using Azure PowerShell, see
Run Azure PowerShell cmdlets in PowerShell Jobs.
Azure PowerShell
The Azure context returned as part of this sign in is valid for the current session
only and
won't be saved automatically, regardless of the Azure PowerShell context
autosave setting.
Azure PowerShell
2 Warning
Disabling context autosave doesn't clear any stored context information that was
saved. To remove
stored information, use the Clear-AzContext
cmdlet. For more on
removing saved contexts, see
Remove contexts and credentials.
Each of these commands supports the Scope parameter, which can take a value of
Process to only
apply to the current running process. For example, to ensure that newly
created contexts aren't
saved after exiting a PowerShell session:
Azure PowerShell
Azure PowerShell
Azure PowerShell
If you remove the active context, you'll be disconnected from Azure and need to
reauthenticate
with Connect-AzAccount .
See also
Run Azure PowerShell cmdlets in PowerShell Jobs
Azure Active Directory Terminology
Az.Accounts reference documentation
Use multiple Azure subscriptions
Article • 07/04/2023
Most Azure users only have a single subscription. However, if you are part of more than
one
organization or your organization has divided up access to certain resources across
groupings, you
may have multiple subscriptions within Azure.
For detailed information on subscriptions, billing, and cost management, see the
billing
and cost management documentation.
To learn more about the differences between tenants, users, and subscriptions, see the
Azure cloud terminology dictionary. To learn how to add a
new subscription to your
Azure Active Directory tenant, see
Associate or add an Azure subscription to your Azure
Active Directory tenant.
To learn how to sign in to a specific tenant, see
Sign in with
Azure PowerShell.
The following example shows how to change the context in your current Azure session:
Azure PowerShell
To learn more about Azure PowerShell contexts, including how to save them and switch
between them
for working with multiple subscriptions, see
Persist credentials with Azure
PowerShell contexts.
Manage Azure resources with Invoke-
AzRestMethod
Article • 07/04/2023
This cmdlet is useful when you want to manage Azure services for features that aren't
yet available
in the Az PowerShell module.
Azure PowerShell
$getParams = @{
ResourceGroupName = 'myresourcegroup'
ResourceProviderName = 'Microsoft.ContainerRegistry'
ResourceType = 'registries'
Name = 'myacr'
ApiVersion = '2019-12-01-preview'
Method = 'GET'
Invoke-AzRestMethod @getParams
Using a mapping based on the position in the array, the cmdlet constructs the following
resource:
Id:'/workspaces/my-la/savedsearches/my-search' .
The APIVersion parameter allows you to use a specific API version, including preview
ones. The
supported API versions for Azure Resource providers can be found in the
azure-rest-api-specs GitHub repository.
You can find the definition for the 2019-12-01-preview ACR API version in the following
location:
azure-rest-api-specs/specification/containerregistry/resource-
manager/Microsoft.ContainerRegistry/preview/ .
To disable the public network access, you need to make a PATCH call to the API that
changes the
value of the publicNetwokAccess parameter as shown in the following
example:
Azure PowerShell
$patchParams = @{
ResourceGroupName = 'myresourcegroup'
Name = 'myacr'
ResourceProviderName = 'Microsoft.ContainerRegistry'
ResourceType = 'registries'
ApiVersion = '2019-12-01-preview'
"publicNetworkAccess": "Disabled"
} }'
Method = 'PATCH'
Invoke-AzRestMethod @patchParams
The Payload property is a JSON string that shows the path of the property to be
modified.
All the parameters for this API are described in the rest-api-spec file associated with this
API.
The specific definition for the publicNetworkAccess parameter can be found in the
container registry JSON file
for the 2019-12-01-preview API version.
To only allow access to the registry from a specific IP address, the payload needs to be
modified as
shown in the following example:
Azure PowerShell
$specificIpParams = @{
ResourceGroupName = 'myresourcegroup'
Name = 'myacr'
ResourceProviderName = 'Microsoft.ContainerRegistry'
ResourceType = 'registries'
ApiVersion = '2019-12-01-preview'
"networkRuleSet": {
"defaultAction": "Deny",
"ipRules": [ {
"action": "Allow",
"value": "24.22.123.123"
} ]
} }'
Method = 'PATCH'
Invoke-AzRestMethod @specificIpParams
example, you
can build a JSON string and use it to customize the REST API call without
having to pre-create any
PSObjects .
If you're already familiar with the *-AzResource cmdlets, you can continue using them.
We've no
plans to stop supporting them. With Invoke-AzRestMethod , we've added a new
cmdlet to your toolkit.
See Also
Get-AzResource
New-AzResource
Remove-AzResource
Query output of Azure PowerShell
Article • 07/04/2023
The results of each Azure PowerShell cmdlet are an Azure PowerShell object. Even
cmdlets that aren't
explicitly Get- operations might return a value that can be inspected,
to give information about a
resource that was created or modified. While most cmdlets
return a single object, some return an
array that should be iterated through.
Azure PowerShell
Select-Object -Property *
Output
ResourceGroupName : TESTGROUP
Id : /subscriptions/00000000-0000-0000-0000-
000000000000/resourceGroups/TESTGROUP/providers/Micro
soft.Compute/virtualMachines/TestVM
VmId : 00000000-0000-0000-0000-000000000000
Name : TestVM
Type : Microsoft.Compute/virtualMachines
Location : westus2
LicenseType :
Tags : {}
AvailabilitySetReference :
DiagnosticsProfile :
Extensions : {}
HardwareProfile :
Microsoft.Azure.Management.Compute.Models.HardwareProfile
InstanceView :
NetworkProfile :
Microsoft.Azure.Management.Compute.Models.NetworkProfile
OSProfile :
Microsoft.Azure.Management.Compute.Models.OSProfile
Plan :
ProvisioningState : Succeeded
StorageProfile :
Microsoft.Azure.Management.Compute.Models.StorageProfile
DisplayHint : Compact
Identity :
Zones : {}
FullyQualifiedDomainName :
AdditionalCapabilities :
RequestId : 00000000-0000-0000-0000-000000000000
StatusCode : OK
Once you know the names of the properties that you're interested in, you can use those
property
names with Select-Object to get them directly:
Azure PowerShell
Output
Azure PowerShell
Output
Name OSType
---- ------
TestVM Linux
TestVM2 Linux
WinVM Windows
Each dictionary argument selects one property from the object. The property to extract
must be part
of an expression.
Filter results
The Where-Object cmdlet allows you to filter the result based on any property value,
including
nested properties. The next example shows how to use Where-Object to find
the Linux VMs in a
resource group.
Azure PowerShell
Output
You can pipe the results of Select-Object and Where-Object to each other. For
performance
purposes, it's always recommended to put the Where-Object operation
before Select-Object :
Azure PowerShell
Output
By default each Azure PowerShell cmdlet formats output to be easy to read. PowerShell
allows you to
convert or format cmdlet output by piping to one of the following
cmdlets:
Formatting Conversion
Format-Custom ConvertTo-Csv
Format-List ConvertTo-Html
Format-Table ConvertTo-Json
Format-Wide ConvertTo-Xml
Formatting is used for display in the PowerShell console, and conversion is used for
generating data
to be consumed by other scripts or programs.
Azure PowerShell
Get-AzVM
Output
The amount of data displayed by Format-Table can be affected by the width of your
PowerShell
session window. To restrict the output to specific properties and order them,
property names can be
provided as arguments to Format-Table :
Azure PowerShell
Output
Azure PowerShell
Get-AzVM | Format-List
Output
ResourceGroupName : QueryExample
Id :
/subscriptions/.../resourceGroups/QueryExample/providers/Microsoft.Compute/v
irtualMachines/ExampleLinuxVM
VmId : ...
Name : ExampleLinuxVM
Type : Microsoft.Compute/virtualMachines
Location : westus2
...
HardwareProfile :
Microsoft.Azure.Management.Compute.Models.HardwareProfile
InstanceView :
NetworkProfile :
Microsoft.Azure.Management.Compute.Models.NetworkProfile
OSProfile :
Microsoft.Azure.Management.Compute.Models.OSProfile
...
StatusCode : OK
ResourceGroupName : QueryExample
Id :
/subscriptions/.../resourceGroups/QueryExample/providers/Microsoft.Compute/v
irtualMachines/RHELExample
VmId : ...
Name : RHELExample
Type : Microsoft.Compute/virtualMachines
Location : westus2
...
Like Format-Table , property names can be provided to order and restrict the output:
Azure PowerShell
Output
ResourceGroupName : QueryExample
Name : ExampleLinuxVM
Location : westus2
ResourceGroupName : QueryExample
Name : RHELExample
Location : westus2
ResourceGroupName : QueryExample
Name : WinExampleVM
Location : westus2
Azure PowerShell
Get-AzVM | Format-Wide
Output
ExampleLinuxVM RHELExample
WinExampleVM
Azure PowerShell
Get-AzVM | Format-Wide -Property ResourceGroupName
Output
QueryExample QueryExample
QueryExample
Azure PowerShell
Get-AzVM | Format-Custom
Output
ResourceGroupName : QueryExample
Id :
/subscriptions/.../resourceGroups/QueryExample/providers/Microsoft.Compute/v
irtualMachines/ExampleLinuxVM
VmId : ...
Name : ExampleLinuxVM
Type : Microsoft.Compute/virtualMachines
Location : westus2
Tags : {}
HardwareProfile : {VmSize}
NetworkProfile : {NetworkInterfaces}
AllowExtensionOperations}
ProvisioningState : Succeeded
...
Azure PowerShell
Output
class PSVirtualMachineList
Name = ExampleLinuxVM
ResourceGroupName = QueryExample
Location = westus2
OSProfile =
class OSProfile
ComputerName = ExampleLinuxVM
AdminUsername = ...
AdminPassword =
CustomData =
WindowsConfiguration =
LinuxConfiguration =
class LinuxConfiguration
DisablePasswordAuthentication = False
Ssh =
ProvisionVMAgent = True
}
Secrets =
AllowExtensionOperations = True
...
class PSVirtualMachineList
Name = WinExampleVM
ResourceGroupName = QueryExample
Location = westus2
OSProfile =
class OSProfile
ComputerName = WinExampleVM
AdminUsername = ...
AdminPassword =
CustomData =
WindowsConfiguration =
class WindowsConfiguration
ProvisionVMAgent = True
EnableAutomaticUpdates = True
TimeZone =
AdditionalUnattendContent =
WinRM =
LinuxConfiguration =
Secrets =
AllowExtensionOperations = True
Conversion to CSV
Azure PowerShell
Get-AzVM | ConvertTo-CSV
Output
#TYPE Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineList
"ResourceGroupName","Id","VmId","Name","Type","Location","LicenseType","Tags
","AvailabilitySetReference","DiagnosticsProfile","Extensions","HardwareProf
ile","InstanceView","NetworkProfile","OSProfile","Plan","ProvisioningState",
"StorageProfile","DisplayHint","Identity","Zones","FullyQualifiedDomainName"
,"AdditionalCapabilities","RequestId","StatusCode"
"QUERYEXAMPLE","/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Mic
rosoft.Compute/virtualMachines/ExampleLinuxVM","...","ExampleLinuxVM","Micro
soft.Compute/virtualMachines","westus2",,"System.Collections.Generic.Diction
ary`2[System.String,System.String]",,,"System.Collections.Generic.List`1[Mic
rosoft.Azure.Management.Compute.Models.VirtualMachineExtension]","Microsoft.
Azure.Management.Compute.Models.HardwareProfile",,"Microsoft.Azure.Managemen
t.Compute.Models.NetworkProfile","Microsoft.Azure.Management.Compute.Models.
OSProfile",,"Succeeded","Microsoft.Azure.Management.Compute.Models.StoragePr
ofile","Compact",,"System.Collections.Generic.List`1[System.String]",,,"..."
,"OK"
"QUERYEXAMPLE","/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Mic
rosoft.Compute/virtualMachines/RHELExample","...","RHELExample","Microsoft.C
ompute/virtualMachines","westus2",,"System.Collections.Generic.Dictionary`2[
System.String,System.String]",,,"System.Collections.Generic.List`1[Microsoft
.Azure.Management.Compute.Models.VirtualMachineExtension]","Microsoft.Azure.
Management.Compute.Models.HardwareProfile",,"Microsoft.Azure.Management.Comp
ute.Models.NetworkProfile","Microsoft.Azure.Management.Compute.Models.OSProf
ile",,"Succeeded","Microsoft.Azure.Management.Compute.Models.StorageProfile"
,"Compact",,"System.Collections.Generic.List`1[System.String]",,,"...","OK"
"QUERYEXAMPLE","/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Mic
rosoft.Compute/virtualMachines/WinExampleVM","...","WinExampleVM","Microsoft
.Compute/virtualMachines","westus2",,"System.Collections.Generic.Dictionary`
2[System.String,System.String]",,,"System.Collections.Generic.List`1[Microso
ft.Azure.Management.Compute.Models.VirtualMachineExtension]","Microsoft.Azur
e.Management.Compute.Models.HardwareProfile",,"Microsoft.Azure.Management.Co
mpute.Models.NetworkProfile","Microsoft.Azure.Management.Compute.Models.OSPr
ofile",,"Succeeded","Microsoft.Azure.Management.Compute.Models.StorageProfil
e","Compact",,"System.Collections.Generic.List`1[System.String]",,,"...","OK
"
Conversion to JSON
JSON output doesn't expand all properties by default. To change the depth of properties
expanded,
use the Depth parameter. By default, the expansion depth is 2 .
Azure PowerShell
Get-AzVM | ConvertTo-JSON
Output
"ResourceGroupName": "QUERYEXAMPLE",
"Id":
"/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/
virtualMachines/ExampleLinuxVM",
"VmId": "...",
"Name": "ExampleLinuxVM",
"Type": "Microsoft.Compute/virtualMachines",
"Location": "westus2",
...
"OSProfile": {
"ComputerName": "ExampleLinuxVM",
"AdminUsername": "...",
"AdminPassword": null,
"CustomData": null,
"WindowsConfiguration": null,
"LinuxConfiguration":
"Microsoft.Azure.Management.Compute.Models.LinuxConfiguration",
"Secrets": "",
"AllowExtensionOperations": true
},
"Plan": null,
"ProvisioningState": "Succeeded",
"StorageProfile": {
"ImageReference":
"Microsoft.Azure.Management.Compute.Models.ImageReference",
"OsDisk":
"Microsoft.Azure.Management.Compute.Models.OSDisk",
"DataDisks": ""
},
"DisplayHint": 0,
"Identity": null,
"Zones": [
],
"FullyQualifiedDomainName": null,
"AdditionalCapabilities": null,
"RequestId": "...",
"StatusCode": 200
},
...
Conversion to XML
The ConvertTo-XML cmdlet converts the Azure PowerShell response object into a pure
XML object,
which can be handled like any other XML object within PowerShell.
Azure PowerShell
Get-AzVM | ConvertTo-XML
Output
xml Objects
--- -------
Conversion to HTML
Converting an object to HTML produces output that's rendered as an HTML table.
Rendering of the HTML
depends on your browser behavior for rendering tables which
contain no width information. No custom
class objects are expanded.
Azure PowerShell
Get-AzVM | ConvertTo-HTML
Output
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>HTML TABLE</title>
</head><body>
<table>
<colgroup><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/>
<col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/>
<col/><col/></colgroup>
<tr><th>ResourceGroupName</th><th>Id</th><th>VmId</th><th>Name</th>
<th>Type</th><th>Location</th><th>LicenseType</th><th>Tags</th>
<th>AvailabilitySetReference</th><th>DiagnosticsProfile</th>
<th>Extensions</th><th>HardwareProfile</th><th>InstanceView</th>
<th>NetworkProfile</th><th>OSProfile</th><th>Plan</th>
<th>ProvisioningState</th><th>StorageProfile</th><th>DisplayHint</th>
<th>Identity</th><th>Zones</th><th>FullyQualifiedDomainName</th>
<th>AdditionalCapabilities</th><th>RequestId</th><th>StatusCode</th></tr>
<tr><td>QUERYEXAMPLE</td>
<td>/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compu
te/virtualMachines/ExampleLinuxVM</td><td>...</td><td>ExampleLinuxVM</td>
<td>Microsoft.Compute/virtualMachines</td><td>westus2</td><td></td>
<td>System.Collections.Generic.Dictionary`2[System.String,System.String]
</td><td></td><td></td>
<td>System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Mod
els.VirtualMachineExtension]</td>
<td>Microsoft.Azure.Management.Compute.Models.HardwareProfile</td><td></td>
<td>Microsoft.Azure.Management.Compute.Models.NetworkProfile</td>
<td>Microsoft.Azure.Management.Compute.Models.OSProfile</td><td></td>
<td>Succeeded</td>
<td>Microsoft.Azure.Management.Compute.Models.StorageProfile</td>
<td>Compact</td><td></td>
<td>System.Collections.Generic.List`1[System.String]</td><td></td><td></td>
<td>...</td><td>OK</td></tr>
<tr><td>QUERYEXAMPLE</td>
<td>/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compu
te/virtualMachines/RHELExample</td><td>...</td><td>RHELExample</td>
<td>Microsoft.Compute/virtualMachines</td><td>westus2</td><td></td>
<td>System.Collections.Generic.Dictionary`2[System.String,System.String]
</td><td></td><td></td>
<td>System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Mod
els.VirtualMachineExtension]</td>
<td>Microsoft.Azure.Management.Compute.Models.HardwareProfile</td><td></td>
<td>Microsoft.Azure.Management.Compute.Models.NetworkProfile</td>
<td>Microsoft.Azure.Management.Compute.Models.OSProfile</td><td></td>
<td>Succeeded</td>
<td>Microsoft.Azure.Management.Compute.Models.StorageProfile</td>
<td>Compact</td><td></td>
<td>System.Collections.Generic.List`1[System.String]</td><td></td><td></td>
<td>...</td><td>OK</td></tr>
<tr><td>QUERYEXAMPLE</td>
<td>/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compu
te/virtualMachines/WinExampleVM</td><td>...</td><td>WinExampleVM</td>
<td>Microsoft.Compute/virtualMachines</td><td>westus2</td><td></td>
<td>System.Collections.Generic.Dictionary`2[System.String,System.String]
</td><td></td><td></td>
<td>System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Mod
els.VirtualMachineExtension]</td>
<td>Microsoft.Azure.Management.Compute.Models.HardwareProfile</td><td></td>
<td>Microsoft.Azure.Management.Compute.Models.NetworkProfile</td>
<td>Microsoft.Azure.Management.Compute.Models.OSProfile</td><td></td>
<td>Succeeded</td>
<td>Microsoft.Azure.Management.Compute.Models.StorageProfile</td>
<td>Compact</td><td></td>
<td>System.Collections.Generic.List`1[System.String]</td><td></td><td></td>
<td>...</td><td>OK</td></tr>
</table>
</body></html>
Azure PowerShell depends on connecting to an Azure cloud and waiting for responses,
so most of these
cmdlets block your PowerShell session until they get a response from
the cloud. PowerShell Jobs let
you run cmdlets in the background or do multiple tasks
on Azure at once, from inside a single
PowerShell session.
This article is a brief overview of how to run Azure PowerShell cmdlets as PowerShell
Jobs and check
for completion. Running commands in Azure PowerShell requires the
use of Azure PowerShell contexts,
which are covered in detail in Azure contexts and
sign-in credentials. To
learn more about PowerShell Jobs, see
About PowerShell Jobs.
Azure PowerShell
$vmadmin = Get-Credential
Start-Job {
Provide an Azure context object with any Azure PowerShell cmdlet that has an
AzContext
parameter:
Azure PowerShell
$vmadmin = Get-Credential
$job = Start-Job {
Use the AsJob parameter provided by some Azure PowerShell cmdlets. This switch
automatically
starts the cmdlet as a PowerShell Job, using the active Azure context:
Azure PowerShell
$vmadmin = Get-Credential
To see if a cmdlet supports AsJob, check its reference documentation. The AsJob
parameter
doesn't require context autosave to be enabled.
To check an operation's progress remotely on Azure, use the Get cmdlets associated
with the type
of resource being modified by the job:
Azure PowerShell
$vmadmin = Get-Credential
$vmName = 'MyVm'
$job = Start-Job {
See Also
Azure PowerShell contexts
About PowerShell Jobs
Get-Job
Receive-Job
The Using: scope modifier
Deploy resources with ARM templates
and Azure PowerShell
Article • 05/22/2023
This article explains how to use Azure PowerShell with Azure Resource Manager
templates (ARM templates) to deploy your resources to Azure. If you aren't familiar with
the concepts of deploying and managing your Azure solutions, see template
deployment overview.
Tip
Prerequisites
You need a template to deploy. If you don't already have one, download and save an
example template from the Azure Quickstart templates repo. The local file name used
in this article is C:\MyTemplates\azuredeploy.json.
Install Azure PowerShell cmdlets on your local computer. For more information,
see Get started with Azure PowerShell.
Connect to Azure by using Connect-AZAccount. If you have multiple Azure
subscriptions, you might also need to run Set-AzContext. For more information,
see Use multiple Azure subscriptions.
If you don't have PowerShell installed, you can use Azure Cloud Shell. For more
information, see Deploy ARM templates from Azure Cloud Shell.
Required permissions
To deploy a Bicep file or ARM template, you need write access on the resources you're
deploying and access to all operations on the Microsoft.Resources/deployments
resource type. For example, to deploy a virtual machine, you need
Microsoft.Compute/virtualMachines/write and Microsoft.Resources/deployments/*
permissions. The what-if operation has the same permission requirements.
For a list of roles and permissions, see Azure built-in roles.
Deployment scope
You can target your deployment to a resource group, subscription, management group,
or tenant. Depending on the scope of the deployment, you use different commands.
Azure PowerShell
Azure PowerShell
For more information about subscription level deployments, see Create resource
groups and resources at the subscription level.
Azure PowerShell
For more information about management group level deployments, see Create
resources at the management group level.
Azure PowerShell
For more information about tenant level deployments, see Create resources at the
tenant level.
For every scope, the user deploying the template must have the required permissions to
create resources.
Deployment name
When deploying an ARM template, you can give the deployment a name. This name can
help you retrieve the deployment from the deployment history. If you don't provide a
name for the deployment, the name of the template file is used. For example, if you
deploy a template named azuredeploy.json and don't specify a deployment name, the
deployment is named azuredeploy .
Every time you run a deployment, an entry is added to the resource group's deployment
history with the deployment name. If you run another deployment and give it the same
name, the earlier entry is replaced with the current deployment. If you want to maintain
unique entries in the deployment history, give each deployment a unique name.
Azure PowerShell
Azure PowerShell
$deploymentName="ExampleDeployment"+"$today"
If you run concurrent deployments to the same resource group with the same
deployment name, only the last deployment is completed. Any deployments with the
same name that haven't finished are replaced by the last deployment. For example, if
you run a deployment named newStorage that deploys a storage account named
storage1 , and at the same time run another deployment named newStorage that
deploys a storage account named storage2 , you deploy only one storage account. The
resulting storage account is named storage2 .
However, if you run a deployment named newStorage that deploys a storage account
named storage1 , and immediately after it completes you run another deployment
named newStorage that deploys a storage account named storage2 , then you have two
storage accounts. One is named storage1 , and the other is named storage2 . But, you
only have one entry in the deployment history.
When you specify a unique name for each deployment, you can run them concurrently
without conflict. If you run a deployment named newStorage1 that deploys a storage
account named storage1 , and at the same time run another deployment named
newStorage2 that deploys a storage account named storage2 , then you have two
To avoid conflicts with concurrent deployments and to ensure unique entries in the
deployment history, give each deployment a unique name.
If you're deploying to a resource group that doesn't exist, create the resource group.
The name of the resource group can only include alphanumeric characters, periods,
underscores, hyphens, and parenthesis. It can be up to 90 characters. The name can't
end in a period.
Azure PowerShell
Azure PowerShell
New-AzResourceGroupDeployment `
-Name ExampleDeployment `
-ResourceGroupName ExampleGroup `
-TemplateFile <path-to-template>
7 Note
If you're deploying to a resource group that doesn't exist, create the resource group.
The name of the resource group can only include alphanumeric characters, periods,
underscores, hyphens, and parenthesis. It can be up to 90 characters. The name can't
end in a period.
Azure PowerShell
Azure PowerShell
New-AzResourceGroupDeployment `
-Name remoteTemplateDeployment `
-ResourceGroupName ExampleGroup `
-TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-
templates/master/quickstarts/microsoft.storage/storage-account-
create/azuredeploy.json
The preceding example requires a publicly accessible URI for the template, which works
for most scenarios because your template shouldn't include sensitive data. If you need
to specify sensitive data (like an admin password), pass that value as a secure parameter.
However, if you want to manage access to the template, consider using template specs.
To deploy remote linked templates with relative path that are stored in a storage
account, use QueryString to specify the SAS token:
Azure PowerShell
New-AzResourceGroupDeployment `
-Name linkedTemplateWithRelativePath `
-ResourceGroupName "myResourceGroup" `
-TemplateUri "https://stage20210126.blob.core.windows.net/template-
staging/mainTemplate.json" `
-QueryString "$sasToken"
For more information, see Use relative path for linked templates.
The following examples show how to create and deploy a template spec.
Azure PowerShell
New-AzTemplateSpec `
-Name storageSpec `
-Version 1.0 `
-ResourceGroupName templateSpecsRg `
-Location westus2 `
-TemplateJsonFile ./mainTemplate.json
Azure PowerShell
New-AzResourceGroupDeployment `
-ResourceGroupName demoRG `
-TemplateSpecId $id
Preview changes
Before deploying your template, you can preview the changes the template will make to
your environment. Use the what-if operation to verify that the template makes the
changes that you expect. What-if also validates the template for errors.
Inline parameters
To pass inline parameters, provide the names of the parameter with the New-
AzResourceGroupDeployment command. For example, to pass a string and array to a
template, use:
PowerShell
-TemplateFile <path-to-template> `
-exampleArray $arrayParam
You can also get the contents of file and provide that content as an inline parameter.
PowerShell
-TemplateFile <path-to-template> `
-exampleArray $arrayParam
Getting a parameter value from a file is helpful when you need to provide configuration
values. For example, you can provide cloud-init values for a Linux virtual machine.
If you need to pass in an array of objects, create hash tables in PowerShell and add them
to an array. Pass that array as a parameter during deployment.
PowerShell
-TemplateFile <path-to-template> `
-exampleArray $subnetArray
Parameter files
Rather than passing parameters as inline values in your script, you may find it easier to
use a JSON file that contains the parameter values. The parameter file can be a local file
or an external file with an accessible URI.
For more information about the parameter file, see Create Resource Manager parameter
file.
PowerShell
-TemplateFile <path-to-template> `
-TemplateParameterFile c:\MyTemplates\storage.parameters.json
PowerShell
-TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-
templates/master/quickstarts/microsoft.storage/storage-account-
create/azuredeploy.json `
-TemplateParameterUri https://raw.githubusercontent.com/Azure/azure-
quickstart-templates/master/quickstarts/microsoft.storage/storage-account-
create/azuredeploy.parameters.json
Next steps
To roll back to a successful deployment when you get an error, see Rollback on
error to successful deployment.
To specify how to handle resources that exist in the resource group but aren't
defined in the template, see Azure Resource Manager deployment modes.
To understand how to define parameters in your template, see Understand the
structure and syntax of ARM templates.
For information about deploying a template that requires a SAS token, see Deploy
private ARM template with SAS token.
Manage Azure resources by using Azure
PowerShell
Article • 04/09/2023
Learn how to use Azure PowerShell with Azure Resource Manager to manage your Azure
resources. For managing resource groups, see Manage Azure resource groups by using
Azure PowerShell.
Deploy a resource
The following script creates a storage account.
Azure PowerShell
-Name $storageAccountName `
-Location $location `
-SkuName "Standard_LRS"
$ctx = $storageAccount.Context
Deploy a template
The following script deploys a Quickstart template to create a storage account. For more
information, see Quickstart: Create Azure Resource Manager templates by using Visual
Studio Code.
Azure PowerShell
$templateUri = "https://raw.githubusercontent.com/Azure/azure-quickstart-
templates/master/quickstarts/microsoft.storage/storage-account-
create/azuredeploy.json"
For more information, see Deploy resources with Resource Manager templates and
Azure PowerShell.
Delete resources
The following script shows how to delete a storage account.
Azure PowerShell
For more information about how Azure Resource Manager orders the deletion of
resources, see Azure Resource Manager resource group deletion.
Move resources
The following script shows how to remove a storage account from one resource group
to another resource group.
Azure PowerShell
For more information, see Move resources to new resource group or subscription.
Lock resources
Locking prevents other users in your organization from accidentally deleting or
modifying critical resources, such as Azure subscription, resource group, or resource.
The following script locks a storage account so the account can't be deleted.
Azure PowerShell
Azure PowerShell
Azure PowerShell
For more information, see Lock resources with Azure Resource Manager.
Tag resources
Tagging helps organizing your resource group and resources logically. For information,
see Using tags to organize your Azure resources.
Next steps
To learn Azure Resource Manager, see Azure Resource Manager overview.
To learn the Resource Manager template syntax, see Understand the structure and
syntax of Azure Resource Manager templates.
To learn how to develop templates, see the step-by-step tutorials.
To view the Azure Resource Manager template schemas, see template reference.
How to deploy private ARM template
with SAS token
Article • 05/23/2023
When your Azure Resource Manager template (ARM template) is located in a storage
account, you can restrict access to the template to avoid exposing it publicly. You access
a secured template by creating a shared access signature (SAS) token for the template,
and providing that token during deployment. This article explains how to use Azure
PowerShell or Azure CLI to securely deploy an ARM template with a SAS token.
You will find information on how to protect and manage access to your private ARM
templates with directions on how to do the following:
) Important
Instead of securing your private template with a SAS token, consider using
template specs. With template specs, you can share your templates with other
users in your organization and manage access to the templates through Azure
RBAC.
PowerShell
Azure PowerShell
New-AzResourceGroup `
-Name ExampleGroup `
New-AzStorageAccount `
-ResourceGroupName ExampleGroup `
-Name {your-unique-name} `
-Type Standard_LRS `
Set-AzCurrentStorageAccount `
-ResourceGroupName ExampleGroup `
-Name {your-unique-name}
New-AzStorageContainer `
-Name templates `
-Permission Off
PowerShell
Azure PowerShell
Set-AzStorageBlobContent `
-Container templates `
-File c:\Templates\azuredeploy.json
) Important
The blob containing the private template is accessible to only the account owner.
However, when you create a SAS token for the blob, the blob is accessible to
anyone with that URI. If another user intercepts the URI, that user is able to access
the template. A SAS token is a good way of limiting access to your templates, but
you should not include sensitive data like passwords directly in the template.
PowerShell
Azure PowerShell
$templateuri = New-AzStorageBlobSASToken `
-Container templates `
-Blob azuredeploy.json `
-Permission r `
New-AzResourceGroupDeployment `
-ResourceGroupName ExampleGroup `
-TemplateUri $templateuri
For an example of using a SAS token with linked templates, see Using linked templates
with Azure Resource Manager.
Next steps
For an introduction to deploying templates, see Deploy resources with ARM
templates and Azure PowerShell.
To define parameters in template, see Authoring templates.
Quickstart: Use Azure PowerShell to
create a virtual network
Article • 06/09/2023
This quickstart shows you how to create a virtual network by using Azure PowerShell.
You then create two virtual machines (VMs) in the network, securely connect to the VMs
from the internet, and communicate privately between the VMs.
A virtual network is the fundamental building block for private networks in Azure. Azure
Virtual Network enables Azure resources like VMs to securely communicate with each
other and the internet.
Prerequisites
An Azure account with an active subscription. You can create an account for free .
The steps in this quickstart run the Azure PowerShell cmdlets interactively in Azure
Cloud Shell. To run the commands in the Cloud Shell, select Open Cloudshell at
the upper-right corner of a code block. Select Copy to copy the code and then
paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the
Azure portal.
You can also install Azure PowerShell locally to run the cmdlets. The steps in this
article require Azure PowerShell module version 5.4.1 or later. Run Get-Module -
ListAvailable Az to find your installed version. If you need to upgrade, see Update
Azure PowerShell
$rg = @{
Name = 'test-rg'
Location = 'eastus2'
New-AzResourceGroup @rg
Azure PowerShell
$vnet = @{
Name = 'vnet-1'
ResourceGroupName = 'test-rg'
Location = 'eastus2'
AddressPrefix = '10.0.0.0/16'
}
Azure PowerShell
$subnet = @{
Name = 'subnet-1'
VirtualNetwork = $virtualNetwork
AddressPrefix = '10.0.0.0/24'
}
3. Then associate the subnet configuration to the virtual network with Set-
AzVirtualNetwork.
Azure PowerShell
$virtualNetwork | Set-AzVirtualNetwork
Hourly pricing starts from the moment Bastion is deployed, regardless of outbound data
usage. For more information, see Pricing and SKUs. If you're deploying Bastion as part
of a tutorial or test, we recommend that you delete this resource once you've finished
using it.
1. Configure an Azure Bastion subnet for your virtual network. This subnet is reserved
exclusively for Azure Bastion resources and must be named AzureBastionSubnet.
Azure PowerShell
$subnet = @{
Name = 'AzureBastionSubnet'
VirtualNetwork = $virtualNetwork
AddressPrefix = '10.0.1.0/26'
}
Azure PowerShell
$virtualNetwork | Set-AzVirtualNetwork
3. Create a public IP address for Azure Bastion. The bastion host uses the public IP to
access secure shell (SSH) and remote desktop protocol (RDP) over port 443.
Azure PowerShell
$ip = @{
ResourceGroupName = 'test-rg'
Name = 'public-ip'
Location = 'eastus2'
AllocationMethod = 'Static'
Sku = 'Standard'
Zone = 1,2,3
New-AzPublicIpAddress @ip
4. Use the New-AzBastion command to create a new Standard SKU Azure Bastion
host in the AzureBastionSubnet.
Azure PowerShell
$bastion = @{
Name = 'bastion'
ResourceGroupName = 'test-rg'
PublicIpAddressRgName = 'test-rg'
PublicIpAddressName = 'public-ip'
VirtualNetworkRgName = 'test-rg'
VirtualNetworkName = 'vnet-1'
Sku = 'Basic'
New-AzBastion @bastion
It takes about 10 minutes for the Bastion resources to deploy. You can create VMs in the
next section while Bastion deploys to your virtual network.
Azure PowerShell
$cred = Get-Credential
$nic = @{
Name = "nic-1"
ResourceGroupName = 'test-rg'
Location = 'eastus2'
Subnet = $vnet.Subnets[0]
$vmsz = @{
VMName = "vm-1"
VMSize = 'Standard_DS1_v2'
$vmos = @{
ComputerName = "vm-1"
Credential = $cred
$vmimage = @{
PublisherName = 'Canonical'
Offer = '0001-com-ubuntu-server-jammy'
Skus = '22_04-lts-gen2'
Version = 'latest'
| Set-AzVMSourceImage @vmimage `
$vm = @{
ResourceGroupName = 'test-rg'
Location = 'eastus2'
VM = $vmConfig
New-AzVM @vm
Azure PowerShell
$cred = Get-Credential
$nic = @{
Name = "nic-2"
ResourceGroupName = 'test-rg'
Location = 'eastus2'
Subnet = $vnet.Subnets[0]
$vmsz = @{
VMName = "vm-2"
VMSize = 'Standard_DS1_v2'
$vmos = @{
ComputerName = "vm-2"
Credential = $cred
$vmimage = @{
PublisherName = 'Canonical'
Offer = '0001-com-ubuntu-server-jammy'
Skus = '22_04-lts-gen2'
Version = 'latest'
| Set-AzVMSourceImage @vmimage `
$vm = @{
ResourceGroupName = 'test-rg'
Location = 'eastus2'
VM = $vmConfig
New-AzVM @vm
Tip
You can use the -AsJob option to create a VM in the background while you
continue with other tasks. For example, run New-AzVM @vm1 -AsJob . When Azure
starts creating the VM in the background, you get something like the following
output:
PowerShell
Azure takes a few minutes to create the VMs. When Azure finishes creating the VMs, it
returns output to PowerShell.
7 Note
VMs in a virtual network with a Bastion host don't need public IP addresses. Bastion
provides the public IP, and the VMs use private IPs to communicate within the
network. You can remove the public IPs from any VMs in Bastion-hosted virtual
networks. For more information, see Dissociate a public IP address from an Azure
VM.
7 Note
Azure provides a default outbound access IP for VMs that either aren't assigned a
public IP address or are in the back-end pool of an internal basic Azure load
balancer. The default outbound access IP mechanism provides an outbound IP
address that isn't configurable.
VMs that are created by virtual machine scale sets in flexible orchestration mode
don't have default outbound access.
For more information about outbound connections in Azure, see Default outbound
access in Azure and Use source network address translation (SNAT) for outbound
connections.
6. Enter the username and password you created when you created the VM, and then
select Connect.
Output
PING vm-2.3bnkevn3313ujpr5l1kqop4n4d.cx.internal.cloudapp.net
(10.0.0.5) 56(84) bytes of data.
Output
PING vm-1.3bnkevn3313ujpr5l1kqop4n4d.cx.internal.cloudapp.net
(10.0.0.4) 56(84) bytes of data.
Clean up resources
When you're done with the virtual network and the VMs, use Remove-AzResourceGroup
to remove the resource group and all its resources.
Azure PowerShell
Next steps
In this quickstart, you created a virtual network with a default subnet that contains two
VMs. You deployed Azure Bastion and used it to connect to the VMs, and securely
communicated between the VMs. To learn more about virtual network settings, see
Create, change, or delete a virtual network.
An Azure storage account contains all of your Azure Storage data objects: blobs, files,
queues, and tables. The storage account provides a unique namespace for your Azure
Storage data that is accessible from anywhere in the world over HTTP or HTTPS. For
more information about Azure storage accounts, see Storage account overview.
In this how-to article, you learn to create a storage account using the Azure portal ,
Azure PowerShell, Azure CLI, or an Azure Resource Manager template.
Prerequisites
If you don't have an Azure subscription, create a free account before you begin.
PowerShell
To create an Azure storage account with PowerShell, make sure you have installed
the latest Azure Az PowerShell module . See Install the Azure PowerShell module.
PowerShell
Sign in to your Azure subscription with the Connect-AzAccount command and follow
the on-screen directions to authenticate.
PowerShell
Connect-AzAccount
Every Resource Manager resource, including an Azure storage account, must belong to
an Azure resource group. A resource group is a logical container for grouping your
Azure services. When you create a storage account, you have the option to either create
a new resource group, or use an existing resource group. This how-to shows how to
create a new resource group.
PowerShell
Azure PowerShell
$resourceGroup = "<resource-group>"
$location = "<location>"
If you're not sure which region to specify for the -Location parameter, you can
retrieve a list of supported regions for your subscription with the Get-AzLocation
command:
Azure PowerShell
Azure PowerShell
-Location $location `
-SkuName Standard_RAGRS `
-Kind StorageV2
To create an account with Azure DNS zone endpoints (preview), follow these steps:
1. Register for the preview as described in Azure DNS zone endpoints (preview).
Azure PowerShell
Azure PowerShell
Azure PowerShell
$rgName = "<resource-group>"
$accountName = "<storage-account>"
-Name $accountName `
-SkuName Standard_RAGRS `
-Location <location> `
-Kind StorageV2 `
-DnsEndpointType AzureDnsZone
$account.PrimaryEndpoints
$account.SecondaryEndpoints
To enable a hierarchical namespace for the storage account to use Azure Data Lake
Storage , set the EnableHierarchicalNamespace parameter to $True on the call to
the New-AzStorageAccount command.
The following table shows which values to use for the SkuName and Kind
parameters to create a particular type of storage account with the desired
redundancy configuration.
Under certain circumstances, a deleted storage account may be recovered, but recovery
is not guaranteed. For more information, see Recover a deleted storage account.
If you try to delete a storage account associated with an Azure virtual machine, you may
get an error about the storage account still being in use. For help troubleshooting this
error, see Troubleshoot errors when you delete storage accounts.
PowerShell
To delete the storage account, use the Remove-AzStorageAccount command:
PowerShell
Alternately, you can delete the resource group, which deletes the storage account and
any other resources in that resource group. For more information about deleting a
resource group, see Delete resource group and resources.
Next steps
Storage account overview
Upgrade to a general-purpose v2 storage account
Move a storage account to another region
Recover a deleted storage account
Migrate a classic storage account
Configure a Log Analytics workspace in Azure Monitor
using PowerShell
Article • 07/02/2023
The following sample script configures the workspace to collect multiple types of logs from virtual machines by using the
Log Analytics agent.
1. Create a workspace.
2. Enable collection of IIS logs from computers with the Windows agent installed.
3. Collect Logical Disk perf counters from Linux computers (% Used Inodes; Free Megabytes; % Used Space; Disk
Transfers/sec; Disk Reads/sec; Disk Writes/sec).
4. Collect Syslog events from Linux computers.
5. Collect Error and Warning events from the Application Event Log from Windows computers.
6. Collect Memory Available Mbytes performance counter from Windows computers.
7. Collect a custom log.
PowerShell
$ResourceGroup = "my-resource-group"
$Location = "westeurope"
try {
} catch {
# Linux Perf
# Linux Syslog
# Windows Event
# Windows Perf
# Custom Logs
7 Note
The format for the CustomLogRawJson parameter that defines the configuration for a custom log can be complex. Use
Get-AzOperationalInsightsDataSource to retrieve the configuration for an existing custom log. The Properties
property is the configuration required for the CustomLogRawJson parameter.
In the preceding example, regexDelimiter was defined as \\n for newline. The log delimiter might also be a timestamp.
The following table lists the formats that are supported.
Format JSON RegEx format uses two \\ for every \ in a standard RegEx, so if testing in a RegEx app, reduce \\ to \
dd/MMM/yyyy (([0-2][1-9]|[3][0-
HH:MM:SS 1])\\/(Jan|Feb|Mar|May|Apr|Jul|Jun|Aug|Oct|Sep|Nov|Dec|jan|feb|mar|may|apr|jul|jun|aug|oct|sep|nov|dec)\\/((19|20)
[0-9][0-9]))\\s((\\d)|([0-1]\\d)|(2[0-4])):[0-5][0-9]:[0-5][0-9])
MMM d HH:mm:ss
(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s\\s([0]?[1-9]|[1-2][0-9]|[3][0-1])\\s([0][0-9]|[1][0-2]):([0-
two spaces after 5][0-9]):([0-5][0-9])
MMM
dd/MMM/yyyy:HH:mm:ss (([0-2][1-9]|[3][0-1])\\/(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\/((19|20)[0-9][0-9]):([0][0-9]|[1][0-
+zzzz
2]):([0-5][0-9]):([0-5][0-9])\\s[\\+|\\-][0-9]{4})
where + is + or a -
yyyy-MM-ddTHH:mm:ss
((\\d{2})|(\\d{4}))-([0-1]\\d)-(([0-3]\\d)|(\\d))T((\\d)|([0-1]\\d)|(2[0-4])):[0-5][0-9]:[0-5][0-9]
The T is a literal letter
T
Troubleshooting
When you create a workspace that was deleted in the last 14 days and is in a soft-delete state, the operation could have a
different outcome depending on your workspace configuration. For example:
If you provide the same workspace name, resource group, subscription, and region as in the deleted workspace, your
workspace will be recovered. The recovered workspace includes data, configuration, and connected agents.
A workspace name must be unique per resource group. If you use a workspace name that already exists and is also in
soft delete in your resource group, you'll get an error. The error will state "The workspace name 'workspace-name' is
not unique" or "conflict." To override the soft delete, permanently delete your workspace, and create a new
workspace with the same name, follow these steps to recover the workspace first and then perform a permanent
delete:
Recover your workspace.
Permanently delete your workspace.
Create a new workspace by using the same workspace name.
Next steps
Review Log Analytics PowerShell cmdlets for more information on using PowerShell for configuration of Log Analytics.
Tutorial: Deploy an Azure Kubernetes
Service (AKS) cluster
Article • 03/16/2023
Kubernetes provides a distributed platform for containerized applications. With AKS, you
can quickly create a production ready Kubernetes cluster. In this tutorial, part three of
seven, you deploy a Kubernetes cluster in AKS. You learn how to:
In later tutorials, you'll deploy the Azure Vote application to your AKS cluster and scale
and update your application.
If you're using Azure CLI, this tutorial requires that you're running the Azure CLI
version 2.0.53 or later. Run az --version to find the version. If you need to install
or upgrade, see Install Azure CLI.
If you're using Azure PowerShell, this tutorial requires that you're running Azure
PowerShell version 5.9.0 or later. Run Get-InstalledModule -Name Az to find the
version. If you need to install or upgrade, see Install Azure PowerShell.
To learn more about AKS and Kubernetes RBAC, see Control access to cluster resources
using Kubernetes RBAC and Azure Active Directory identities in AKS.
Azure PowerShell
For more information about AKS resource limits and region availability, see Quotas,
virtual machine size restrictions, and region availability in AKS.
To allow an AKS cluster to interact with other Azure resources, a cluster identity is
automatically created. In this example, the cluster identity is granted the right to
pull images from the ACR instance you created in the previous tutorial. To execute
the command successfully, you're required to have an Owner or Azure account
administrator role in your Azure subscription.
Azure PowerShell
To avoid needing an Owner or Azure account administrator role, you can also manually
configure a service principal to pull images from ACR. For more information, see ACR
authentication with service principals or Authenticate from Kubernetes with a pull secret.
Alternatively, you can use a managed identity instead of a service principal for easier
management.
7 Note
To ensure your cluster operates reliably, you should run at least two nodes.
Azure PowerShell
If you use the Azure Cloud Shell, kubectl is already installed. You can also install it
locally using the Install-AzAksKubectl cmdlet.
Azure PowerShell
Install-AzAksKubectl
Azure PowerShell
To verify connection to your cluster, run kubectl get nodes to return a list of cluster
nodes.
Azure CLI
Next steps
In this tutorial, you deployed a Kubernetes cluster in AKS and configured kubectl to
connect to the cluster. You learned how to:
In the next tutorial, you'll learn how to deploy an application to your cluster.
Azure Container Registry is a private registry service for building, storing, and managing
container images and related artifacts. In this quickstart, you create an Azure container
registry instance with Azure PowerShell. Then, use Docker commands to push a
container image into the registry, and finally pull and run the image from your registry.
Prerequisites
7 Note
We recommend that you use the Azure Az PowerShell module to interact with
Azure. See Install Azure PowerShell to get started. To learn how to migrate to the
Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.
You must also have Docker installed locally. Docker provides packages for macOS ,
Windows , and Linux systems.
Because the Azure Cloud Shell doesn't include all required Docker components (the
dockerd daemon), you can't use the Cloud Shell for this quickstart.
Sign in to Azure
Sign in to your Azure subscription with the Connect-AzAccount command, and follow
the on-screen directions.
PowerShell
Connect-AzAccount
PowerShell
The registry name must be unique within Azure, and contain 5-50 alphanumeric
characters. The following example creates a registry named "mycontainerregistry."
Replace mycontainerregistry in the following command, then run it to create the registry:
PowerShell
Tip
In this quickstart, you create a Basic registry, which is a cost-optimized option for
developers learning about Azure Container Registry. Choose other tiers for
increased storage and image throughput, and capabilities such as connection using
a private endpoint. For details on available service tiers (SKUs), see Container
registry service tiers.
Log in to registry
Before pushing and pulling container images, you must log in to your registry with the
Connect-AzContainerRegistry cmdlet. The following example uses the same credentials
you logged in with when authenticating to Azure with the Connect-AzAccount cmdlet.
7 Note
In the following example, the value of $registry.Name is the resource name, not the
fully qualified registry name.
PowerShell
Before you can push an image to your registry, you must tag it with the fully qualified
name of your registry login server. The login server name is in the format <registry-
name>.azurecr.io (must be all lowercase), for example, mycontainerregistry.azurecr.io.
Tag the image using the docker tag command. Replace <login-server> with the login
server name of your ACR instance.
Example:
Finally, use docker push to push the image to the registry instance. Replace <login-
server> with the login server name of your registry instance. This example creates the
After pushing the image to your container registry, remove the hello-world:v1 image
from your local Docker environment. (Note that this docker rmi command does not
remove the image from the hello-world repository in your Azure container registry.)
Example output:
Digest:
sha256:662dd8e65ef7ccf13f417962c2f77567d3b132f12c95909de6c85ac3c326a345
[...]
Clean up resources
Once you're done working with the resources you created in this quickstart, use the
Remove-AzResourceGroup command to remove the resource group, the container
registry, and the container images stored there:
PowerShell
Remove-AzResourceGroup -Name myResourceGroup
Next steps
In this quickstart, you created an Azure Container Registry with Azure PowerShell,
pushed a container image, and pulled and ran the image from the registry. Continue to
the Azure Container Registry tutorials for a deeper look at ACR.
Use Azure Container Instances to run serverless Docker containers in Azure with
simplicity and speed. Deploy an application to a container instance on-demand when
you don't need a full container orchestration platform like Azure Kubernetes Service.
In this quickstart, you use Azure PowerShell to deploy an isolated Windows container
and make its application available with a fully qualified domain name (FQDN). A few
seconds after you execute a single deployment command, you can browse to the
application running in the container:
If you don't have an Azure subscription, create a free account before you begin.
7 Note
We recommend that you use the Azure Az PowerShell module to interact with
Azure. See Install Azure PowerShell to get started. To learn how to migrate to the
Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.
Azure Cloud Shell
Azure hosts Azure Cloud Shell, an interactive shell environment that you can use
through your browser. You can use either Bash or PowerShell with Cloud Shell to work
with Azure services. You can use the Cloud Shell preinstalled commands to run the code
in this article, without having to install anything on your local environment.
Option Example/Link
Select the Cloud Shell button on the menu bar at the upper right in
the Azure portal .
2. Select the Copy button on a code block (or command block) to copy the code or
command.
3. Paste the code or command into the Cloud Shell session by selecting Ctrl+Shift+V
on Windows and Linux, or by selecting Cmd+Shift+V on macOS.
If you choose to install and use the PowerShell locally, this tutorial requires the Azure
PowerShell module. Run Get-Module -ListAvailable Az to find the version. If you need
to upgrade, see Install Azure PowerShell module. If you are running PowerShell locally,
you also need to run Connect-AzAccount to create a connection with Azure.
First, create a resource group named myResourceGroup in the eastus location with the
following New-AzResourceGroup command:
Azure PowerShell
Create a container
Now that you have a resource group, you can run a container in Azure. To create a
container instance with Azure PowerShell, provide a resource group name, container
instance name, and Docker container image to the New-AzContainerGroup cmdlet. In
this quickstart, you use the public
mcr.microsoft.com/windows/servercore/iis:nanoserver image. This image packages
Microsoft Internet Information Services (IIS) to run in Nano Server.
You can expose your containers to the internet by specifying one or more ports to open,
a DNS name label, or both. In this quickstart, you deploy a container with a DNS name
label so that IIS is publicly reachable.
If you receive a "DNS name label not available" error message, try a different DNS name
label.
Azure PowerShell
Within a few seconds, you should receive a response from Azure. The container's
ProvisioningState is initially Creating, but should move to Succeeded within a minute
or two. Check the deployment state with the Get-AzContainerGroup cmdlet:
Azure PowerShell
The container's provisioning state, fully qualified domain name (FQDN), and IP address
appear in the cmdlet's output:
Console
PS Azure:\> Get-AzContainerGroup -ResourceGroupName myResourceGroup -Name
mycontainer
ResourceGroupName : myResourceGroup
Id : /subscriptions/<Subscription
ID>/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/con
tainerGroups/mycontainer
Name : mycontainer
Type : Microsoft.ContainerInstance/containerGroups
Location : eastus
Tags :
ProvisioningState : Creating
Containers : {mycontainer}
ImageRegistryCredentials :
RestartPolicy : Always
IpAddress : 52.226.19.87
DnsNameLabel : aci-demo-win
Fqdn : aci-demo-win.eastus.azurecontainer.io
Ports : {80}
OsType : Windows
Volumes :
State : Pending
Events : {}
Azure PowerShell
Next steps
In this quickstart, you created an Azure container instance from an image in the public
Docker Hub registry. If you'd like to build a container image and deploy it from a private
Azure container registry, continue to the Azure Container Instances tutorial.
Azure Key Vault is a cloud service that works as a secure secrets store. You can securely
store keys, passwords, certificates, and other secrets. For more information on Key Vault,
you may review the Overview. In this quickstart, you use PowerShell to create a key
vault. You then store a secret in the newly created vault.
If you don't have an Azure subscription, create a free account before you begin.
Option Example/Link
Select the Cloud Shell button on the menu bar at the upper right in
the Azure portal .
2. Select the Copy button on a code block (or command block) to copy the code or
command.
3. Paste the code or command into the Cloud Shell session by selecting Ctrl+Shift+V
on Windows and Linux, or by selecting Cmd+Shift+V on macOS.
Azure PowerShell
Connect-AzAccount
Azure PowerShell
Key vault name: A string of 3 to 24 characters that can contain only numbers (0-9),
letters (a-z, A-Z), and hyphens (-)
) Important
Azure PowerShell
The output of this cmdlet shows properties of the newly created key vault. Take note of
the two properties listed below:
Vault Name: The name you provided to the -Name parameter above.
Vault URI: In the example, this is https://<your-unique-keyvault-
name>.vault.azure.net/. Applications that use your vault through its REST API must
use this URI.
At this point, your Azure account is the only one authorized to perform any operations
on this new vault.
Azure PowerShell
Azure PowerShell
Then, use the Azure PowerShell Set-AzKeyVaultSecret cmdlet to create a secret in Key
Vault called ExamplePassword with the value hVFkk965BuUv :
Azure PowerShell
Azure PowerShell
Now, you have created a Key Vault, stored a secret, and retrieved it.
Clean up resources
Other quickstarts and tutorials in this collection build upon this quickstart. If you plan to
continue on to work with other quickstarts and tutorials, you may want to leave these
resources in place.
Azure PowerShell
Next steps
In this quickstart you created a Key Vault and stored a secret in it. To learn more about
Key Vault and how to integrate it with your applications, continue on to the articles
below.
The following example installs the latest version of the Az.Resources Azure PowerShell
module.
PowerShell
Application
Get-AzAdApplication
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
New-AzAdApplication
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
Parameter Password has been removed, customized password is not supported
anymore, server
assigns secret text when creation
Remove-AzAdApplication
Input type of parameter InputObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
Update-AzAdApplication
Input type of parameter InputObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
Get-AzAdAppCredential
Input type of parameter ApplicationObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphKeyCredential
and
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphPasswordCredential
New-AzAdAppCredential
Input type of parameter ApplicationObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphKeyCredential
and
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphPasswordCredential
Remove-AzAdAppCredential
Input type of parameter ApplicationObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADApplication to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
Changes to App Credential Object
Password Credential
Password has been replaced by SecretText
Key Credential
CertValue has been Removed
ServicePrincipal
Get-AzAdServicePrincipal
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal
to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphServicePrincipal
New-AzAdServicePrincipal
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal
to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphServicePrincipal
DisplayNameWithoutCredentialParameterSet ,
DisplayNameWithPasswordPlainParameterSet have been removed because those
Role contributor is not assigned as default when parameter -Role is not provided
due to
security consideration.
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphApplication
raphServicePrincipal
Update-AzAdServicePrincipal
Input type of parameter InputObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphServicePrincipal
System.Boolean
ServicePrincipal Credential
Get-AzAdSpCredential
Input type of parameter ServicePrincipalObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphServicePrincipal
Output type has been changed from Microsoft.Azure.Commands.ActiveDirectory.
PSADCredential to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphKeyCredential
and
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphPasswordCredential
New-AzAdSpCredential
Input type of parameter ServicePrincipalObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphServicePrincipal
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphKeyCredential
and
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphPasswordCredential
Remove-AzAdSpCredential
Input type of parameter ServicePrincipalObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphServicePrincipal
Password Credential
Password has been replaced by SecretText
Key Credential
CertValue has been Removed
User
Get-AzAdUser
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADUser to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphUser
New-AzAdUser
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADUser to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphUser
Remove-AzAdUser
Input type of parameter InputObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADUser to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphUser
Update-AzAdUser
Input type of parameter InputObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADUser to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphUser
Group
Get-AzAdGroup
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADGroup to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphGroup
New-AzAdGroup
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADGroup to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphGroup
Remove-AzAdGroup
Input type of parameter InputObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADGroup to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphGroup
Group member
Get-AzAdGroupMember
Output type has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADObject to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphDirectoryObject
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphGroup
) Important
Due to limitations with the current Graph API, service principals are not returned by
Get-AzAdGroupMember in Az 7.x. For a workaround, see
Troubleshooting the Azure
Az PowerShell module.
Add-AzAdGroupMember
Input type of parameter GroupObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADGroup to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphGroup
Remove-AzAdGroupMember
Input type of parameter GroupObject has been changed from
Microsoft.Azure.Commands.ActiveDirectory.PSADGroup to
Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftG
raphGroup
Migration Guide for Az 10.0.0
Article • 07/04/2023
Az.Cdn
Update-AzFrontDoorCdnProfile
Update-AzCdnProfile
Update-AzCdnOriginGroup
Update-AzCdnOrigin
Update-AzCdnEndpoint
Stop-AzCdnEndpoint
Start-AzCdnEndpoint
New-AzFrontDoorCdnProfile
New-AzCdnProfile
New-AzCdnOrigin
New-AzCdnEndpoint
New-AzCdnCustomDomain
Get-AzFrontDoorCdnProfile
Get-AzCdnSubscriptionResourceUsage
Get-AzCdnProfileResourceUsage
Get-AzCdnProfile
Get-AzCdnOriginGroup
Get-AzCdnOrigin
Get-AzCdnEndpointResourceUsage
The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile'
to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed.
Get-AzCdnEndpoint
Get-AzCdnCustomDomain
Enable-AzCdnCustomDomainCustomHttps
Before
PowerShell
$customDomainHttpsParameter = New-AzCdnManagedHttpsParametersObject -
CertificateSourceParameterCertificateType Dedicated -CertificateSource Cdn -ProtocolType
ServerNameIndication
Output:
True
After
PowerShell
$customDomainHttpsParameter = New-AzCdnManagedHttpsParametersObject -
CertificateSourceParameterCertificateType Dedicated -CertificateSource Cdn -ProtocolType
ServerNameIndication
Output:
Null
Disable-AzCdnCustomDomainCustomHttps
Before
PowerShell
Disable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -
EndpointName endptest001 -CustomDomainName customdomain001 -PassThru
Output:
True
After
PowerShell
OutPut:
Null
Az.Compute
Get-AzVM
The cmdlet 'Get-AzVM' no longer supports the parameter 'NextLink' and no alias was found for the original
parameter name.
Before
PowerShell
After
PowerShell
Az.ContainerRegistry
Update-AzContainerRegistryWebhook
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookUri' for parameter
'Uri'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookActions' for parameter
'Action'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookHeaders' for
parameter 'Header'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookStatus' for parameter
'Status'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookScope' for parameter
'Scope'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias
was found for the original parameter name.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
Before
PowerShell
Update-AzContainerRegistryWebhook -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/webhooks/webhook001 -Uri http://www.bing.com -Action Delete,Push -Header
@{SpecialHeader='headerVal'} -Tag @{Key='val'} -Status Enabled -Scope 'foo:*'
After
PowerShell
Update-AzContainerRegistryCredential
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the alias 'RegistryName' for parameter
'Name'.
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the type
'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry' for parameter 'Registry'.
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the type
'Microsoft.Azure.Management.ContainerRegistry.Models.PasswordName' for parameter 'PasswordName'.
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the parameter 'ResourceId' and no alias
was found for the original parameter name.
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
Before
PowerShell
Update-AzContainerRegistryCredential -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry -PasswordName password
After
PowerShell
Update-AzContainerRegistry
Before
PowerShell
Update-AzContainerRegistry -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry -EnableAdmin
After
PowerShell
Test-AzContainerRegistryWebhook
Before
PowerShell
Test-AzContainerRegistryWebhook -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/webhooks/webhook001
After
PowerShell
Test-AzContainerRegistryNameAvailability
Before
PowerShell
After
PowerShell
Set-AzContainerRegistryNetworkRuleSet
The cmdlet 'Set-AzContainerRegistryNetworkRuleSet' has been removed and no alias was found for the original
cmdlet name.
Remove-AzContainerRegistryWebhook
The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the parameter 'Webhook' and no alias
was found for the original parameter name.
The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias
was found for the original parameter name.
The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for
parameter 'DefaultProfile'.
Before
PowerShell
Remove-AzContainerRegistryWebhook -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/webhooks/webhook001
After
PowerShell
Remove-AzContainerRegistryReplication
The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the parameter 'Replication' and no alias
was found for the original parameter name.
The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the parameter 'ResourceId' and no alias
was found for the original parameter name.
The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the alias 'AzureRmContext' for
parameter 'DefaultProfile'.
Before
PowerShell
Remove-AzContainerRegistryReplication -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/replications/westus
After
PowerShell
Remove-AzContainerRegistry
The cmdlet 'Remove-AzContainerRegistry' no longer supports the parameter 'Registry' and no alias was found
for the original parameter name.
The cmdlet 'Remove-AzContainerRegistry' no longer supports the parameter 'ResourceId' and no alias was found
for the original parameter name.
The cmdlet 'Remove-AzContainerRegistry' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzContainerRegistry' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'.
The cmdlet 'Remove-AzContainerRegistry' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
Before
PowerShell
Remove-AzContainerRegistry -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry
After
PowerShell
New-AzContainerRegistryWebhook
Before
PowerShell
After
PowerShell
New-AzContainerRegistryReplication
Before
PowerShell
After
PowerShell
New-AzContainerRegistryNetworkRule
The cmdlet 'New-AzContainerRegistryNetworkRule' has been removed and no alias was found for the original
cmdlet name.
New-AzContainerRegistry
Before
PowerShell
After
PowerShell
Import-AzContainerRegistryImage
Get-AzContainerRegistryWebhookEvent
The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer has output type
'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhookEvent'.
The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the type
'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook' for parameter 'Webhook'.
The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the parameter 'ResourceId' and no alias
was found for the original parameter name.
The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the alias 'AzureRmContext' for
parameter 'DefaultProfile'.
Before
PowerShell
Get-AzContainerRegistryWebhookEvent -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/webhooks/webhook001
After
PowerShell
Get-AzContainerRegistryWebhook
Before
PowerShell
Get-AzContainerRegistryWebhook -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/webhooks/webhook001
After
PowerShell
Get-AzContainerRegistryUsage
Before
PowerShell
Get-AzContainerRegistryUsage -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry
After
PowerShell
Get-AzContainerRegistryReplication
Before
PowerShell
Get-AzContainerRegistryReplication -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry/replications/westus
After
PowerShell
Get-AzContainerRegistryCredential
Before
PowerShell
Get-AzContainerRegistryCredential -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry
After
PowerShell
Get-AzContainerRegistry
Before
PowerShell
Get-AzContainerRegistry -ResourceId
/subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/re
gistries/MyRegistry
After
PowerShell
Az.DataProtection
Initialize-AzDataProtectionBackupInstance
Az.DesktopVirtualization
Update-AzWvdScalingPlan
The cmdlet 'Update-AzWvdScalingPlan' no longer supports the parameter 'HostPoolType' and no alias was found
for the original parameter name.
Before
PowerShell
Update-AzWvdScalingPlan `
-ResourceGroupName ResourceGroupName `
-Name 'scalingPlan1' `
-Description 'Description' `
-HostPoolType 'Pooled' `
-Schedule @(
@{
'rampUpStartTime' = '1900-01-01T06:00:00Z';
'rampUpLoadBalancingAlgorithm' = 'BreadthFirst';
'rampUpMinimumHostsPct' = 20;
'rampUpCapacityThresholdPct' = 20;
'peakStartTime' = '1900-01-01T08:00:00Z';
'peakLoadBalancingAlgorithm' = 'DepthFirst';
'RampDownStartTime' = '1900-01-01T18:00:00Z';
'rampDownLoadBalancingAlgorithm' = 'BreadthFirst';
'rampDownMinimumHostsPct' = 20;
'rampDownCapacityThresholdPct' = 20;
'rampDownForceLogoffUser' = $true;
'rampDownWaitTimeMinute' = 30;
'rampDownStopHostsWhen' = 'ZeroSessions';
'offPeakStartTime' = '1900-01-01T20:00:00Z';
'offPeakLoadBalancingAlgorithm' = 'DepthFirst';
) `
-HostPoolReference @(
@{
'hostPoolArmPath' =
'/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualizati
on/hostPools/HostPoolName1';
'scalingPlanEnabled' = $false;
},
@{
'hostPoolArmPath' =
'/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualizati
on/hostPools/HostPoolName2';
'scalingPlanEnabled' = $false;
After
PowerShell
Update-AzWvdScalingPlan `
-ResourceGroupName ResourceGroupName `
-Name 'scalingPlan1' `
-Description 'Description' `
-Schedule @(
@{
'rampUpStartTime' = '1900-01-01T06:00:00Z';
'rampUpLoadBalancingAlgorithm' = 'BreadthFirst';
'rampUpMinimumHostsPct' = 20;
'rampUpCapacityThresholdPct' = 20;
'peakStartTime' = '1900-01-01T08:00:00Z';
'peakLoadBalancingAlgorithm' = 'DepthFirst';
'RampDownStartTime' = '1900-01-01T18:00:00Z';
'rampDownLoadBalancingAlgorithm' = 'BreadthFirst';
'rampDownMinimumHostsPct' = 20;
'rampDownCapacityThresholdPct' = 20;
'rampDownForceLogoffUser' = $true;
'rampDownWaitTimeMinute' = 30;
'rampDownStopHostsWhen' = 'ZeroSessions';
'offPeakStartTime' = '1900-01-01T20:00:00Z';
'offPeakLoadBalancingAlgorithm' = 'DepthFirst';
) `
-HostPoolReference @(
@{
'hostPoolArmPath' =
'/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualizati
on/hostPools/HostPoolName1';
'scalingPlanEnabled' = $false;
},
@{
'hostPoolArmPath' =
'/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualizati
on/hostPools/HostPoolName2';
'scalingPlanEnabled' = $false;
General
We upgraded the API version of the Az.DesktopVirtualization module from 2021-07-12 to 2022-09-09. It caused
breaking changes as we include the version in the namespace of the models, for example,
'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210712.IHostPool'. If your script depends on
the namespace, please replace "Api20210712" with "Api202209".
New-AzWvdScalingPlan
Before
PowerShell
New-AzWvdScalingPlan `
-ResourceGroupName ResourceGroupName `
-Name 'scalingPlan1' `
-Location 'westcentralus' `
-Description 'Description' `
-HostPoolType 'Pooled' `
-Schedule @(
@{
'rampUpStartTime' = '1900-01-01T06:00:00Z';
'rampUpLoadBalancingAlgorithm' = 'BreadthFirst';
'rampUpMinimumHostsPct' = 20;
'rampUpCapacityThresholdPct' = 20;
'peakStartTime' = '1900-01-01T08:00:00Z';
'peakLoadBalancingAlgorithm' = 'DepthFirst';
'RampDownStartTime' = '1900-01-01T18:00:00Z';
'rampDownLoadBalancingAlgorithm' = 'BreadthFirst';
'rampDownMinimumHostsPct' = 20;
'rampDownCapacityThresholdPct' = 20;
'rampDownForceLogoffUser' = $true;
'rampDownWaitTimeMinute' = 30;
'rampDownStopHostsWhen' = 'ZeroSessions';
'offPeakStartTime' = '1900-01-01T20:00:00Z';
'offPeakLoadBalancingAlgorithm' = 'DepthFirst';
) `
-HostPoolReference @(
@{
'hostPoolArmPath' =
'/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualizati
on/hostPools/HostPoolName';
'scalingPlanEnabled' = $false;
After
PowerShell
New-AzWvdScalingPlan `
-ResourceGroupName ResourceGroupName `
-Name 'scalingPlan1' `
-Location 'westcentralus' `
-Description 'Description' `
-Schedule @(
@{
'rampUpStartTime' = '1900-01-01T06:00:00Z';
'rampUpLoadBalancingAlgorithm' = 'BreadthFirst';
'rampUpMinimumHostsPct' = 20;
'rampUpCapacityThresholdPct' = 20;
'peakStartTime' = '1900-01-01T08:00:00Z';
'peakLoadBalancingAlgorithm' = 'DepthFirst';
'RampDownStartTime' = '1900-01-01T18:00:00Z';
'rampDownLoadBalancingAlgorithm' = 'BreadthFirst';
'rampDownMinimumHostsPct' = 20;
'rampDownCapacityThresholdPct' = 20;
'rampDownForceLogoffUser' = $true;
'rampDownWaitTimeMinute' = 30;
'rampDownStopHostsWhen' = 'ZeroSessions';
'offPeakStartTime' = '1900-01-01T20:00:00Z';
'offPeakLoadBalancingAlgorithm' = 'DepthFirst';
) `
-HostPoolReference @(
@{
'hostPoolArmPath' =
'/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualizati
on/hostPools/HostPoolName';
'scalingPlanEnabled' = $false;
New-AzWvdHostPool
Before
PowerShell
"expirationTime"= "2020-10-01T14:01:54.9571247Z",
"registrationTokenOperation":="Update"
-vmTemplate "{json:json}"
-ssoadfsAuthority "https://adfs"
-ssoClientId "client"
-ssoClientSecretKeyVaultPath "https://keyvault/secret"
-ssoSecretType "SharedKey”
-preferredAppGroupType Desktop
-startVMOnConnect $false
-migrationRequest @{
"migrationPath"=
"TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Nam
e}",
"operation"= "Start"
After
PowerShell
"expirationTime"= "2020-10-01T14:01:54.9571247Z",
"registrationTokenOperation":="Update"
-vmTemplate "{json:json}"
-ssoadfsAuthority https://adfs
-ssoClientId "client"
-ssoClientSecretKeyVaultPath https://keyvault/secret
-ssoSecretType "SharedKey”
-preferredAppGroupType Desktop
-startVMOnConnect $false
-agentUpdate @{
"type"= "Scheduled",
"useSessionHostLocalTime"= $false,
"maintenanceWindows"= “{json:json}
New-AzWvdApplicationGroup
Before
PowerShell
"friendlyName"= "friendly",
"hostPoolArmPath"= "/subscriptions/daefabc0-95b4-48b3-b645-
8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool
1",
"applicationGroupType"= "RemoteApp",
"migrationRequest"= @{
"migrationPath"="TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{ses
sionHostPool.Name}",
"operation"= "Start"
After
PowerShell
"friendlyName"= "friendly",
"hostPoolArmPath"= "/subscriptions/daefabc0-95b4-48b3-b645-
8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool
1",
"applicationGroupType"= "RemoteApp"
Az.EventHub
Set-AzEventHubNamespace
The cmdlet 'Set-AzEventHubNamespace' has undergone several changes, including changes to the output type
and default parameter set.
The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String'
for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters
'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer
supported, and no aliases were found for the original parameter names.
The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the
'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported. Finally, several parameter
sets, including '__AllParameterSets', 'NamespaceParameterSet', and 'AutoInflateParameterSet', have been
removed.
Set-AzEventHub
Before
PowerShell
After
PowerShell
"/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccoun
ts/myStorageAccount"
Remove-AzEventHubVirtualNetworkRule
Before
PowerShell
After
PowerShell
Remove-AzEventHubNetworkRuleSet
Before
PowerShell
After
PowerShell
Remove-AzEventHubNamespace
The cmdlet 'Remove-AzEventHubNamespace' has undergone several changes, including type change for
parameter 'InputObject' and 'DefaultProfile', but the usage remains the same, including piping.
Remove-AzEventHubIPRule
The cmdlet 'Remove-AzEventHubIPRule' has been removed. Please use 'Set-AzEventHubNetworkRuleSet'.
Before
PowerShell
After
PowerShell
New-AzEventHubNamespace
The cmdlet 'New-AzEventHubNamespace' has undergone several changes, including changes to the output type
and default parameter set.
The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String'
for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters
'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer
supported, and no aliases were found for the original parameter names.
The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the
'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported. Finally, several parameter
sets, including '__AllParameterSets', 'NamespaceParameterSet', and 'AutoInflateParameterSet', have been
removed.
New-AzEventHubEncryptionConfig
Before
PowerShell
After
PowerShell
New-AzEventHub
Before
PowerShell
After
PowerShell
Get-AzEventHubNamespace
The output type and the properties has been changed. See the example for more information.
Before
PowerShell
Name : MyNamespaceName
Id : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-
WestCentralUS/providers/Microsoft.EventHub/namespaces/MyNamespaceName
ResourceGroupName : Default-EventHub-WestCentralUS
Location : West US
Tags :
ProvisioningState : Succeeded
Status : Active
ServiceBusEndpoint : #########
Enabled : True
KafkaEnabled : True
IsAutoInflateEnabled : True
MaximumThroughputUnits : 10
After
PowerShell
AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 3:14:09 PM
DisableLocalAuth : True
EnableAutoInflate : True
Id :
/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/m
yNamespace
IdentityType :
KafkaEnabled : True
KeySource :
KeyVaultProperty :
Location : South Central US
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId : 000000000000000000
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption :
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Standard
SkuTier : Standard
Status : Active
Tag : {
TenantId : 00000000000
Type : Microsoft.EventHub/Namespaces
UserAssignedIdentity : {
ZoneRedundant : True
Get-AzEventHub
Add-AzEventHubVirtualNetworkRule
Before
PowerShell
After
PowerShell
$virtualNetworkRule1 = New-AzEventHubVirtualNetworkRuleConfig -SubnetId
'/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetwor
ks/myVirtualNetwork/subnets/default'
Add-AzEventHubIPRule
Before
PowerShell
After
PowerShell
Az.HDInsight
New-AzHDInsightCluster
The cmdlet 'New-AzHDInsightCluster' no longer supports the parameter 'RdpCredential' and no alias was found
for the original parameter name.
The cmdlet 'New-AzHDInsightCluster' no longer supports the parameter 'RdpAccessExpiry' and no alias was
found for the original parameter name.
Before
PowerShell
Customer didn’t use the two parameters for a very long time. There is not old usage.
After
PowerShell
Az.Relay
Test-AzRelayName
The cmdlet 'Test-AzRelayName' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Test-AzRelayName' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'.
The cmdlet 'Test-AzRelayName' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'.
Set-AzWcfRelay
Set-AzRelayNamespace
The cmdlet 'Set-AzRelayNamespace' has been removed and no alias was found for the original cmdlet name.
Before
PowerShell
After
PowerShell
Set-AzRelayNamespace
The cmdlet 'Set-AzRelayNamespace' has been removed and no alias was found for the original cmdlet name.
Before
PowerShell
After
PowerShell
$relayNamespace = Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01
Set-AzRelayHybridConnection
Set-AzRelayAuthorizationRule
Before
PowerShell
After
PowerShell
Set-AzRelayAuthorizationRule
The cmdlet 'Set-AzRelayAuthorizationRule' no longer has output type
'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes'.
The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the type
'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes' for parameter 'InputObject'.
The
element type for parameter 'Rights' has been changed from 'System.String' to
'Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.AccessRights'.
The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
Before
PowerShell
After
PowerShell
$GetHybirdAutho.Rights.Add("Send")
Remove-AzWcfRelay
Remove-AzRelayNamespace
Remove-AzRelayHybridConnection
The cmdlet 'Remove-AzRelayHybridConnection' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzRelayHybridConnection' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzRelayHybridConnection' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
Remove-AzRelayAuthorizationRule
The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the parameter 'Force' and no alias was found
for the original parameter name.
The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter
'DefaultProfile'.
The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
Before
PowerShell
After
PowerShell
New-AzWcfRelay
New-AzRelayNamespace
The cmdlet 'New-AzRelayNamespace' no longer has output type
'Microsoft.Azure.Commands.Relay.Models.PSRelayNamespaceAttributes'.
The cmdlet 'New-AzRelayNamespace' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'New-AzRelayNamespace' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'.
The cmdlet 'New-AzRelayNamespace' no longer supports the alias 'AzureRmContext' for parameter
'DefaultProfile'.
New-AzRelayKey
The cmdlet 'New-AzRelayKey' no longer supports the type 'System.String' for parameter 'RegenerateKey'.
The cmdlet 'New-AzRelayKey' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'New-AzRelayKey' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'.
The cmdlet 'New-AzRelayKey' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'.
Before
PowerShell
After
PowerShell
New-AzRelayHybridConnection
New-AzRelayAuthorizationRule
Before
PowerShell
After
PowerShell
Get-AzWcfRelay
Get-AzRelayOperation
The cmdlet 'Get-AzRelayOperation' has been removed and no alias was found for the original cmdlet name.
Get-AzRelayNamespace
Get-AzRelayKey
The cmdlet 'Get-AzRelayKey' no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter
'DefaultProfile'.
The cmdlet 'Get-AzRelayKey' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'.
The cmdlet 'Get-AzRelayKey' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'.
Before
PowerShell
After
PowerShell
Get-AzRelayHybridConnection
Get-AzRelayAuthorizationRule
Az.ServiceBus
Set-AzServiceBusNamespace
The cmdlet 'Set-AzServiceBusNamespace' has undergone several changes, including changes to the output type
and default parameter set.
The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String'
for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters
'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer
supported, and no aliases were found for the original parameter names.
The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the
'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported.
Remove-AzServiceBusVirtualNetworkRule
Before
PowerShell
After
PowerShell
Remove-AzServiceBusNetworkRuleSet
Before
PowerShell
After
PowerShell
Remove-AzServiceBusNamespace
The cmdlet 'Remove-AzServiceBusNamespace' no longer supports the alias 'ResourceGroup' for parameter
'ResourceGroupName'.
Before
PowerShell
After
PowerShell
Remove-AzServiceBusIPRule
Before
PowerShell
After
PowerShell
New-AzServiceBusNamespace
New-AzServiceBusGeoDRConfiguration
The cmdlet 'New-AzServiceBusGeoDRConfiguration' no longer supports the parameter 'PassThru' and no alias
was found for the original parameter name.
Before
PowerShell
After
PowerShell
New-AzServiceBusEncryptionConfig
Before
PowerShell
After
PowerShell
$id1 =
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/user
AssignedIdentities/myFirstIdentity"
$id2 =
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/user
AssignedIdentities/mySecondIdentity"
Get-AzServiceBusOperation
Get-AzServiceBusNamespace
The cmdlet 'Get-AzServiceBusNamespace' no longer supports the alias 'ResourceGroup' for parameter
'ResourceGroupName'.
Before
PowerShell
After
PowerShell
Add-AzServiceBusVirtualNetworkRule
Before
PowerShell
After
PowerShell
Add-AzServiceBusIPRule
Before
PowerShell
After
PowerShell
Az.SignalR
Update-AzSignalRNetworkAcl
Update-AzSignalR
Before
PowerShell
After
PowerShell
Set-AzSignalRUpstream
Restart-AzSignalR
Remove-AzSignalR
New-AzSignalRKey
Before
PowerShell
After
PowerShell
Get-AzSignalRKey
Get-AzSignalR
Before
PowerShell
After
PowerShell
Az.SqlVirtualMachine
Update-AzSqlVMGroup
Before
PowerShell
After
PowerShell
Update-AzSqlVM
Update-AzAvailabilityGroupListener
The cmdlet 'Update-AzAvailabilityGroupListener' has been removed and no alias was found for the original
cmdlet name.
Set-AzSqlVMConfigGroup
The cmdlet 'Set-AzSqlVMConfigGroup' has been removed and no alias was found for the original cmdlet name.
Remove-AzSqlVMGroup
The cmdlet 'Remove-AzSqlVMGroup' has undergone changes and no longer supports certain parameters and
output types. Specifically, the 'InputObject' parameter no longer supports the 'AzureSqlVMGroupModel' type or
its 'SqlVMGroup' alias, and the 'ResourceId' parameter has been removed entirely. Additionally, the
'DefaultProfile' parameter no longer supports the 'IAzureContextContainer' type, and its aliases 'AzContext' and
'AzureRmContext'.
Before
PowerShell
After
PowerShell
$group | Remove-AzSqlVMGroup
Remove-AzSqlVM
Before
PowerShell
After
PowerShell
$sqlVM | Remove-AzSqlVM
Remove-AzAvailabilityGroupListener
The cmdlet 'Remove-AzAvailabilityGroupListener' has undergone changes and some features have been
removed. Specifically, the output type
'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureAvailabilityGroupListenerModel' is
no longer supported. Additionally, the parameter 'InputObject' no longer supports this type. The 'ResourceId'
and 'SqlVMGroupObject' parameters have also been removed without any alias found. The 'DefaultProfile'
parameter no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' and its aliases
'AzContext' and 'AzureRmContext'.
Before
PowerShell
After
PowerShell
New-AzSqlVMGroup
New-AzSqlVMConfig
The cmdlet 'New-AzSqlVMConfig' has been removed and no alias was found for the original cmdlet name.
Before
PowerShell
After
PowerShell
New-AzSqlVM
Before
PowerShell
After
PowerShell
New-AzAvailabilityGroupListener
Get-AzSqlVMGroup
Get-AzSqlVM
Get-AzAvailabilityGroupListener
The cmdlet 'Get-AzAvailabilityGroupListener' has been updated and some features have been removed.
The cmdlet 'Get-AzAvailabilityGroupListener' no longer has output type
'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureAvailabilityGroupListenerModel'.
The 'ResourceId' and 'SqlVMGroupObject' parameters have been removed without any alias found. The
'DefaultProfile' parameter no longer supports the type
'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' and its aliases
'AzContext' and 'AzureRmContext'.
Before
PowerShell
After
PowerShell
Az.StackHCI
Unregister-AzStackHCI
The cmdlet 'Unregister-AzStackHCI' no longer supports the parameter 'GraphAccessToken' and no alias was
found for the original parameter name.
Before
PowerShell
After
PowerShell
Test-AzStackHCIConnection
The cmdlet 'Test-AzStackHCIConnection' has been removed and no alias was found for the original cmdlet name.
Before
PowerShell
After
PowerShell
Set-AzStackHCI
The cmdlet 'Set-AzStackHCI' no longer supports the parameter 'GraphAccessToken' and no alias was found for
the original parameter name.
Before
PowerShell
Customers had an option to pass GraphAccessToken parameter in Set-AzStackHCI, which used to be ignored
by the cmdlet
After
PowerShell
Register-AzStackHCI
The cmdlet 'Register-AzStackHCI' no longer supports the parameter 'GraphAccessToken' and no alias was found
for the original parameter name.
The cmdlet 'Register-AzStackHCI' no longer supports the parameter 'EnableAzureArcServer' and no alias was
found for the original parameter name.
Before
PowerShell
After
PowerShell
Az.StorageSync
Set-AzStorageSyncServerEndpoint
The cmdlet 'Set-AzStorageSyncServerEndpoint' no longer supports the alias 'RegisteredServer' for parameter
'InputObject'.
Before
PowerShell
After
PowerShell
Az.Synapse
Update-AzSynapseSparkPool
The cmdlet 'Update-AzSynapseSparkPool' no longer supports the parameter 'SparkConfigFilePath' and no alias
was found for the original parameter name.
Before
PowerShell
Update-AzSynapseSparkPool -WorkspaceName $wsname -Name $sparkpoolname -SparkConfigFilePath $path
After
PowerShell
New-AzSynapseSparkPool
The cmdlet 'New-AzSynapseSparkPool' no longer supports the parameter 'SparkConfigFilePath' and no alias was
found for the original parameter name.
Before
PowerShell
After
PowerShell
Az.Websites
New-AzWebAppContainerPSSession
The cmdlet 'New-AzWebAppContainerPSSession' has been removed and no alias was found for the original
cmdlet name.
Before
PowerShell
Opens a remote PowerShell session into the windows container specified in a given site or slot and
given resource group
After
PowerShell
N/A
Enter-AzWebAppContainerPSSession
The cmdlet 'Enter-AzWebAppContainerPSSession' has been removed and no alias was found for the original
cmdlet name.
Before
PowerShell
Create new remote PowerShell Session into the windows container specified in a given site or slot and
given resource group
After
PowerShell
N/A
Az.Advisor
Set-AzAdvisorConfiguration
Enable-AzAdvisorRecommendation
Disable-AzAdvisorRecommendation
Get-AzAdvisorRecommendation
Az.Aks
Install-AzAksKubectl
Replaced by Install-AzAksCliTool
Before
PowerShell
Install-AzAksKubectl
After
PowerShell
Install-AzAksCliTool
Az.ApiManagement
Get-AzApiManagement
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Set-AzApiManagement
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Restore-AzApiManagement
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Get-AzApiManagementSsoToken
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Update-AzApiManagementRegion
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
No longer supports the type 'PsApiManagementSku' for parameter 'Sku'.
Backup-AzApiManagement
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Add-AzApiManagementRegion
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
The type of property 'Sku' of type 'PsApiManagementRegion' has changed from 'PsApiManagementSku' to 'System.String'.
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
No longer supports the type 'System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku]' for
parameter 'Sku'.
New-AzApiManagement
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
No longer supports the type 'System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku]' for
parameter 'Sku'.
New-AzApiManagementRegion
The type of property 'Sku' of type 'PsApiManagementRegion' has changed from 'PsApiManagementSku' to 'System.String'.
Remove-AzApiManagementRegion
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Get-AzApiManagementNetworkStatus
The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'.
Az.Attestation
Get-AzAttestation
Replaced by 'Get-AzAttestationProvider'.
Before
PowerShell
Get-AzAttestation -DefaultProvider
After
PowerShell
Get-AzAttestationDefaultProvider
New-AzAttestation
Replaced by 'New-AzAttestationProvider'.
Before
PowerShell
After
PowerShell
New-AzAttestationProvider -Name testprovider2 -ResourceGroupName test-rg -Location "East US" -
PolicySigningCertificateKeyPath .\cert1.pem
Remove-AzAttestation
Replaced by 'Remove-AzAttestationProvider'.
Before
PowerShell
After
PowerShell
Az.EventHub
Get-AzEventHubAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
Get-AzEventHubKey
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
New-AzEventHubAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
New-AzEventHubKey
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'
Remove-AzEventHubAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been changed to 'EventHubName'.
Set-AzEventHubAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'
Get-AzEventHubConsumerGroup
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'
New-AzEventHubConsumerGroup
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been changed to 'EventHubName'.
Set-AzEventHubConsumerGroup
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'
Remove-AzEventHubConsumerGroup
Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'.
Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'
Get-AzEventHub
New-AzEventHub
Set-AzEventHub
Remove-AzEventHub
Get-AzEventHubNetworkRuleSet
Set-AzEventHubNetworkRuleSet
New-AzEventHubSchemaGroup
Remove-AzEventHubSchemaGroup
Get-AzEventHubSchemaGroup
Get-AzEventHubGeoDRConfiguration
Set-AzEventHubGeoDRConfigurationBreakPair
Set-AzEventHubGeoDRConfigurationFailOver
Remove-AzEventHubGeoDRConfiguration
Test-AzEventHubName
Az.MarketplaceOrdering
Get-AzMarketplaceTerms
Before
PowerShell
Publisher : microsoft-ads
Product : windows-data-science-vm
Plan : windows2016
LicenseTextLink : <LicenseTextLink>
PrivacyPolicyLink : <PrivacyPolicyLink>
Signature : <Signature>
Accepted : True
RetrieveDatetime : <RetrieveDatetime>
After
PowerShell
Set-AzMarketplaceTerms
Before
PowerShell
After
PowerShell
Az.Migrate
New-AzMigrateReplicationVaultSetting
Has been removed and no alias was found for the original cmdlet name.
Get-AzMigrateReplicationVaultSetting
Has been removed and no alias was found for the original cmdlet name.
Get-AzMigrateReplicationProtectionIntent
Has been removed and no alias was found for the original cmdlet name.
Get-AzMigrateSupportedOperatingSystem
Has been removed and no alias was found for the original cmdlet name.
Get-AzMigrateReplicationEligibilityResult
Has been removed and no alias was found for the original cmdlet name.
New-AzMigrateReplicationProtectionIntent
Has been removed and no alias was found for the original cmdlet name.
Az.Monitor
Get-AzActivityLogAlert
New API version with new set of input/output, please see cmdlet help for detail
Remove-AzActivityLogAlert
New API version with new set of input/output, please see cmdlet help for detail
Set-AzActivityLogAlert
Replaced by New-AzActivityLogAlert
Disable-AzActivityLogAlert
Replaced by Update-AzActivityLogAlert
Enable-AzActivityLogAlert
Replaced by Update-AzActivityLogAlert
New-AzActionGroup
Replaced by New-AzActivityLogAlertActionGroupObject
Get-AzDiagnosticSettingCategory
New API version with new set of input/output, please see cmdlet help for detail
Get-AzDiagnosticSetting
New API version with new set of input/output, please see cmdlet help for detail
New-AzDiagnosticSetting
New API version with new set of input/output, please see cmdlet help for detail
Remove-AzDiagnosticSetting
New API version with new set of input/output, please see cmdlet help for detail
Set-AzDiagnosticSetting
Replaced by New-AzDiagnosticSetting
New-AzDiagnosticDetailSetting
Get-AzSubscriptionDiagnosticSettingCategory
Replaced by Get-AzEventCategory
Get-AzAutoscaleSetting
New API version with new set of input/output, please see cmdlet help for detail
Remove-AzAutoscaleSetting
New API version with new set of input/output, please see cmdlet help for detail
Add-AzAutoscaleSetting
Replaced by New-AzAutoscaleSetting
New-AzAutoscaleNotification
Replaced by New-AzAutoscaleNotificationObject
New-AzAutoscaleProfile
Replaced by New-AzAutoscaleProfileObject
New-AzAutoscaleRule
Replaced by New-AzAutoscaleScaleRuleObject
New-AzAutoscaleWebhook
Replaced by New-AzAutoscaleWebhookNotificationObject
Get-AzScheduledQueryRule
New API version with new set of input/output, please see cmdlet help for detail
New-AzScheduledQueryRuleAlertingAction
New-AzScheduledQueryRuleAznActionGroup
New-AzScheduledQueryRule
New API version with new set of input/output, please see cmdlet help for detail
New-AzScheduledQueryRuleLogMetricTrigger
New-AzScheduledQueryRuleSchedule
New-AzScheduledQueryRuleSource
New-AzScheduledQueryRuleTriggerCondition
Remove-AzScheduledQueryRule
New API version with new set of input/output, please see cmdlet help for detail
Set-AzScheduledQueryRule
Update-AzScheduledQueryRule
New API version with new set of input/output, please see cmdlet help for detail
Az.Network
New-AzFirewall
New-AzFirewallHubIpAddress
Set-AzFirewall
New-AzNetworkManagerAddressPrefixItem
New-AzNetworkManagerSecurityAdminConfiguration
The element type for parameter 'ApplyOnNetworkIntentPolicyBasedService' has been changed from 'System.String' to
'Microsoft.Azure.Commands.Network.NewAzNetworkManagerSecurityAdminConfigurationCommand.NetworkIntentPolicyBasedServiceType'.
New-AzNetworkManager
The element type for parameter 'NetworkManagerScopeAccess' has been changed from 'System.String' to
'Microsoft.Azure.Commands.Network.NewAzNetworkManagerCommand.NetworkManagerScopeAccessType'.
Get-AzFirewall
New-AzNetworkManagerConnectivityConfiguration
Deploy-AzNetworkManagerCommit
New-AzNetworkManagerConnectivityGroupItem
New-AzNetworkManagerSecurityAdminRule
Az.RecoveryServices
Get-AzRecoveryServicesBackupContainer
No longer supports the parameter 'Status' and no alias was found for the original parameter name.
The parameter set
'__AllParameterSets' has been removed.
Az.SecurityInsights
Update-AzSentinelAlertRuleAction
New-AzSentinelIncidentOwner
Has been removed and no alias was found for the original cmdlet name.
New-AzSentinelIncidentComment
Get-AzSentinelBookmark
Update-AzSentinelAlertRule
Get-AzSentinelIncidentComment
Get-AzSentinelAlertRuleAction
Remove-AzSentinelIncident
New-AzSentinelBookmark
Remove-AzSentinelAlertRule
Remove-AzSentinelAlertRuleAction
Get-AzSentinelAlertRule
Update-AzSentinelDataConnector
Remove-AzSentinelBookmark
New-AzSentinelIncident
New-AzSentinelAlertRuleAction
Get-AzSentinelIncident
Remove-AzSentinelDataConnector
New-AzSentinelDataConnector
New-AzSentinelAlertRule
Get-AzSentinelAlertRuleTemplate
Update-AzSentinelIncident
Get-AzSentinelDataConnector
Az.ServiceBus
Get-AzServiceBusAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter
'Topic' has been renamed to 'TopicName'.
Get-AzServiceBusKey
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter
'Topic' has been renamed to 'TopicName'.
New-AzServiceBusAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter
'Topic' has been renamed to 'TopicName'.
New-AzServiceBusKey
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter
'Topic' has been renamed to 'TopicName'.
Remove-AzServiceBusAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter
'Topic' has been renamed to 'TopicName'.
Set-AzServiceBusAuthorizationRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter
'Topic' has been renamed to 'TopicName'.
Test-AzServiceBusName
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Set-AzServiceBusGeoDRConfigurationBreakPair
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Stop-AzServiceBusMigration
Parameter 'Name' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Get-AzServiceBusNetworkRuleSet
Set-AzServiceBusNetworkRuleSet
Get-AzServiceBusQueue
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
New-AzServiceBusQueue
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Set-AzServiceBusQueue
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Remove-AzServiceBusQueue
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Get-AzServiceBusRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter
'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
New-AzServiceBusRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter
'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Set-AzServiceBusRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter
'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Remove-AzServiceBusRule
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter
'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Get-AzServiceBusTopic
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
New-AzServiceBusTopic
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Set-AzServiceBusTopic
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Remove-AzServiceBusTopic
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias
'ResourceGroup'.
Get-AzServiceBusSubscription
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter
'ResourceGroupName' would no longer support alias 'ResourceGroup'.
New-AzServiceBusSubscription
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter
'ResourceGroupName' would no longer support alias 'ResourceGroup'.
Set-AzServiceBusSubscription
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter
'ResourceGroupName' would no longer support alias 'ResourceGroup'.
Remove-AzServiceBusSubscription
Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter
'ResourceGroupName' would no longer support alias 'ResourceGroup'.
Get-AzServiceBusGeoDRConfiguration
Set-AzServiceBusGeoDRConfigurationFailOver
New-AzServiceBusGeoDRConfiguration
Remove-AzServiceBusGeoDRConfiguration
Start-AzServiceBusMigration
Get-AzServiceBusMigration
Remove-AzServiceBusMigration
Az.Sql
Update-AzSqlServerAdvancedThreatProtectionSetting
Get-AzSqlServerAdvancedThreatProtectionSetting
Clear-AzSqlDatabaseAdvancedThreatProtectionSetting
Has been removed and no alias was found for the original cmdlet name.
Update-AzSqlDatabaseAdvancedThreatProtectionSetting
Clear-AzSqlServerAdvancedThreatProtectionSetting
Has been removed and no alias was found for the original cmdlet name.
Disable-AzSqlServerAdvancedDataSecurity
Get-AzSqlDatabaseAdvancedThreatProtectionSetting
Enable-AzSqlServerAdvancedDataSecurity
Az.Storage
Get-AzStorageFileCopyState
No longer has output type 'Microsoft.Azure.Storage.File.CopyState'.
Az.Synapse
Get-AzSynapseLinkConnectionLinkTableStatus
Remove-AzSynapseLinkConnection
Update-AzSynapseLinkConnectionLandingZoneCredential
Get-AzSynapseLinkConnectionLinkTable
Stop-AzSynapseLinkConnection
Set-AzSynapseLinkConnection
Get-AzSynapseLinkConnection
Start-AzSynapseLinkConnection
Set-AzSynapseLinkConnectionLinkTable
The Az.EventHub PowerShell module version 9.0.1 of Azure PowerShell that would be
released in October introduces improvised cmdlets for public use.
These changes are focused towards making the PowerShell use more productive and
seamless for the end users.
The following example installs the latest version of the Az.Eventhub Azure PowerShell
module.
PowerShell
Major Changes:
Behavior of -InputObject:
Until Module 8.3.0, -InputObject supports passing an in memory object to additional
cmdlet in pipeline. Due to above design, updating resources becomes a multi step
approach.
With the new module release, -InputObject parameter set would be changing for a
seamless experience.
Before
Below example shows how to update capture description on existing event hub with
Module version 8.3.0 or older
$createdEventHub = Get-AzEventHub -ResourceGroupName MyResourceGroupName -
Namespace MyNamespaceName -Name MyCreatedEventHub
$createdEventHub.CaptureDescription.Enabled = $true
$createdEventHub.CaptureDescription.IntervalInSeconds = 120
$createdEventHub.CaptureDescription.Encoding = "Avro"
$createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763
$createdEventHub.CaptureDescription.Destination.Name =
"EventHubArchive.AzureBlockBlob"
$createdEventHub.CaptureDescription.Destination.BlobContainer = "container"
$createdEventHub.CaptureDescription.Destination.ArchiveNameFormat = "
{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{S
econd}"
$createdEventHub.CaptureDescription.Destination.StorageAccountResourceId =
"/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/provider
s/Microsoft.ClassicStorage/storageAccounts/teststorage"
After
Below example shows how to update capture description on existing event hub with
starting with / after Module version 9.0.1
Pipelining support
Accept pipeline Input for InputObject (InputObject pipelining) can be implemented
in the following manner:
Positional Binding
Positional binding is not supported.
Deprecation Announcements
With new release,below cmdlets are marked to be deprecated:
Add-AzEventHubIPRule
Add-AzEventHubVirtualNetworkRule
Remove-AzEventHubIPRule
Remove-AzEventHubVirtualNetworkRule
Remove-AzEventHubNetworkRuleSet
Application Groups
Get-AzEventHubApplicationGroup
-ResourceId parameter would be deprecated. Henceforth, resource id can be
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicati
onGroup .
New-AzEventHubApplicationGroup
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicati
onGroup .
from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubThrottlingPolicyConfigAttri
butes[] to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicati
Set-AzEventHubApplicationGroup
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicati
onGroup .
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicati
New-AzEventHubThrottlingPolicyConfig
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubThrottlingPolicyConfigAttri
butes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IThrottlin
gPolicy .
Remove-AzEventHubApplicationGroup
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicati
onGroup .
Set-AzEventHubNetworkRuleSet
Input type of parameter -InputObject and Output type has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSNetworkRuleSetAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INetworkRu
leSet .
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INwRuleSet
VirtualNetworkRules[] . Please use New-AzEventHubVirtualNetworkRuleConfig
to know more.
Get-AzEventHubNetworkRuleSet
Output type has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSNetworkRuleSetAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INetworkRu
leSet .
New-AzEventHubAuthorizationRule
Output type has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttri
butes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAuthoriza
tionRule .
Set-AzEventHubAuthorizationRule
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttri
butes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAuthoriza
tionRule .
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
-InputObject parameter would no longer support alias -AuthRuleObj .
Get-AzEventHubAuthorizationRule
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttri
butes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAuthoriza
tionRule .
New-AzEventHubKey
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAccessKe
ys .
Parameter -ResourceGroupName would no longer support alias -ResourceGroup .
Get-AzEventHubKey
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAccessKe
ys .
Consumer Groups
New-AzEventHubConsumerGroup
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumer
Group .
Set-AzEventHubConsumerGroup
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumer
Group .
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
Get-AzEventHubConsumerGroup
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumer
Group .
Parameter -MaxCount has been removed. Use -Skip and -Top pagination use case.
Remove-AzEventHubConsumerGroup
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumer
Group .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Clusters
New-AzEventHubCluster
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster .
Set-AzEventHubCluster
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster .
to know more.
Get-AzEventHubCluster
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster .
Remove-AzEventHubCluster
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster .
Get-AzEventHubClustersAvailableRegion
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models. PSEventHubsAvailableCluster[] to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAvailable
Cluster .
EventHub
New-AzEventHub
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub .
-InputObject would be removed as it is not supported for Creation operation and
Set-AzEventHub
Input type of parameter -InputObject and output type of the cmdlet have been
changed from Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub .
CaptureDescription class data members would be flattened and would directly be
accessible as data members within
Microsoft. Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub .
Please refer to example on top to know more.
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
-InputObject parameter would no longer support alias -EventHubObj .
Remove-AzEventHub
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub .
Get-AzEventHub
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub .
Parameter -MaxCount has been removed. Use -Skip and -Top for pagination use
case.
Parameter -NamespaceObject is being replaced by -InputObject of type
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub .
Private Endpoints
Approve-AzEventHubPrivateEndpointConnection
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateEndpointConnectionAt
tributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateEn
dpointConnection .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Deny-AzEventHubPrivateEndpointConnection
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateEndpointConnectionAt
tributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateEn
dpointConnection .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Get-AzEventHubPrivateEndpointConnection
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateEndpointConnectionAt
tributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateEn
dpointConnection .
Private Links
Get-AzEventHubPrivateLink
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateLinkResourceAttribu
tes[] to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateLi
nkResourcesListResult .
Get-AzEventHubGeoDRConfiguration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisast
erRecovery .
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisast
erRecovery .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
New-AzEventHubGeoDRConfiguration
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisast
erRecovery .
-InputObject and -ResourceId are not supported during resource creation, hence
Remove-AzEventHubGeoDRConfiguration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisast
erRecovery .
Set-AzEventHubGeoDRConfigurationBreakPair
-ResourceId parameter would be deprecated. Henceforth, resource id can be
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisast
erRecovery .
Set-AzEventHubGeoDRConfigurationFailOver
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Schema Groups
New-AzEventHubSchemaGroup
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubsSchemaRegistryAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ISchemaGr
oup .
Get-AzEventHubSchemaGroup
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubsSchemaRegistryAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ISchemaGr
oup .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Remove-AzEventHubSchemaGroup
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.EventHub.Models.PSEventHubsSchemaRegistryAttributes
to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ISchemaGr
oup .
CheckNameAvailability
Test-AzEventHubName
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.EventHub.Models.
PSCheckNameAvailabilityResultAttributes to
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICheckName
AvailabilityResult .
Migration Guide for latest Az.ServiceBus
PowerShell Module
Article • 07/04/2023
The Az.ServiceBus PowerShell module version 9.0.1 of Azure PowerShell that would be
released in October introduces improvised cmdlets for public use.
These changes are focused towards making the PowerShell use seamless for the end
users.
The following example installs the latest version of the Az.ServiceBus Azure PowerShell
module.
PowerShell
Major Changes:
Behavior of -InputObject:
Until Module 8.3.0, -InputObject supports passing an in memory object to additional
cmdlet in pipeline. Due to above design, updating resources becomes a multi step
approach.
With the new module release, -InputObject parameter set would be changing for a
seamless experience.
Before
Below example shows how to update queue properties on existing service bus
namespace with Module version 8.3.0 or older
$QueueObj = Get-AzServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -
NamespaceName SB-Example1 -QueueName SB-Queue_example1
$QueueObj.ForwardTo = "q1"
$QueueObj.ForwardDeadLetteredMessagesTo = "q1"
$QueueObj.DefaultMessageTimeToLive = "P1YT3H11M2S"
After
Below example shows how to update queue properties starting with / after Module
version 9.0.1
Pipelining support
Accept pipeline Input for InputObject (InputObject pipelining) can be implemented
in the following manner:
Deprecation Announcements
With new release,below cmdlets are marked to be deprecated:
Add-AzServiceBusIPRule
Add-AzServiceBusVirtualNetworkRule
Remove-AzServiceBusIPRule
Remove-AzServiceBusVirtualNetworkRule
Remove-AzServiceBusNetworkRuleSet
Set-AzServiceBusNetworkRuleSet
Input type of parameter -InputObject and Output type of the cmdlet have been
changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSNetworkRuleSetAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INetwork
RuleSet .
butes[] to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INwRuleS
etVirtualNetworkRules[] .Please use New-AzServiceBusVirtualNetworkRuleConfig
cmdlet to construct an in-memory object which can then be fed as input to -
VirtualNetworkRule .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
to know more.
Get-AzServiceBusNetworkRuleSet
Input type of parameter -InputObject and Output type of the cmdlet have been
changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSNetworkRuleSetAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INetwork
RuleSet .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
New-AzServiceBusAuthorizationRule
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttr
ibutes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbAutho
rizationRule .
Set-AzServiceBusAuthorizationRule
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttr
ibutes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbAutho
rizationRule .
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
-InputObject parameter would no longer support alias -AuthRuleObj .
Get-AzServiceBusAuthorizationRule
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttr
ibutes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbAutho
rizationRule .
New-AzServiceBusKey
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IAccess
Keys .
Get-AzServiceBusKey
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IAccess
Keys .
Queue Entity
New-AzServiceBusQueue
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueu
e.
Set-AzServiceBusQueue
Input type of parameter -InputObject and of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueu
e.
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
-InputObject parameter would no longer support alias -QueueObj .
Remove-AzServiceBusQueue
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueu
e.
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Get-AzServiceBusQueue
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueu
e.
Parameter -MaxCount has been removed. Use -Skip and -Top for pagination use
cases.
Topic Entity
Get-AzServiceBusTopic
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopi
c.
Parameter -MaxCount has been removed. Use -Skip and -Top for pagination use
cases.
Parameter -ResourceGroupName would no longer support alias -ResourceGroup .
Set-AzServiceBusTopic
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopi
c.
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
-InputObject parameter would no longer support alias -TopicObj .
New-AzServiceBusTopic
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopi
c.
System.Timespan. Hence, ISO 8601 format for timespan can NO longer be fed as
input to these parameters. Please use New-TimeSpan cmdlet object to construct
Timespan variables. Please refer New-TimeSpan to know more about New-
TimeSpan.
Parameter -ResourceGroupName would no longer support alias -ResourceGroup .
Remove-AzServiceBusTopic
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopi
c.
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Rule Entity
Get-AzServiceBusRule
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule .
Parameter -MaxCount has been removed. Use -Skip and -Top for pagination use
cases.
Set-AzServiceBusRule
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule .
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
New-AzServiceBusRule
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule .
Remove-AzServiceBusRule
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Subscription Entity
Get-AzServiceBusSubscription
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubsc
ription .
Parameter -MaxCount has been removed. Use -Skip and -Top for pagination use
cases.
New-AzServiceBusSubscription
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubsc
ription .
Input type of parameters -DefaultMessageTimeToLive , -AutoDeleteOnIdle , -
LockDuration , -DuplicateDetectionHistoryTimeWindow has been changed from
Set-AzServiceBusSubscription
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubsc
ription .
-InputObject parameter set would have a change in behaviour. Refer the section
to know more.
-InputObject parameter would no longer support alias -SubscriptionObj .
Remove-AzServiceBusSubscription
Input type of parameter -InputObject and Output type of the cmdlet has been
changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubsc
ription .
Private Endpoints
Approve-AzServiceBusPrivateEndpointConnection
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateEndpointConnecti
onAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivate
EndpointConnection .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Deny-AzServiceBusPrivateEndpointConnection
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateEndpointConnecti
onAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivate
EndpointConnection .
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Remove-AzServiceBusPrivateEndpointConnection
-ResourceId parameter would be deprecated. Henceforth, resource id can be
Get-AzServiceBusPrivateEndpointConnection
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateEndpointConnecti
onAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivate
EndpointConnection .
Private Links
Get-AzServiceBusPrivateLink
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateLinkResourceAttr
ibutes[] to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivate
LinkResourcesListResult .
Get-AzServiceBusGeoDRConfiguration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisa
sterRecovery .
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisa
sterRecovery .
-Name parameter would be removed from -InputObject parameter set.
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisa
sterRecovery .
-InputObject and -ResourceId are not supported during resource creation, hence
are being removed.
Remove-AzServiceBusGeoDRConfiguration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisa
sterRecovery .
Set-AzServiceBusGeoDRConfigurationBreakPair
Parameter -ResourceId is being removed. Henceforth, resource id can be provided
as input to -InputObject .
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisa
sterRecovery .
Set-AzServiceBusGeoDRConfigurationFailOver
Parameter -ResourceId is being removed. Henceforth, resource id can be provided
as input to -InputObject .
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisa
sterRecovery .
Migration Configurations
Complete-AzServiceBusMigration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrati
onConfigProperties .
Get-AzServiceBusMigration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusMigrationConfigurationA
ttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrati
onConfigProperties .
ttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrati
onConfigProperties .
Start-AzServiceBusMigration
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusMigrationConfigurationA
ttributes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrati
onConfigProperties .
Remove-AzServiceBusMigration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrati
onConfigProperties .
Stop-AzServiceBusMigration
Input type of parameter -InputObject has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttribu
tes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrati
onConfigProperties .
CheckNameAvailability
Test-AzServiceBusName
Output type of the cmdlet has been changed from
Microsoft.Azure.Commands.ServiceBus.Models.PSCheckNameAvailabilityResultAttri
butes to
Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ICheckNa
meAvailabilityResult .
Migration Guide for Az 8.0.0
Article • 07/04/2023
Az.Aks
Get-AzAks
Before
PowerShell
After
PowerShell
New-AzAks
Before
PowerShell
After
PowerShell
Set-AzAks
Before
PowerShell
After
PowerShell
Remove-AzAks
Before
PowerShell
After
PowerShell
Az.Cdn
New-AzCdnProfile
Changed the type of parameter Sku to SkuName
Changed the type of parameter
ProfileName to Name
Before
PowerShell
$profileSku = "Standard_Microsoft";
$cdnProfileName = "profileNameXXXX";
$resourceGroupName = "myresourcegroup"
After
PowerShell
$profileSku = "Standard_Microsoft";
$cdnProfileName = "profileNameXXXX";
$resourceGroupName = "myresourcegroup"
New-AzCdnEndpoint
Before
PowerShell
New-AzCdnEndpoint -ResourceGroupName myresourcegroup -ProfileName
mycdnprofile -Location westus -EndpointName myendpoint `
After
PowerShell
$origin = @{
Name = "origin1"
HostName = "host1.hello.com"
};
$location = "westus"
New-AzCdnDeliveryPolicy
New-AzCdnDeliveryRule
Before
PowerShell
After
PowerShell
$cond1 = New-AzCdnDeliveryRuleIsDeviceConditionObject -Name "IsDevice" -
ParameterMatchValue "Desktop"
New-AzCdnCustomDomain
Before
PowerShell
After
PowerShell
Set-AzCdnProfile
Before
PowerShell
$profileObject.Tags = @{"key"="value"}
After
PowerShell
$profileSku = "Standard_Microsoft";
$cdnProfileName = "profileNameXXXX";
$resourceGroupName = "myresourcegroup"
$tags = @{
Tag1 = 11
Tag2 = 22
Set-AzCdnEndpoint
them.
Before
PowerShell
$endpointObject.IsHttpAllowed = $false
After
PowerShell
$tags = @{
Tag1 = 11
Tag2 = 22
//Update tags
Set-AzCdnOriginGroup
Before
PowerShell
After
PowerShell
Set-AzCdnOrigin
Before
PowerShell
After
PowerShell
Update-AzCdnOrigin -ResourceGroupName $resourceGroupName -ProfileName
$cdnProfileName -EndpointName $endpointName `
Az.EventHub
New-AzEventHubNamespace
Before
PowerShell
After
PowerShell
Set-AzEventHubNamespace
Before
PowerShell
After
PowerShell
Az.HealthcareApis
Set-AzHealthcareApisService
Before
PowerShell
After
PowerShell
Get-AzHealthcareApisService
-ResourceId is removed
Before
PowerShell
After
PowerShell
Remove-AzHealthcareApisService
-ResourceId is removed
Before
PowerShell
After
PowerShell
New-AzHealthcareApisService
Before
PowerShell
After
PowerShell
Az.Accounts
Get-AzContext
Remove-AzContext
Rename-AzContext
Select-AzContext
Connect-AzAccount
Disconnect-AzAccount
Import-AzContext
Save-AzContext
Before
PowerShell
PS C:\> (Get-AzContext).Account.ExtendedProperties
Key Value
--- -----
CertificatePath C:\certificate.pfx
CertificatePassword password****
Tenants 54826b22-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
ServicePrincipalSecret 7QK7Q********************************
Subscriptions 0b1f6471-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
After
PowerShell
PS C:\> $cred = Get-Credential
PS C:\> (Get-AzContext).Account.ExtendedProperties
Key Value
--- -----
CertificatePath C:\certificate.pfx
Tenants 54826b22-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Subscriptions 0b1f6471-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Az.Aks
Get-AzAksVersion
Before
PowerShell
Kubernetes 1.19.13
Kubernetes 1.20.7
Kubernetes 1.20.9
Kubernetes 1.20.7
Kubernetes 1.20.9
Kubernetes 1.20.9
Kubernetes 1.21.1
Kubernetes 1.21.2
Kubernetes 1.21.1
Kubernetes 1.21.2
Kubernetes 1.21.2
Kubernetes 1.22.1 True
After
PowerShell
PS C:\> (Get-AzAksVersion -location eastus).Upgrade
Kubernetes 1.19.13
Kubernetes 1.20.7
Kubernetes 1.20.9
Kubernetes 1.20.7
Kubernetes 1.20.9
Kubernetes 1.20.9
Kubernetes 1.21.1
Kubernetes 1.21.2
Kubernetes 1.21.1
Kubernetes 1.21.2
Kubernetes 1.21.2
Kubernetes 1.22.1 True
Az.ContainerInstance
New-AzContainerGroup
Before
PowerShell
PS C:\> $containerGroup.NetworkProfileId
/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Network/virtu
alNetworks/{vnetName}/subnets/{subnetName}
After
PowerShell
PS C:\> $container = New-AzContainerInstanceObject -Name test-container -
Image nginx
PS C:\> $containerGroup.SubnetId | fl
Id :
/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Network/virtu
alNetworks/{vnetName}/subnets/{subnetName}
Name : subnet
Invoke-AzContainerInstanceCommand
Before
PowerShell
PS C:\> $websocket
Password WebSocketUri
-------- ------------
****************** wss://bridge-linux-
xx.eastus.management.azurecontainer.io/exec/caas-
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/bridge-xxxxxxxxxxxxxxx?rows=12&cols=12api-
version=2018-02-01-preview
After
PowerShell
hello
Az.Functions
Update-AzFunctionApp, Update-AzFunctionAppPlan
Before
PowerShell
After
PowerShell
New-AzFunctionApp
Remove-AzFunctionApp
If this is the last app in the app service plan, then the plan will not be deleted. Before
this release, the app plan will also be deleted.
Az.HDInsight
New-AzHDInsightCluster
New-AzHDInsightCluster, New-AzHDInsightClusterConfig
Set-AzHDInsightClusterDiskEncryptionKey, Set-
AzHDInsightClusterSize
Cluster cmdlets
Get-AzHDInsightProperties
The generic type for output 'property VmSizes' has been changed from
System.Collections.Generic.IDictionary2[System.String,Microsoft.Azure.Commands.HDIn
sight.Models.Management.AzureHDInsightVmSizesCapability] to
System.Collections.Generic.IList1[System.String] .
Before
PowerShell
After
PowerShell
Az.KeyVault
New-AzKeyVaultRoleDefinition, Get-
AzKeyVaultRoleDefinition
Before
PowerShell
PS C:\> $backupRole = Get-AzKeyVaultRoleDefinition -HsmName myHsm -
RoleDefinitionName "Managed HSM Backup User"
PS C:\> $backupRole.Permissions
PS C:\> $backupRole.Permissions.AllowedDataActions
Microsoft.KeyVault/managedHsm/backup/start/action
Microsoft.KeyVault/managedHsm/backup/status/action
Microsoft.KeyVault/managedHsm/keys/backup/action
After
PowerShell
PS C:\> $backupRole.Permissions
PS C:\> $backupRole.Permissions.DataActions
Microsoft.KeyVault/managedHsm/backup/start/action
Microsoft.KeyVault/managedHsm/backup/status/action
Microsoft.KeyVault/managedHsm/keys/backup/action
Az.ManagedServices
New-AzManagedServicesDefinition
Before
PowerShell
After
PowerShell
Az.Monitor
Get-AzLog
Before
PowerShell
After
PowerShell
PS C:\> $log = Get-AzLog -MaxRecord 1
Get-AzMetric,Get-AzMetricDefinition
New-AzMetricAlertRuleV2Criteria
Az.OperationalInsights
Get-AzOperationalInsightsCluster
Before
PowerShell
After
PowerShell
Default parameter set is now "list", when providing resource group name -
return all clusters for the given resource group.
Update-AzOperationalInsightsCluster
Before
PowerShell
After
PowerShell
Az.RecoveryServices
Get-AzRecoveryServicesBackupContainer
Before
PowerShell
After
PowerShell
Get-AzRecoveryServicesBackupItem
Before
PowerShell
After
PowerShell
Get-AzRecoveryServicesBackupJob
Before
PowerShell
After
PowerShell
Az.Resources
AzAD cmdlets
PolicyAssignment cmdlets
Before
PowerShell
After
PowerShell
Az.Storage
Get-AzRmStorageShare
Parameter "Name" has been removed from parameter set "ShareResourceId", since
name can be inferred from the resource ID.
Before
PowerShell
$StorageShare = Get-AzRmStorageShare -ResourceId "/subscriptions/..." -Name
"MyStorageShare"
After
PowerShell
This document describes the changes between the 5.0.0 and 6.0.0 versions of Az.
Az.Accounts
Connect-AzAccount
Before
PowerShell
After
PowerShell
Connect-AzAccount -Identity
Az.ContainerInstance
New-AzContainerGroup
RegistryServerDomain and no alias was found for the original parameter name.
Before
PowerShell
ResourceGroupName : demo
Id : /subscriptions/00000000-0000-0000-0000-
000000000000/resourceGroups/demo/providers/Microsoft.ContainerInstance/conta
inerGroups/mycontainer
Name : mycontainer
Type : Microsoft.ContainerInstance/containerGroups
Location : westus
Tags :
ProvisioningState : Creating
Containers : {mycontainer}
ImageRegistryCredentials :
RestartPolicy :
IpAddress : 13.88.10.240
Ports : {8000}
OsType : Linux
Volumes :
State : Running
Events : {}
After
PowerShell
Remove-AzContainerGroup
PowerShell
After
PowerShell
Get-AzContainerGroup
Before
PowerShell
ResourceGroupName : demo
Id : /subscriptions/00000000-0000-0000-0000-
000000000000/resourceGroups/demo/providers/Microsoft.ContainerInstance/conta
inerGroups/mycontainer
Name : mycontainer
Type : Microsoft.ContainerInstance/containerGroups
Location : westus
Tags :
ProvisioningState : Succeeded
Containers : {mycontainer}
ImageRegistryCredentials :
RestartPolicy :
IpAddress : 13.88.10.240
Ports : {8000}
OsType : Linux
Volumes :
State : Running
Events : {}
After
PowerShell
PS C:\> Get-AzContainerGroup
Get-AzContainerInstanceLog
Before
PowerShell
Log line 1.
Log line 2.
Log line 3.
Log line 4.
After
PowerShell
Az.DesktopVirtualization
New-AzWvdHostPool
The cmdlet 'New-AzWvdHostPool' no longer supports the parameter 'SsoContext' and
no alias was found for the original parameter name.
Expand-AzWvdMsixImage
Before
PowerShell
$MsixImageUri =
[Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102
Preview.IMsixImageUri]::New()
After
PowerShell
$MsixImageUri =
[Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201
Preview.IMsixImageUri]::New()
New-AzWvdMsixPackage
The element type for parameter 'PackageApplication' has been changed from
'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.
IMsixPackageApplications' to
'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.
IMsixPackageApplications'.
The element type for parameter 'PackageDependency' has
been changed from
'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.
IMsixPackageDependencies' to
'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.
IMsixPackageDependencies'.
Before
PowerShell
PS C:\> $apps =
@([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202011
02Preview.IMsixPackageApplications]::New())
PS C:\> $deps =
@([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202011
02Preview.IMsixPackageDependencies]::New())
-HostPoolName HostPoolName `
-ResourceGroupName ResourceGroupName `
-SubscriptionId SubscriptionId `
-DisplayName displayname `
-ImagePath imageURI `
-IsActive:$false `
-IsRegularRegistration:$false `
-LastUpdated datelastupdated `
-PackageApplication $apps `
-PackageDependency $deps `
-PackageFamilyName packagefamilyname `
-PackageName packagename `
-PackageRelativePath packagerelativepath `
-Version packageversion `
After
PowerShell
PS C:\> $apps =
@([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202102
01Preview.IMsixPackageApplications]::New())
PS C:\> $deps =
@([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202102
01Preview.IMsixPackageDependencies]::New())
-HostPoolName HostPoolName `
-ResourceGroupName ResourceGroupName `
-SubscriptionId SubscriptionId `
-DisplayName displayname `
-ImagePath imageURI `
-IsActive:$false `
-IsRegularRegistration:$false `
-LastUpdated datelastupdated `
-PackageApplication $apps `
-PackageDependency $deps `
-PackageFamilyName packagefamilyname `
-PackageName packagename `
-PackageRelativePath packagerelativepath `
-Version packageversion `
Update-AzWvdHostPool
Az.StreamAnalytics
Get-AzStreamAnalyticsDefaultFunctionDefinition
Before
PowerShell
Get-AzStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName
"StreamAnalytics-Default-West-US" -JobName "StreamJob22" -File
"C:\RetrieveDefaultDefinitionRequest.json" -Name "ScoreTweet"
After
PowerShell
New-AzStreamAnalyticsJob
PowerShell
After
PowerShell
New-AzStreamAnalyticsTransformation
Before
PowerShell
After
PowerShell
Az.RecoveryServices
Set-AzRecoveryServicesBackupProperty
Removed Set-AzRecoveryServicesBackupProperties plural alias, use Set-
AzRecoveryServicesBackupProperty cmdlet name going forward
Get-AzRecoveryServicesBackupJobDetail
Before
PowerShell
After
PowerShell
Az.Storage
Remove-AzRmStorageShare
Before
PowerShell
After
PowerShell
Az.ServiceFabric
Add-AzServiceFabricClusterCertificate
this cmdlet has been removed completely. please follow instructions here to add cluster
certificates.
Get-AzServiceFabricManagedClusterService
Change PSManagedService model to avoid using the properties parameter directly from
sdk. Now all the properties are in the first level of the object.
And remove deprecated
parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and
ServiceDnsName
Before
PowerShell
$statelessService.Properties.ProvisioningState
After
PowerShell
$statelessService.ProvisioningState
New-AzServiceFabricManagedCluster
Change PSManagedService model to avoid using the properties parameter directly from
sdk. Now all the properties are in the first level of the object.
And remove deprecated
parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and
ServiceDnsName
Before
PowerShell
$statelessService.Properties.ProvisioningState
After
PowerShell
$statelessService.ProvisioningState
Remove-AzServiceFabricClusterCertificate
this cmdlet has been removed completely. please follow instructions here to add cluster
certificates.
Remove-AzServiceFabricManagedClusterService
Change PSManagedService model to avoid using the properties parameter directly from
sdk. Now all the properties are in the first level of the object.
Set-AzServiceFabricManagedCluster
Change PSManagedService model to avoid using the properties parameter directly from
sdk. Now all the properties are in the first level of the object.
And remove deprecated
parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and
ServiceDnsName
Before
PowerShell
$statelessService.Properties.MinInstanceCount = 3
service | Set-AzServiceFabricManagedClusterService
After
PowerShell
$statelessService.MinInstanceCount = 3
service | Set-AzServiceFabricManagedClusterService
This document describes the changes between the 4.0.0 and 5.0.0 versions of Az.
Az.Aks
New-AzAksCluster
No longer supports the parameter NodeOsType and no alias was found for the
original parameter
name, it will always be Linux .
No longer supports the alias ClientIdAndSecret for parameter
ServicePrincipalIdAndSecret .
The default value of NodeVmSetType is changed from AvailabilitySet to
VirtualMachineScaleSets .
The default value of NetworkPlugin is changed from none to azure .
Before
PowerShell
After
PowerShell
Set-AzAksCluster
No longer supports the alias ClientIdAndSecret for parameter
ServicePrincipalIdAndSecret .
Before
PowerShell
After
PowerShell
Az.ContainerRegistry
New-AzContainerRegistry
No longer supports the parameter StorageAccountName and no alias was found for the
original parameter name.
Before
PowerShell
After
Classic was deprecated and StorageAccountName was removed since it only works with
Classic
Container Registry.
Az.Functions
Get-AzFunctionApp
Removed IncludeSlot switch parameter from all but one parameter set of Get-
AzFunctionApp . The
cmdlet now supports retrieving deployment slots in the results when
-IncludeSlot is specified.
This functionality was broken in the previous cmdlet version.
However, this is now fixed.
New-AzFunctionApp
Fixed -DisableApplicationInsights in New-AzFunctionApp so that no application
insights project
is created when this option is specified.
Removed support to create PowerShell 6.2 function apps since PowerShell 6.2 is
EOL. The current
guidance for customers is to create PowerShell 7.0 function apps
instead.
Changed the default runtime version in Functions version 3 on Windows for
PowerShell function apps
from 6.2 to 7.0 when the RuntimeVersion parameter is
not specified.
Changed the default runtime version in Functions version 3 on Windows and Linux
for Node function
apps from 10 to 12 when the RuntimeVersion parameter is not
specified. However, users can still
create Node 10 function apps by specifying -
Runtime Node and -RuntimeVersion 10 . Changed the
default runtime version in
Functions version 3 on Linux for Python function apps from 3.7 to 3.8
when the
RuntimeVersion parameter is not specified. However, users can still create Python
3.7
function apps by specifying -Runtime Python and -RuntimeVersion 3.7 .
Before
PowerShell
-Name $functionAppName `
-StorageAccountName $storageAccountName `
-Location $location `
-OSType Linux `
-Runtime Node
-Name $functionAppName `
-StorageAccountName $storageAccountName `
-Location $location `
-OSType Windows `
-Runtime Node
-Name $functionAppName `
-StorageAccountName $storageAccountName `
-Location $location `
-OSType Linux `
-Runtime Python
After
PowerShell
-Name $functionAppName `
-StorageAccountName $storageAccountName `
-Location $location `
-OSType Linux `
-Runtime Node `
-RuntimeVersion 10
-Name $functionAppName `
-StorageAccountName $storageAccountName `
-Location $location `
-OSType Windows `
-Runtime Node
-Name $functionAppName `
-StorageAccountName $storageAccountName `
-Location $location `
-OSType Linux `
-Runtime Python `
-RuntimeVersion 3.7
Az.KeyVault
New-AzKeyVault
No longer supports the parameter DisableSoftDelete and no alias was found for the
original parameter name.
Before
PowerShell
After
The ability to update soft-delete setting is deprecated in Az.KeyVault 3.0.0. Read more
Update-AzKeyVault
No longer supports the parameter EnableSoftDelete , SoftDeleteRetentionInDays , and
no alias was
found for the original parameter name.
Before
PowerShell
Update-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -
EnableSoftDelete -SoftDeleteRetentionInDays 15
After
The ability to update soft-delete setting is deprecated in Az.KeyVault 3.0.0. Read more
Get-AzKeyVaultSecret
The property SecretValueText of type
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret
has been removed. Either
Before
PowerShell
$secretInPlainText = $secret.SecretValueText
After
PowerShell
Az.ManagedServices
Get-AzManagedServicesDefinition
No longer supports the parameter ResourceId and no alias was found for the original
parameter name.
Before
PowerShell
Get-AzManagedServicesDefinition -ResourceId xxx
After
PowerShell
New-AzManagedServicesAssignment
No longer supports the parameter RegistrationDefinitionName ,
RegistrationDefinitionResourceId ,
and no alias was found for the original parameter
name.
Before
PowerShell
After
PowerShell
Remove-AzManagedServicesAssignment
No longer supports the parameter Id , ResourceId , and no alias was found for the
original
parameter name.
Before
PowerShell
After
PowerShell
Remove-AzManagedServicesDefinition
No longer supports the parameter Id , ResourceId , and no alias was found for the
original
parameter name.
Before
PowerShell
After
PowerShell
Az.ResourceManager
Get-AzManagementGroupDeployment
No longer supports the parameter ApiVersion and no alias was found for the original
parameter name.
Before
PowerShell
After
PowerShell
Get-AzManagementGroupDeploymentOperation
Same with Get-AzManagementGroupDeployment .
Get-AzDeployment
Same with Get-AzManagementGroupDeployment .
Get-AzDeploymentOperation
Same with Get-AzManagementGroupDeployment .
Get-AzDeploymentWhatIfResult
Same with Get-AzManagementGroupDeployment .
Get-AzTenantDeployment
Same with Get-AzManagementGroupDeployment .
Get-AzTenantDeploymentOperation
Same with Get-AzManagementGroupDeployment .
New-AzManagementGroupDeployment
Same with Get-AzManagementGroupDeployment .
New-AzDeployment
Same with Get-AzManagementGroupDeployment .
New-AzTenantDeployment
Same with Get-AzManagementGroupDeployment .
Remove-AzManagementGroupDeployment
Same with Get-AzManagementGroupDeployment .
Remove-AzDeployment
Same with Get-AzManagementGroupDeployment .
Remove-AzTenantDeployment
Same with Get-AzManagementGroupDeployment .
Save-AzManagementGroupDeploymentTemplate
Same with Get-AzManagementGroupDeployment .
Save-AzDeploymentTemplate
Same with Get-AzManagementGroupDeployment .
Save-AzTenantDeploymentTemplate
Same with Get-AzManagementGroupDeployment .
Stop-AzManagementGroupDeployment
Same with Get-AzManagementGroupDeployment .
Stop-AzDeployment
Same with Get-AzManagementGroupDeployment .
Stop-AzTenantDeployment
Same with Get-AzManagementGroupDeployment .
Test-AzManagementGroupDeployment
Same with Get-AzManagementGroupDeployment .
Test-AzDeployment
Same with Get-AzManagementGroupDeployment .
Test-AzTenantDeployment
Same with Get-AzManagementGroupDeployment .
Get-AzResourceGroupDeployment
Same with Get-AzManagementGroupDeployment .
Get-AzResourceGroupDeploymentOperation
Same with Get-AzManagementGroupDeployment .
Get-AzResourceGroupDeploymentWhatIfResult
Same with Get-AzManagementGroupDeployment .
New-AzResourceGroupDeployment
Same with Get-AzManagementGroupDeployment .
Remove-AzResourceGroupDeployment
Same with Get-AzManagementGroupDeployment .
Save-AzResourceGroupDeploymentTemplate
Same with Get-AzManagementGroupDeployment .
Stop-AzResourceGroupDeployment
Same with Get-AzManagementGroupDeployment .
Test-AzResourceGroupDeployment
Same with Get-AzManagementGroupDeployment .
Get-AzManagementGroupDeploymentWhatIfResult
Same with Get-AzManagementGroupDeployment .
Get-AzTenantDeploymentWhatIfResult
Same with Get-AzManagementGroupDeployment .
Az.Sql
Set-AzSqlServerActiveDirectoryAdministrator
No longer supports the parameter IsAzureADOnlyAuthentication and no alias was found
for the
original parameter name.
Before
PowerShell
Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName
'ResourceGroup01' -ServerName 'Server01' -DisplayName 'DBAs' -
IsAzureADOnlyAuthentication
After
PowerShell
Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName
'ResourceGroup01' -ServerName 'Server01' -DisplayName 'DBAs'
Az.Synapse
New-AzSynapseSqlPool
No longer supports the parameter FromBackup , FromRestorePoint ,
BackupResourceGroupName ,
BackupWorkspaceName , BackupSqlPoolName ,
BackupSqlPoolObject , BackupResourceId ,
SourceResourceGroupName ,
Before
PowerShell
After
PowerShell
Update-AzSynapseSqlPool
No longer supports the parameter Suspend , Resume , and no alias was found for the
original
parameter name.
Az.Network
Approve-AzPrivateEndpointConnection
No longer supports the parameter PrivateLinkResourceType and no alias was found for
the original
parameter name.
Before
PowerShell
After
PowerShell
Deny-AzPrivateEndpointConnection
Same with Approve-AzPrivateEndpointConnection .
Get-AzPrivateEndpointConnection
Same with Approve-AzPrivateEndpointConnection .
Remove-AzPrivateEndpointConnection
Same with Approve-AzPrivateEndpointConnection .
Set-AzPrivateEndpointConnection
Same with Approve-AzPrivateEndpointConnection .
New-
AzNetworkWatcherConnectionMonitorEndpointObject
No longer supports the parameter FilterType , FilterItem , and no alias was found for
the original
parameter name.
Before
PowerShell
$MySrcResourceId1 = '/subscriptions/00000000-0000-0000-0000-
000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalI
nsights/workspaces/myworkspace'
$SrcEndpointFilterItem1 =New-
AzNetworkWatcherConnectionMonitorEndpointFilterItemObject -Type
'AgentAddress' -Address 'WIN-P0HGNDO2S1B'
$SourceEndpointObject1 = New-AzNetworkWatcherConnectionMonitorEndPointObject
-Name 'workspaceEndpoint' -ResourceId $MySrcResourceId1 -FilterType Include
-FilterItem $SrcEndpointFilterItem1
After
PowerShell
MySrcResourceId1 = '/subscriptions/00000000-0000-0000-0000-
000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalI
nsights/workspaces/myworkspace'
$SourceEndpointObject1 = New-AzNetworkWatcherConnectionMonitorEndPointObject
-Name 'workspaceEndpoint' -ResourceId $MySrcResourceId1
This document describes the changes between the 3.0.0 and 4.1.0 versions of Az.
Az.ApiManagement
Add-AzApiManagementRegion
changed from
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentityType to
System.String .
New-AzApiManagement
Set-AzApiManagement
Get-AzApiManagementProperty
New-AzApiManagementProperty
Remove-AzApiManagementProperty
Set-AzApiManagementProperty
Az.Batch
Get-AzBatchApplication , New-AzBatchApplication
The property ApplicationPackages of type
Microsoft.Azure.Commands.Batch.Models.PSApplication has
been removed.
Get-AzBatchComputeNode , New-AzBatchPool
Get-AzBatchApplicationPackage , New-
AzBatchApplicationPackage
Az.Compute
Remove-AzVmssDiagnosticsExtension
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Get-AzVMImage
New-AzVMConfig
New-AzProximityPlacementGroup
System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.Su
bResource] to
System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.Su
bResourceWithColocationStatus] .
The property VirtualMachinesColocationStatus ,
VirtualMachineScaleSetsColocationStatus , and
AvailabilitySetsColocationStatus
of type
Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup
Before
PowerShell
ResourceGroupName : $resourceGroupName
ProximityPlacementGroupType : Standard
VirtualMachinesColocationStatus : {}
VirtualMachineScaleSetsColocationStatus : {}
AvailabilitySetsColocationStatus : {}
ColocationStatus :
Id : /subscriptions/9e223dbe-3399-4e19-
88eb-
0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/p
roximityPlacementGroups/$proximityPlacementGroupName
Name : $proximityPlacementGroupName
Type :
Microsoft.Compute/proximityPlacementGroups
Location : $location
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
After
PowerShell
ResourceGroupName : $resourceGroupName
ProximityPlacementGroupType : StandardColocationStatus
:
Id : /subscriptions/9e223dbe-3399-4e19-
88eb-
0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/p
roximityPlacementGroups/$proximityPlacementGroupName
Name : $proximityPlacementGroupName
Type :
Microsoft.Compute/proximityPlacementGroups
Location : $location
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
Remove-AzProximityPlacementGroup
System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.Su
bResource] to
System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.Su
bResourceWithColocationStatus] .
Before
PowerShell
PS C:\> Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName
-Name $proximityPlacementGroupName | Remove-AzProximityPlacementGroup |
Format-List
ResourceGroupName : $resourceGroupName
ProximityPlacementGroupType : Standard
VirtualMachinesColocationStatus : {}
VirtualMachineScaleSetsColocationStatus : {}
AvailabilitySetsColocationStatus : {}
ColocationStatus :
Id : /subscriptions/9e223dbe-3399-4e19-
88eb-
0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/p
roximityPlacementGroups/$proximityPlacementGroupName
Name : $proximityPlacementGroupName
Type :
Microsoft.Compute/proximityPlacementGroups
Location : $location
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
After
PowerShell
ResourceGroupName : $resourceGroupName
ProximityPlacementGroupType : StandardColocationStatus
:
Id : /subscriptions/9e223dbe-3399-4e19-
88eb-
0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/p
roximityPlacementGroups/$proximityPlacementGroupName
Name : $proximityPlacementGroupName
Type :
Microsoft.Compute/proximityPlacementGroups
Location : $location
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
Get-AzProximityPlacementGroup
The generic type for property VirtualMachines , VirtualMachineScaleSets , and
AvailabilitySets
has been changed from
System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.Su
bResource] to
System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.Su
bResourceWithColocationStatus] .
of type
Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup
Before
PowerShell
ResourceGroupName : $resourceGroupName
ProximityPlacementGroupType : Standard
VirtualMachinesColocationStatus : {}
VirtualMachineScaleSetsColocationStatus : {}
AvailabilitySetsColocationStatus : {}
ColocationStatus :
Id : /subscriptions/9e223dbe-3399-4e19-
88eb-
0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/p
roximityPlacementGroups/$proximityPlacementGroupName
Name : $proximityPlacementGroupName
Type :
Microsoft.Compute/proximityPlacementGroups
Location : $location
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
After
PowerShell
ResourceGroupName : $resourceGroupName
ProximityPlacementGroupType : StandardColocationStatus
:
Id : /subscriptions/9e223dbe-3399-4e19-
88eb-
0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/p
roximityPlacementGroups/$proximityPlacementGroupName
Name : $proximityPlacementGroupName
Type :
Microsoft.Compute/proximityPlacementGroups
Location : $location
VirtualMachines : {}
VirtualMachineScaleSets : {}
AvailabilitySets : {}
Add-AzVmssAdditionalUnattendContent
Add-AzVmssDataDisk
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Add-AzVmssExtension
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Add-AzVmssNetworkInterfaceConfiguration
The type of property AutomaticRepairsPolicy of type
Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet has
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Add-AzVmssSecret
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Add-AzVmssSshPublicKey
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Add-AzVmssWinRMListener
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
New-AzVmssConfig
Remove-AzVmssDataDisk
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Remove-AzVmssExtension
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Remove-AzVmssNetworkInterfaceConfiguration
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Set-AzVmssBootDiagnostic
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Set-AzVmssOsProfile
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Set-AzVmssRollingUpgradePolicy
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Set-AzVmssStorageProfile
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
New-AzVmss
Repair-AzVmssServiceFabricUpdateDomain
The type of property AutomaticRepairsPolicy of type
Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet has
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Get-AzVmss
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Set-AzVmssOrchestrationServiceState
changed from
Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy to
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Update-AzVmss
Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy .
Add-AzVmssDiagnosticsExtension
Disable-AzVmssDiskEncryption
Az.KeyVault
New-AzKeyVaultCertificateOrganizationDetail
Before
PowerShell
After
PowerShell
New-AzKeyVaultCertificateAdministratorDetail
PowerShell
After
PowerShell
New-AzKeyVault
Before
PowerShell
After
PowerShell
Az.Monitor
Add-AzLogProfile
The type of property RetentionPolicy of type
Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfile has changed from
Microsoft.Azure.Management.Monitor.Management.Models.RetentionPolicy to
Microsoft.Azure.Management.Monitor.Models.RetentionPolicy .
Get-AzLogProfile
Microsoft.Azure.Management.Monitor.Management.Models.RetentionPolicy to
Microsoft.Azure.Management.Monitor.Models.RetentionPolicy .
New-AzMetricAlertRuleV2Criteria
Az.Network
Get-AzNetworkWatcherConnectionMonitor
The generic type for property RoundTripTimeMs has been changed from
System.Nullable1[System.Int32] to System.Nullable1[System.Double] .
New-
AzNetworkWatcherConnectionMonitorTestConfigurationObjec
t
Az.OperationalInsights
Get-AzOperationalInsightsDataSource
New-AzOperationalInsightsAzureActivityLogDataSource
New-AzOperationalInsightsCustomLogDataSource
New-
AzOperationalInsightsLinuxPerformanceObjectDataSource
New-AzOperationalInsightsLinuxSyslogDataSource
New-AzOperationalInsightsWindowsEventDataSource
New-
AzOperationalInsightsWindowsPerformanceCounterDataSourc
e
Disable-AzOperationalInsightsIISLogCollection
Disable-AzOperationalInsightsLinuxCustomLogCollection
Disable-AzOperationalInsightsLinuxPerformanceCollection
Disable-AzOperationalInsightsLinuxSyslogCollection
Enable-AzOperationalInsightsIISLogCollection
Enable-AzOperationalInsightsLinuxCustomLogCollection
Enable-AzOperationalInsightsLinuxPerformanceCollection
Get-AzOperationalInsightsSavedSearch
e has been
removed.
Get-AzOperationalInsightsSavedSearchResult
Get-AzOperationalInsightsSearchResult
Get-AzOperationalInsightsStorageInsight
New-AzOperationalInsightsStorageInsight
Remove-AzOperationalInsightsStorageInsight
Set-AzOperationalInsightsStorageInsight
The property PortalUrl of type
Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace
has been removed.
Get-AzOperationalInsightsLinkTarget
Get-AzOperationalInsightsWorkspace
New-AzOperationalInsightsWorkspace
Set-AzOperationalInsightsWorkspace
Invoke-AzOperationalInsightsQuery
Az.Resources
Get-AzDeploymentScript
The type of property Status of type
Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript has
changed from
Microsoft.Azure.Management.ResourceManager.Models.ScriptStatus to
Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsScriptStatus .
Get-AzDeploymentScriptLog
changed from
Microsoft.Azure.Management.ResourceManager.Models.ScriptStatus to
Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsScriptStatus .
Save-AzDeploymentScriptLog
Get-AzPolicyAlias
The generic type for property Aliases has been changed from
System.Collections.Generic.IList1[Microsoft.Azure.Management.ResourceManager.Models
.AliasType] to
System.Collections.Generic.IList1[Microsoft.Azure.Management.ResourceManager.Models
.Alias] .
New-AzPolicyAssignment
Az.Storage
Update-AzStorageAccountNetworkRuleSet , Get-
AzStorageAccountNetworkRuleSet
New-AzStorageTable , Get-AzStorageTable
Change output type from CloudFile to AzureStorageFile, the original output will become
child
property "CloudFile" of the new output
Before
PowerShell
After
PowerShell
PS C:\> $file = Get-AzStorageFile -ShareName $shareName -Path testfile -
Context $ctx
Before
PowerShell
After
PowerShell
Before
PowerShell
After
PowerShell
Set-AzStorageShareQuota
Before
PowerShell
PS C:\> $shareProperties
After
PowerShell
PS C:\> $share
PS C:\> $share.CloudFileShare.Properties
Remove-AzStorageDirectory
When removing sub File Directories with parent Directory object and -Path, Can't input -
Path from
pipeline with type (string) match anymore.
Before
PowerShell
After
PowerShell
PS C:\> $paths = @(
This document describes the changes between the 2.0.0 and 3.0.0 versions of Az
Batch
Get-AzBatchNodeAgentSku
Before
PowerShell
After
PowerShell
Compute
New-AzDiskConfig
CreateOption is Upload
Before
PowerShell
After
PowerShell
HDInsight
Get-AzHDInsightJobOutput
Before
PowerShell
After
PowerShell
Add-AzHDInsightConfigValues
Before
Using deprecated alias
PowerShell
Add-AzHDInsightConfigValues
After
PowerShell
Add-AzHDInsightConfigValue
Disable-AzHDInsightMonitoring
Before
PowerShell
PowerShell
After
PowerShell
Enable-AzHDInsightMonitoring
PowerShell
PowerShell
Enable-AzHDInsightOperationsManagementSuite Enable-AzHDInsightMonitoring -
Name testcluster -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -
PrimaryKey <key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd>
After
PowerShell
Get-AzHDInsightMonitoring
Added a new Get-AzHDInsightMonitoring cmdlet. Use this cmdlet to get the status of
monitoring installation in an Azure HDInsight cluster (replaces Get-
AzHDInsightOperationsManagementSuite and Get-AzHDInsightOMS ).
Before
PowerShell
PowerShell
After
PowerShell
Get-AzHDInsightMonitoring -Name testcluster
Get-AzHDInsightProperty
Before
PowerShell
After
PowerShell
Grant-AzHDInsightRdpServicesAccess
Remove-AzHDInsightCluster
Before
PowerShell
After
PowerShell
True
Revoke-AzHDInsightRdpServicesAccess
Set-AzHDInsightGatewayCredential
IotHub
New-AzIotHubImportDevices
Before
PowerShell
After
PowerShell
New-AzIotHubExportDevices
Before
PowerShell
After
PowerShell
Add-AzIotHubEventHubConsumerGroup
Before
PowerShell
After
PowerShell
Get-AzIotHubEventHubConsumerGroup
Before
PowerShell
After
PowerShell
Remove-AzIotHubEventHubConsumerGroup
Before
PowerShell
After
PowerShell
Set-AzIotHub
RecoveryServices
Edit-AzRecoveryServicesAsrRecoveryPlan
ASRRecoveryPlanGroup.ReplicationProtectedItems ,
ASRRecoveryPlanGroup.StartGroupActions and ASRRecoveryPlanGroup.EndGroupActions is
Get-AzRecoveryServicesAsrRecoveryPlan
ASRRecoveryPlanGroup.ReplicationProtectedItems ,
ASRRecoveryPlanGroup.StartGroupActions and ASRRecoveryPlanGroup.EndGroupActions is
New-AzRecoveryServicesAsrReplicationProtectedItem
Before
PowerShell
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -
RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId -IncludeDiskId
$includeDiskId -VMwareToAzure -Account
$fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId
$RecoveryResourceGroupId -RecoveryAzureNetworkId $RecoveryAzureNetworkId -
name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -
ProtectableItem $protectableItem -ProtectionContainerMapping $pcm -
RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName
$RecoveryVmName -LogStorageAccountId $LogStorageAccountId
After
PowerShell
Resources
ServiceFabric
Add-ServiceFabricApplicationCertificate
PowerShell
After
PowerShell
$VMSS = New-AzVmssConfig
Sql
Get-AzSqlDatabaseSecureConnectionPolicy
Note that secure connection is deprecated and so command is removed. Please use the
SQL database blade in the Azure portal to view the connection strings
Get-AzSqlDatabaseIndexRecommendations
Get-AzSqlDatabaseRestorePoints
instead.
Get-AzSqlDatabaseAuditing
Before
PowerShell
DatabaseName : database01
AuditAction : {}
AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP,
BATCH_COMPLETED_GROUP, ...}
ResourceGroupName : resourcegroup01
ServerName : server01
AuditState : Enabled
StorageAccountName : mystorage
StorageKeyType : Primary
RetentionInDays : 0
StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3
After
PowerShell
ServerName : server01
DatabaseName : database01
AuditAction : {}
ResourceGroupName : resourcegroup01
AuditActionGroup :
{SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP,
BATCH_COMPLETED_GROUP, ...}
BlobStorageTargetState : Enabled
StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-
af5e-
211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/stor
ageAccounts/mystorage
StorageKeyType : Primary
RetentionInDays : 0
EventHubTargetState : Enabled
EventHubName : eventHubName
EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId
LogAnalyticsTargetState : Enabled
WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-
95a9-e2f1e570ea9c/resourceGroups/insights-
integration/providers/Microsoft.OperationalInsights/workspaces/viruela2"
Set-AzSqlDatabaseAuditing
Before
PowerShell
After
PowerShell
Get-AzSqlServerAuditing
Before
PowerShell
AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP, BATCH_COMPLETED_GROUP, ...}
ResourceGroupName : resourcegroup01
ServerName : server01
AuditState : Enabled
StorageAccountName : mystorage
StorageKeyType : Primary
RetentionInDays : 0
StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3
After
PowerShell
ServerName : server01
ResourceGroupName : resourcegroup01
AuditActionGroup :
{SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP, BATCH_COMPLETED_GROUP, ...}
BlobStorageTargetState : Enabled
StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-
af5e-
211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/stor
ageAccounts/mystorage
StorageKeyType : Primary
RetentionInDays : 0
EventHubTargetState : Enabled
EventHubName : eventHubName
EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId
LogAnalyticsTargetState : Enabled
WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-
95a9-e2f1e570ea9c/resourceGroups/insights-
integration/providers/Microsoft.OperationalInsights/workspaces/viruela2"
Set-AzSqlServerAuditing
Before
PowerShell
After
PowerShell
Get-AzSqlServerAdvancedThreatProtectionSettings
Before
PowerShell
Get-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName
"ResourceGroup11" -ServerName "Server01"
After
PowerShell
Get-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01"
Clear-AzSqlServerAdvancedThreatProtectionSettings
Before
PowerShell
Clear-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName
"ResourceGroup11" -ServerName "Server01"
After
PowerShell
Clear-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01"
Update-AzSqlServerAdvancedThreatProtectionSettings
Before
PowerShell
Update-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails
"[email protected];[email protected]" -EmailAdmins $False -
ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -
StorageAccountName "mystorageAccount"
After
PowerShell
Update-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails
"[email protected];[email protected]" -EmailAdmins $False -
ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -
StorageAccountName "mystorageAccount"
Get-AzSqlDatabaseAdvancedThreatProtectionSettings
Before
PowerShell
Get-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
After
PowerShell
Get-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
Update-AzSqlDatabaseAdvancedThreatProtectionSettings
Before
PowerShell
Update-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -
NotificationRecipientsEmails "[email protected];[email protected]" -
EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability",
"SQL_Injection" -StorageAccountName "mystorageAccount"
After
PowerShell
Update-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -
NotificationRecipientsEmails "[email protected];[email protected]" -
EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability",
"SQL_Injection" -StorageAccountName "mystorageAccount"
Clear-AzSqlDatabaseAdvancedThreatProtectionSettings
Before
PowerShell
Clear-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
After
PowerShell
Clear-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
Update-AzSqlDatabaseVulnerabilityAssessmentSettings
Before
PowerShell
Update-AzSqlDatabaseVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01"`
-ServerName "Server01"`
-DatabaseName "Database01" `
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
After
PowerShell
Update-AzSqlDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01"`
-ServerName "Server01"`
-DatabaseName "Database01" `
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
Get-AzSqlDatabaseVulnerabilityAssessmentSettings
Before
PowerShell
Get-AzSqlDatabaseVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Get-AzSqlDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Clear-AzSqlDatabaseVulnerabilityAssessmentSettings
Before
PowerShell
Clear-AzSqlDatabaseVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Clear-AzSqlDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Update-
AzSqlInstanceDatabaseVulnerabilityAssessmentSettings
Before
PowerShell
Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-InstanceName "ManagedInstance01" `
-DatabaseName "Database01" `
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
After
PowerShell
Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-InstanceName "ManagedInstance01" `
-DatabaseName "Database01" `
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
Get-
AzSqlInstanceDatabaseVulnerabilityAssessmentSettings
Before
PowerShell
Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Clear-
AzSqlInstanceDatabaseVulnerabilityAssessmentSettings
Cmdlet Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings is repleaced by
Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting
Before
PowerShell
Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Update-AzSqlInstanceVulnerabilityAssessmentSettings
Before
PowerShell
Update-AzSqlInstanceVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-InstanceName "ManagedInstance01" `
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
After
PowerShell
Update-AzSqlInstanceVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-InstanceName "ManagedInstance01" `
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
Get-AzSqlInstanceVulnerabilityAssessmentSettings
Before
PowerShell
Get-AzSqlInstanceVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Get-AzSqlInstanceVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Clear-AzSqlInstanceVulnerabilityAssessmentSettings
Before
PowerShell
Clear-AzSqlInstanceVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Clear-AzSqlInstanceVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Update-AzSqlServerVulnerabilityAssessmentSettings
Before
PowerShell
Update-AzSqlServerVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01"`
-ServerName "Server01"`
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
After
PowerShell
Update-AzSqlServerVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01"`
-ServerName "Server01"`
-StorageAccountName "mystorage" `
-ScanResultsContainerName "vulnerability-assessment" `
-RecurringScansInterval Weekly `
-EmailSubscriptionAdmins $true `
Get-AzSqlServerVulnerabilityAssessmentSettings
Before
PowerShell
Get-AzSqlServerVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Get-AzSqlServerVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Clear-AzSqlServerVulnerabilityAssessmentSettings
Before
PowerShell
Clear-AzSqlServerVulnerabilityAssessmentSettings `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
After
PowerShell
Clear-AzSqlDatabaseVulnerabilityAssessmentSetting `
-ResourceGroupName "ResourceGroup01" `
-ServerName "Server01" `
-DatabaseName "Database01"
Get-AzSqlServerAdvancedThreatProtectionPolicy
Get-AzSqlServerThreatDetectionPolicy
Before
PowerShell
ResourceGroupName : ResourceGroup11
ServerName : Server01
ThreatDetectionState : Enabled
NotificationRecipientsEmails : [email protected]
StorageAccountName : mystorage
EmailAdmins : True
ExcludedDetectionTypes : {}
RetentionInDays : 0
After
PowerShell
ResourceGroupName : ResourceGroup11
ServerName : Server01
ThreatDetectionState : Enabled
NotificationRecipientsEmails : [email protected]
StorageAccountName : mystorage
EmailAdmins : True
ExcludedDetectionTypes : {}
RetentionInDays : 0
Remove-AzSqlServerThreatDetectionPolicy
Before
PowerShell
After
PowerShell
Clear-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01"
Set-AzSqlServerThreatDetectionPolicy
Before
PowerShell
After
PowerShell
Update-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails
"[email protected];[email protected]" -EmailAdmins $False -
ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -
StorageAccountName "mystorageAccount"
Get-AzSqlDatabaseThreatDetectionPolicy
Before
PowerShell
DatabaseName : Database01
ResourceGroupName : ResourceGroup11
ServerName : Server01
ThreatDetectionState : Enabled
NotificationRecipientsEmails : [email protected]
StorageAccountName : mystorage
EmailAdmins : True
ExcludedDetectionTypes : {}
RetentionInDays : 0
After
PowerShell
DatabaseName : Database01
ResourceGroupName : ResourceGroup11
ServerName : Server01
ThreatDetectionState : Enabled
NotificationRecipientsEmails : [email protected]
StorageAccountName : mystorage
EmailAdmins : True
ExcludedDetectionTypes : {}
RetentionInDays : 0
Set-AzSqlDatabaseThreatDetectionPolicy
Cmdlet Set-AzSqlDatabaseThreatDetectionPolicy is repleaced by Update-
AzSqlDatabaseAdvancedThreatProtectionSetting
Before
PowerShell
After
PowerShell
Update-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -
NotificationRecipientsEmails "[email protected];[email protected]" -
EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability",
"SQL_Injection" -StorageAccountName "mystorageAccount"
Remove-AzSqlDatabaseThreatDetectionPolicy
Before
PowerShell
Remove-AzSqlDatabaseThreatDetectionPolicy -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
After
PowerShell
Clear-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName
"ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
This document describes the changes between the 1.0.0 and 2.0.0 versions of Az
Table of Contents
Module breaking changes
Az.Compute
Az.HDInsight
Az.Storage
Az.Compute
Removed Managed Parameter from New-AzAvailabilitySet and Update-
AzAvailabilitySet cmdlets in favor of using Sku = Aligned
Before
PowerShell
Update-AzAvailabilitySet -Managed
After
PowerShell
Before
Note that the below code is functional, but the passed-in ImageName is not used,
so removing this parameter has no functional impact.
PowerShell
After
PowerShell
Before
Note that the below code is functional, but the passed-in Name is not used, so
removing this parameter has no functional impact.
PowerShell
After
PowerShell
Before
Note that the below code is functional, but the passed-in Name is not used, so
removing this parameter has no functional impact.
PowerShell
After
PowerShell
Before
Note that the below code is functional, but the passed-in Name is not used, so
removing this parameter has no functional impact.
PowerShell
After
PowerShell
PowerShell
After
PowerShell
Before
Note that the below code is functional, but the passed-in Name is not used, so
removing this parameter has no functional impact.
PowerShell
After
PowerShell
Before
Note that the below code is functional, but the passed-in Name is not used, so
removing this parameter has no functional impact.
PowerShell
After
PowerShell
Before
PowerShell
$vmss.ProtectFromScaleIn = $true
$vmss.ProtectFromScaleIn = $true
$vmss.ProtectFromScaleIn = $true
After
PowerShell
$vmss = Get-AzVMssVM ...
$vmss.ProtectionPolicy.ProtectFromScaleIn = $true
$vmss.ProtectionPolicy.ProtectFromScaleIn = $true
$vmss.ProtectionPolicy.ProtectFromScaleIn = $true
Before
PowerShell
$disk.EncryptionSettings
$disk.EncryptionSettings
$update.EncryptionSettings
$update.EncryptionSettings
After
PowerShell
$disk.EncryptionSettingsCollection.EncryptionSettings
$disk.EncryptionSettingsCollection.EncryptionSettings
$update.EncryptionSettingsCollection.EncryptionSettings
$update.EncryptionSettingsCollection.EncryptionSettings
Before
PowerShell
$snap.EncryptionSettings
$snap.EncryptionSettings
$update.EncryptionSettings
$update.EncryptionSettings
After
PowerShell
$snap.EncryptionSettingsCollection.EncryptionSettings
$snap.EncryptionSettingsCollection.EncryptionSettings
$update.EncryptionSettingsCollection.EncryptionSettings
$update.EncryptionSettingsCollection.EncryptionSettings
Before
PowerShell
$vmss.VirtualMachineProfile.AdditionalCapabilities.UltraSSDEnabled =
$true
After
PowerShell
$vmss.AdditionalCapabilities.UltraSSDEnabled = $true
Before
Using deprecated alias
PowerShell
Set-AzVMBootDiagnostics
After
PowerShell
Set-AzVMBootDIagnostic
Before
Using deprectaed alias
PowerShell
Export-AzLogAnalyticThrottledRequests
After
PowerShell
Export-AzLogAnalyticThrottledRequest
Az.HDInsight
Removed the Grant-AzHDInsightHttpServicesAccess and Revoke-
AzHDInsightHttpServicesAccess cmdlets. These are no longer necessary because
For more information about these role-based access changes, see aka.ms/hdi-config-
update
Before
PowerShell
After
PowerShell
Before
PowerShell
After
PowerShell
Az.Storage
Namespaces for types returned from Blob, Queue, and File cmdlets have changed
their namespace from Microsoft.WindowsAzure.Storage to
Microsoft.Azure.Storage . While this is not technically a breaking change according
to the breaking change policy, it may require some changes in code that uses the
methods from the Storage .Net SDK to interact with the objects returned from
these cmdlets.
Before:
PowerShell
$queue.CloudQueue.AddMessageAsync($QueueMessage)
After:
PowerShell
$queue.CloudQueue.AddMessageAsync($QueueMessage)
Before:
PowerShell
$accessCondition= New-Object
Microsoft.WindowsAzure.Storage.AccessCondition
$blob.ICloudBlob.FetchAttributes($accessCondition)
$file.FetchAttributes($accessCondition)
After:
PowerShell
$blob.ICloudBlob.FetchAttributes($accessCondition)
$file.FetchAttributes($accessCondition)
While not technically a breaking change, you will notice output differences in the
Sku.Name property of Storage Accounts returned from New/Get/Set-
AzStorageAccount changes are as follows. (After the change, output and input
The default service behavior when creating a storage account withous specifying a
Kind has changed. In previous versions, when a storage account was created with
no Kind specified, the Storage account Kind of Storage was used, in the new
version StorageV2 is the default Kind value. If you need to create a V1 Storage
account with Kind 'Storage', add parameter '-Kind Storage'
PowerShell
After:
PowerShell
This document provides detailed information on the changes between AzureRM 6.x and
the new Az
module, version 1.x and later. The table of contents will help guide you
through a full migration
path, including module-specific changes that may affect your
scripts.
For general advice on getting started with a migration from AzureRM to Az, see Start
migration from
AzureRM to Az.
) Important
There have been breaking changes between Az 1.0.0 and Az 2.0.0 as well. After
following this guide
for updating from AzureRM to Az, see the Az 2.0.0 breaking
changes to find out
if you need to make additional changes.
Table of Contents
General breaking changes
Cmdlet noun prefix changes
Module name changes
Removed modules
Windows PowerShell 5.1 and .NET 4.7.2
Temporary removal of user login using PSCredential
Default device code login instead of web browser prompt
Module breaking changes
Az.ApiManagement (previously AzureRM.ApiManagement)
Az.Billing (previously AzureRM.Billing, AzureRM.Consumption, and
AzureRM.UsageAggregates)
Az.CognitiveServices (previously AzureRM.CognitiveServices)
Az.Compute (previously AzureRM.Compute)
Az.DataFactory (previously AzureRM.DataFactories and AzureRM.DataFactoryV2)
Az.DataLakeAnalytics (previously AzureRM.DataLakeAnalytics)
Az.DataLakeStore (previously AzureRM.DataLakeStore)
Az.KeyVault (previously AzureRM.KeyVault)
Az.Media (previously AzureRM.Media)
Az.Monitor (previously AzureRM.Insights)
Az.Network (previously AzureRM.Network)
Az.OperationalInsights (previously AzureRM.OperationalInsights)
Az.RecoveryServices (previously AzureRM.RecoveryServices,
AzureRM.RecoveryServices.Backup, and
AzureRM.RecoveryServices.SiteRecovery)
Az.Resources (previously AzureRM.Resources)
Az.ServiceFabric (previously AzureRM.ServiceFabric)
Az.Sql (previously AzureRM.Sql)
Az.Storage (previously Azure.Storage and AzureRM.Storage)
Az.Websites (previously AzureRM.Websites)
Azure PowerShell
Get-AzureRMVM
Get-AzureKeyVaultSecret
Azure PowerShell
Get-AzVM
Get-AzKeyVaultSecret
To make the transition to these new cmdlet names simpler, Az introduces two new
cmdlets, Enable-AzureRmAlias and Disable-AzureRmAlias. Enable-AzureRmAlias creates
aliases for the older cmdlet names in AzureRM that map to the newer Az cmdlet names.
Using the -Scope argument with Enable-AzureRmAlias allows you to choose where
aliases are enabled.
Azure PowerShell
#Requires -Modules AzureRM.Storage
Azure PowerShell
Running Enable-AzureRmAlias -Scope CurrentUser will enable the aliases for all
PowerShell sessions you open, so that after executing this cmdlet, a script like this would
not need to be changed at all:
Azure PowerShell
For complete details on the usage of the alias cmdlets, see the Enable-AzureRmAlias
reference.
When you're ready to disable aliases, Disable-AzureRmAlias removes the created aliases.
For complete details,
see the Disable-AzureRmAlias reference.
) Important
When disabling aliases, make sure that they are disabled for all scopes which had
aliases enabled.
Azure.Storage Az.Storage
Azure.AnalysisServices Az.AnalysisServices
AzureRM.Profile Az.Accounts
AzureRM module Az module
AzureRM.Insights Az.Monitor
AzureRM.DataFactories Az.DataFactory
AzureRM.DataFactoryV2 Az.DataFactory
AzureRM.RecoveryServices.Backup Az.RecoveryServices
AzureRM.RecoveryServices.SiteRecovery Az.RecoveryServices
AzureRM.Tags Az.Resources
AzureRM.MachineLearningCompute Az.MachineLearning
AzureRM.UsageAggregates Az.Billing
AzureRM.Consumption Az.Billing
The changes in module names mean that any script that uses #Requires or Import-
Module to load specific modules will need to be changed to use the new module instead.
For modules where the cmdlet suffix has not changed,
this means that although the
module name has changed, the suffix indicating the operation space has not.
Azure PowerShell
Azure PowerShell
For Import-Module :
Azure PowerShell
Azure PowerShell
Azure PowerShell
AzureRM.Compute\Get-AzureRmVM
Azure PowerShell
Az.Compute\Get-AzVM
PowerShell
PowerShell
Removed modules
The following modules have been removed:
AzureRM.Backup
AzureRM.Compute.ManagedService
AzureRM.Scheduler
The tools for these services are no longer actively supported. Customers are encouraged
to move to alternative services as soon as it is convenient.
Az.ApiManagement (previously
AzureRM.ApiManagement)
Removed the following cmdlets:
New-AzureRmApiManagementHostnameConfiguration
Set-AzureRmApiManagementHostnames
Update-AzureRmApiManagementDeployment
Import-AzureRmApiManagementHostnameCertificate
Use Set-AzApiManagement cmdlet to set these properties instead
Removed the following properties:
Removed property PortalHostnameConfiguration , ProxyHostnameConfiguration ,
ManagementHostnameConfiguration and ScmHostnameConfiguration of type
PsApiManagementHostnameConfiguration from PsApiManagementContext . Instead
of type PsApiManagementCustomHostNameConfiguration .
Removed property StaticIPs from PsApiManagementContext. The property
has been split into PublicIPAddresses and PrivateIPAddresses .
Removed required property Location from New-
AzureApiManagementVirtualNetwork cmdlet.
Az.CognitiveServices (previously
AzureRM.CognitiveServices)
Removed GetSkusWithAccountParamSetName parameter set from Get-
AzCognitiveServicesAccountSkus cmdlet. You must get Skus by Account Type and
PSVirtualMachineScaleSet objects
Scripts should no longer use the value of this
field to make processing decisions.
The type of InstanceView property of PSVirtualMachineScaleSetVM object is
changed from VirtualMachineInstanceView to
VirtualMachineScaleSetVMInstanceView
Az.DataLakeAnalytics (previously
AzureRM.DataLakeAnalytics)
Removed deprecated cmdlets: New-AzDataLakeAnalyticsCatalogSecret , Remove-
AzDataLakeAnalyticsCatalogSecret , and Set-AzDataLakeAnalyticsCatalogSecret
Scripts using
Azure PowerShell
Should be changed to
Azure PowerShell
Azure PowerShell
Should be changed to
Azure PowerShell
Azure PowerShell
Should be changed to
Azure PowerShell
Scripts should no longer make processing decisions based on the values fo these fields.
Az.OperationalInsights (previously
AzureRM.OperationalInsights)
Default parameter set for Get-AzOperationalInsightsDataSource is removed, and
ByWorkspaceNameByKind has become the default parameter set
Azure PowerShell
Get-AzureRmOperationalInsightsDataSource
Azure PowerShell
Az.RecoveryServices (previously
AzureRM.RecoveryServices,
AzureRM.RecoveryServices.Backup, and
AzureRM.RecoveryServices.SiteRecovery)
Removed Encryption parameter from New/Set-AzRecoveryServicesAsrPolicy
cmdlet
TargetStorageAccountName parameter is now mandatory for managed disk restores
in Restore-AzRecoveryServicesBackupItem cmdlet
Removed StorageAccountName and StorageAccountResourceGroupName parameters in
Restore-AzRecoveryServicesBackupItem cmdlet
Removed Name parameter in Get-AzRecoveryServicesBackupContainer cmdlet
Azure PowerShell
Azure PowerShell
$secPassword = $credential.Secret
AzSqlServerAuditing
Removed deprecated parameter Current from Get-
AzSqlDatabaseBackupLongTermRetentionPolicy cmdlet
Removed deprecated parameter DatabaseName from Get-
AzSqlServerServiceObjective cmdlet
Blob Snapshot
AzureRM:
Azure PowerShell
$b.ICloudBlob.Snapshot()
Az:
Azure PowerShell
$task = $b.ICloudBlob.SnapshotAsync()
$task.Wait()
$snapshot = $task.Result
Share Snapshot
AzureRM:
Azure PowerShell
$snapshot = $Share.Snapshot()
Az:
Azure PowerShell
$task = $Share.SnapshotAsync()
$task.Wait()
$snapshot = $task.Result
Azure PowerShell
$b.ICloudBlob.Undelete()
Az:
Azure PowerShell
$task = $b.ICloudBlob.UndeleteAsync()
$task.Wait()
Azure PowerShell
$blockBlob.ICloudBlob.SetStandardBlobTier("hot")
$pageBlob.ICloudBlob.SetPremiumBlobTier("P4")
Az:
Azure PowerShell
$task = $blockBlob.ICloudBlob.SetStandardBlobTierAsync("hot")
$task.Wait()
$task = $pageBlob.ICloudBlob.SetPremiumBlobTierAsync("P4")
$task.Wait()
All versions of the AzureRM PowerShell module are outdated. The Az PowerShell
module is now the recommended PowerShell module for interacting with Azure.
U Caution
Like the PowerShell language, we're committed to bringing Azure support to all
platforms. Our
commitment meant that the Azure PowerShell modules needed to be
updated to use .NET Standard and be
compatible with PowerShell Core. Rather than
modifying the existing AzureRM module and introducing
complex changes to add this
support, the Az module was created.
Creating a new module also allowed our engineers to make the design, naming of
cmdlets, and modules
consistent. All modules now start with the Az. prefix and cmdlets
all use the Verb-AzNoun naming
convention. Previously, cmdlet names were longer and
inconsistent.
The number of modules were also reduced: Some modules that worked with the same
services have been
combined. Management plane and data plane cmdlets for the same
service are now contained within a
single module. For those of you who manually
manage dependencies and imports, this consolidation
makes things much simpler.
By making these important changes, the team has committed to making it easier than
ever before and
on more platforms than previously possible to use Azure with
PowerShell cmdlets.
Upgrading to Az PowerShell
Scripts written for the AzureRM cmdlets won't automatically work with Az. To make the
transition easier, the
AzureRM to Az migration toolkit was
developed. No migration to
a new command set is ever convenient, but this article will help you get
started on
transitioning to the Az PowerShell module. To learn more about why the Az PowerShell
module was created, see Introducing the new Azure PowerShell Az module.
The new cmdlet names have been designed to be easy to learn. Instead of using
AzureRm or Azure
in cmdlet names, use Az . For example, the old cmdlet New-AzureRMVm
has become New-AzVm .
However, migration is more than becoming familiar with the new
cmdlet names, though. There are
renamed modules, parameters, and other important
changes.
To see the full list of breaking changes between AzureRM and Az, see the
full changes
from AzureRM to Az.
To determine what versions of AzureRM you have installed, run the following example:
PowerShell
The latest available release of AzureRM is 6.13.2. If you don't have this version installed,
your existing scripts may need additional modifications to work with the Az module
beyond the scope
of what's described in this article and in the breaking changes list.
If your scripts don't work with AzureRM 6.13.2, update them according to the
AzureRM
5.x to 6.x migration guide. If you use an
earlier version of the AzureRM module, there
are migration guides available for each major version.
Option 1 (recommended): Automatically
migrate your PowerShell scripts
This recommended option minimizes the effort required to migrate AzureRM scripts to
Az.
) Important
Even though the cmdlet names are aliased, there may still be new (or renamed)
parameters or
changed return values for the Az cmdlets. Don't expect enabling
aliases to take care of the
migration for you. See the full breaking changes list to
find where your
scripts may require updates.
Option 3: Migrate your scripts in Visual Studio
Code with the Azure PowerShell extension
Next steps
Uninstall AzureRM
Install Azure PowerShell
Quickstart: Automatically migrate
PowerShell scripts from AzureRM to the
Az PowerShell module
Article • 07/04/2023
In this article, you'll learn how to use the Az.Tools.Migration PowerShell module to
automatically
upgrade your PowerShell scripts and script modules from AzureRM to the
Az PowerShell module. For
additional migration options, see
Migrate Azure PowerShell
from AzureRM to Az.
U Caution
Requirements
Update your existing PowerShell scripts to the latest version of the
AzureRM
PowerShell module (6.13.1) .
PowerShell
The following example generates a plan for all the scripts in the C:\Scripts folder. The
OutVariable parameter is specified so the results are returned and simultaneously
stored in a
variable named Plan .
PowerShell
# Generate an upgrade plan for all the scripts and module files in the
specified folder and save it to a variable.
As shown in the following output, the upgrade plan details the specific file and offset
points that
require changes when moving from AzureRM to the Az PowerShell cmdlets.
Output
1 compute-create-dockerhost.ps1:59:24
CmdletParameter ReadyToUpgrade ExtensionName
2 compute-create-dockerhost.ps1:59:1 Cmdlet
ReadyToUpgrade Set-AzureRmVM...
3 compute-create-dockerhost.ps1:54:1 Cmdlet
ReadyToUpgrade New-AzureRmVM
4 compute-create-dockerhost.ps1:51:1 Cmdlet
ReadyToUpgrade Add-AzureRmVM...
5 compute-create-dockerhost.ps1:47:1 Cmdlet
ReadyToUpgrade Add-AzureRmVM...
6 compute-create-dockerhost.ps1:46:1 Cmdlet
ReadyToUpgrade Set-AzureRmVM...
7 compute-create-dockerhost.ps1:45:1 Cmdlet
ReadyToUpgrade Set-AzureRmVM...
8 compute-create-dockerhost.ps1:44:13 Cmdlet
ReadyToUpgrade New-AzureRmVM...
9 compute-create-dockerhost.ps1:40:8 Cmdlet
ReadyToUpgrade New-AzureRmNe...
10 compute-create-dockerhost.ps1:36:8 Cmdlet
ReadyToUpgrade New-AzureRmNe...
11 compute-create-dockerhost.ps1:31:16 Cmdlet
ReadyToUpgrade New-AzureRmNe...
12 compute-create-dockerhost.ps1:26:15 Cmdlet
ReadyToUpgrade New-AzureRmNe...
13 compute-create-dockerhost.ps1:22:8 Cmdlet
ReadyToUpgrade New-AzureRmPu...
14 compute-create-dockerhost.ps1:18:9 Cmdlet
ReadyToUpgrade New-AzureRmVi...
15 compute-create-dockerhost.ps1:15:17 Cmdlet
ReadyToUpgrade New-AzureRmVi...
16 compute-create-dockerhost.ps1:12:1 Cmdlet
ReadyToUpgrade New-AzureRmRe...
17 compute-create-windowsvm-quick.ps1:18:3
CmdletParameter ReadyToUpgrade ImageName
18 compute-create-windowsvm-quick.ps1:14:1 Cmdlet
ReadyToUpgrade New-AzureRmVM
19 compute-create-windowsvm-quick.ps1:11:1 Cmdlet
ReadyToUpgrade New-AzureRmRe...
20 compute-create-wordpress-mysql.ps1:59:24
CmdletParameter ReadyToUpgrade ExtensionName
...
Before performing the upgrade, you need to view the results of the plan for problems.
The following
example returns a list of scripts and the items in those scripts that will
prevent them from being
upgraded automatically.
PowerShell
The items shown in the following output won't be upgraded automatically without
manually correcting
the issues first.
Output
Order : 42
UpgradeType : CmdletParameter
PlanResult : ErrorParameterNotFound
PlanSeverity : Error
SourceCommand : CommandReference
SourceCommandParameter : CommandReferenceParameter
Location : devtestlab-add-marketplace-image-to-lab.ps1:14:74
FullPath : C:\Scripts\devtestlab-add-marketplace-image-to-
lab.ps1
StartOffset : 556
Original : ResourceNameEquals
Replacement :
There is no undo operation. Always ensure that you have a backup copy of your
PowerShell scripts
and modules that you're attempting to upgrade.
After you’re satisfied with the plan, the upgrade is performed with the
Invoke-
AzUpgradeModulePlan cmdlet. Specify SaveChangesToNewFiles for the
FileEditMode
parameter value to prevent changes from being made to your original scripts. When
using this mode, the upgrade is performed by creating a copy of each script targeted
with
_az_upgraded appended to the filenames.
2 Warning
SaveChangesToNewFiles instead.
PowerShell
# Execute the automatic upgrade plan and save the results to a variable.
Output
1 compute-create-dockerhost.ps1:59:24
CmdletParameter UpgradeCompleted ExtensionName
2 compute-create-dockerhost.ps1:59:1 Cmdlet
UpgradeCompleted Set-AzureRmVMExtens...
3 compute-create-dockerhost.ps1:54:1 Cmdlet
UpgradeCompleted New-AzureRmVM
4 compute-create-dockerhost.ps1:51:1 Cmdlet
UpgradeCompleted Add-AzureRmVMSshPub...
5 compute-create-dockerhost.ps1:47:1 Cmdlet
UpgradeCompleted Add-AzureRmVMNetwor...
6 compute-create-dockerhost.ps1:46:1 Cmdlet
UpgradeCompleted Set-AzureRmVMSource...
7 compute-create-dockerhost.ps1:45:1 Cmdlet
UpgradeCompleted Set-AzureRmVMOperat...
8 compute-create-dockerhost.ps1:44:13 Cmdlet
UpgradeCompleted New-AzureRmVMConfig
9 compute-create-dockerhost.ps1:40:8 Cmdlet
UpgradeCompleted New-AzureRmNetworkI...
10 compute-create-dockerhost.ps1:36:8 Cmdlet
UpgradeCompleted New-AzureRmNetworkS...
11 compute-create-dockerhost.ps1:31:16 Cmdlet
UpgradeCompleted New-AzureRmNetworkS...
12 compute-create-dockerhost.ps1:26:15 Cmdlet
UpgradeCompleted New-AzureRmNetworkS...
13 compute-create-dockerhost.ps1:22:8 Cmdlet
UpgradeCompleted New-AzureRmPublicIp...
14 compute-create-dockerhost.ps1:18:9 Cmdlet
UpgradeCompleted New-AzureRmVirtualN...
15 compute-create-dockerhost.ps1:15:17 Cmdlet
UpgradeCompleted New-AzureRmVirtualN...
16 compute-create-dockerhost.ps1:12:1 Cmdlet
UpgradeCompleted New-AzureRmResource...
17 compute-create-windowsvm-quick.ps1:18:3
CmdletParameter UpgradeCompleted ImageName
18 compute-create-windowsvm-quick.ps1:14:1 Cmdlet
UpgradeCompleted New-AzureRmVM
19 compute-create-windowsvm-quick.ps1:11:1 Cmdlet
UpgradeCompleted New-AzureRmResource...
20 compute-create-wordpress-mysql.ps1:59:24
CmdletParameter UpgradeCompleted ExtensionName
...
If any errors are returned, you can take a closer look at the error results with the
following command:
PowerShell
Output
Order : 42
UpgradeType : CmdletParameter
UpgradeResult : UnableToUpgrade
UpgradeSeverity : Error
SourceCommand : CommandReference
SourceCommandParameter : CommandReferenceParameter
Location : devtestlab-add-marketplace-image-to-lab.ps1:14:74
FullPath : C:\Scripts\devtestlab-add-marketplace-image-to-
lab.ps1
StartOffset : 556
Original : ResourceNameEquals
Replacement :
Limitations
File I/O operations use default encoding. Unusual file encoding situations may
cause problems.
AzureRM cmdlets passed as arguments to Pester unit test mock statements aren't
detected.
Next steps
To learn more about the Az PowerShell module, see the Azure PowerShell
documentation
PowerShell samples for Azure App
Service
Article • 04/09/2023
The following table includes links to PowerShell scripts built using the Azure PowerShell.
Script Description
Create app
Create an app with Creates an App Service app that pulls code from GitHub.
deployment from GitHub
Create an app with Creates an App Service app that continuously deploys code from
continuous deployment GitHub.
from GitHub
Create an app and deploy Creates an App Service app and upload files from a local directory
code with FTP using FTP.
Create an app and deploy Creates an App Service app and configures code push from a local
code from a local Git Git repository.
repository
Create an app and deploy Creates an App Service app with a deployment slot for staging code
code to a staging changes.
environment
Create an app and expose Creates an App Service app with a Private Endpoint.
your app with a Private
Endpoint
Configure app
Map a custom domain to Creates an App Service app and maps a custom domain name to it.
an app
Bind a custom TLS/SSL Creates an App Service app and binds the TLS/SSL certificate of a
certificate to an app custom domain name to it.
Scale app
Scale an app manually Creates an App Service app and scales it across 2 instances.
Scale an app worldwide Creates two App Service apps in two different geographical regions
with a high-availability and makes them available through a single endpoint using Azure
architecture Traffic Manager.
Script Description
Connect an app to a SQL Creates an App Service app and a database in Azure SQL Database,
Database then adds the database connection string to the app settings.
Connect an app to a Creates an App Service app and a storage account, then adds the
storage account storage connection string to the app settings.
Back up an app Creates an App Service app and creates a one-time backup for it.
Create a scheduled Creates an App Service app and creates a scheduled backup for it.
backup for an app
Restore a backup across Restores a web app from a backup in another subscription.
subscriptions
Monitor app
Monitor an app with web Creates an App Service app, enables logging for it, and downloads
server logs the logs to your local machine.
Azure PowerShell samples for Azure SQL
Database and Azure SQL Managed
Instance
Article • 03/30/2023
Applies to:
Azure SQL Database
Azure SQL Managed Instance
Azure SQL Database and Azure SQL Managed Instance enable you to configure your
databases, instances, and pools using Azure PowerShell.
If you don't have an Azure subscription, create an Azure free account before you
begin.
Option Example/Link
Select the Cloud Shell button on the menu bar at the upper right
in the Azure portal .
3. Paste the code into the Cloud Shell session by selecting Ctrl+Shift+V on Windows
and Linux, or by selecting Cmd+Shift+V on macOS.
4. Select Enter to run the code.
If you choose to install and use the PowerShell locally, this tutorial requires AZ
PowerShell 1.4.0 or later. If you need to upgrade, see Install Azure PowerShell module. If
you are running PowerShell locally, you also need to run Connect-AzAccount to create a
connection with Azure.
The following table includes links to sample Azure PowerShell scripts for Azure SQL
Database.
Link Description
Create a single database This PowerShell script creates a single database and configures a
and configure a server- server-level IP firewall rule.
level firewall rule
Create elastic pools and This PowerShell script creates elastic pools, moves pooled
move pooled databases databases, and changes compute sizes.
Configure geo-
replication and failover
Configure and fail over a This PowerShell script configures active geo-replication for a
single database using single database and fails it over to the secondary replica.
active geo-replication
Configure and fail over a This PowerShell script configures active geo-replication for a
pooled database using database in an elastic pool and fails it over to the secondary
active geo-replication replica.
Configure a failover
group
Configure a failover This PowerShell script creates a database and a failover group,
group for a single adds the database to the failover group, and tests failover to the
database secondary server.
Scale a single database This PowerShell script monitors the performance metrics of a
single database, scales it to a higher compute size, and creates
an alert rule on one of the performance metrics.
Scale an elastic pool This PowerShell script monitors the performance metrics of an
elastic pool, scales it to a higher compute size, and creates an
alert rule on one of the performance metrics.
Import a database from a This PowerShell script imports a database into Azure SQL
bacpac file Database from a bacpac file.
Sync data between This PowerShell script configures Data Sync to sync between
databases multiple databases in Azure SQL Database.
Sync data between SQL This PowerShell script configures Data Sync to sync between a
Database and SQL Server database in Azure SQL Database and a SQL Server on-premises
on-premises database.
Update the SQL Data This PowerShell script adds or removes items from the Data Sync
Sync sync schema sync schema.
Next steps
The examples listed on this page use az.sql PowerShell cmdlets for creating and
managing Azure SQL resources. Additional cmdlets for running queries and performing
many database tasks are located in the SqlServer PowerShell cmdlets. For more
information, see SQL Server PowerShell.
Azure PowerShell samples for Azure
Cosmos DB for NoSQL
Article • 04/13/2023
APPLIES TO:
NoSQL
The following table includes links to commonly used Azure PowerShell scripts for Azure
Cosmos DB. Use the links on the right to navigate to API specific samples. Common
samples are the same across all APIs. Reference pages for all Azure Cosmos DB
PowerShell cmdlets are available in the Azure PowerShell Reference. The Az.CosmosDB
module is now part of the Az module. Download and install the latest version of Az
module to get the Azure Cosmos DB cmdlets. You can also get the latest version from
the PowerShell Gallery . You can also fork these PowerShell samples for Azure Cosmos
DB from our GitHub repository, Azure Cosmos DB PowerShell Samples on GitHub .
For PowerShell cmdlets for other APIs see PowerShell Samples for Cassandra, PowerShell
Samples for API for MongoDB, PowerShell Samples for Gremlin, PowerShell Samples for
Table
Common Samples
Task Description
Change failover priority or Change the regional failover priority of an Azure Cosmos DB
trigger failover account or trigger a manual failover.
Account keys or connection Get primary and secondary keys, connection strings or regenerate
strings an account key of an Azure Cosmos DB account.
Create an Azure Cosmos DB Create an Azure Cosmos DB account with IP Firewall enabled.
Account with IP Firewall
Create an account, Create an Azure Cosmos DB account, database and container with
database and container autoscale.
with autoscale
Create a container with no Create an Azure Cosmos DB container with index policy turned off.
index policy
Lock resources from Prevent resources from being deleted with resource locks.
deletion
Azure command line tools survey
guidance
Article • 07/04/2023
When using Azure PowerShell, you may be invited to participate in a survey to tell us
about your
experience. By responding to the survey, you help to identify common issues
and areas for
improvement. Understanding your experiences and opinions helps to
make future releases of Azure
command line tools better for you and others.
While we appreciate the insights this data provides, we understand not everyone wants
to be prompted
to complete a survey. You can disable being prompted to participate in
surveys with the
Update-AzConfig cmdlet or via an environment variable.
Azure PowerShell
You can also use the $Env:AzSurveyMessage environment variable to disable the survey
message.
Azure PowerShell
Privacy statement
Your privacy is important to us.
Microsoft's Privacy Statement explains the
personal
data Microsoft processes, how Microsoft processes it, and for what purposes.
Troubleshooting the Azure Az
PowerShell module
Article • 07/04/2023
To enable debug logging on a per command basis, specify the Debug parameter.
Azure PowerShell
To enable debug logging for an entire PowerShell session, you set the value of the
DebugPreference variable to Continue .
PowerShell
$DebugPreference = 'Continue'
Installation
This section contains a list of solutions to common problems when installing the Azure
Az PowerShell
module.
2 Warning
We do not support having both the AzureRM and Az PowerShell modules installed
in Windows
PowerShell 5.1 at the same time.
In a scenario where you need to install both the AzureRM and Az PowerShell module on
the same
Windows system:
AzureRM must be installed only in the current user scope of Windows PowerShell
5.1.
Install the Az PowerShell module in PowerShell 7.0.6 LTS, PowerShell 7.1.3, or
higher.
U Caution
Visual Studio
Older versions of Visual Studio may install Azure PowerShell as part of the Azure
development
workload, which installs the AzureRM module. Azure PowerShell can be
removed using the Visual Studio
installer or by using "Uninstall" in Apps & features. If
you have already installed PowerShell 7.x,
you may need to manually install the Azure Az
PowerShell module.
PowerShell itself may not be configured to use this proxy automatically. With PowerShell
5.1 and
later, configure the PowerShell session to use a proxy using the following
commands:
PowerShell
$webClient.Proxy.Credentials =
[System.Net.CredentialCache]::DefaultNetworkCredentials
If your operating system credentials are configured correctly, this configuration routes
PowerShell
requests through the proxy. To have this setting persist between sessions,
add the commands to your
PowerShell profile.
Azure PowerShell
$resourceId = '/subscriptions/00000000-0000-0000-0000-
000000000000/resourceGroups/<resource-group-
name>/providers/Microsoft.Web/sites/<webapp-
name>/privateEndpointConnections/<endpoint-name>'
Output
You can use the Get-AzResource cmdlet to verify that the specified Azure resource exists.
Azure PowerShell
The following example requires the Az PowerShell module. Replace myGroupName in the
first line
with the name of your group.
Azure PowerShell
((Invoke-AzRestMethod -Uri
"https://graph.microsoft.com/beta/groups/$($Group.id)/members").Content |
ConvertFrom-Json).value |
Output
This message occurs when you have both the Az and AzureRM PowerShell modules
installed on the same
Windows-based system and they exist in the
$env:PSModulePath
for the
same version of PowerShell.
) Important
U Caution
txt
As a workaround for this issue, you can disable storing credentials between sessions by
running the
following command. After making this change however, you need to run
Connect-AzAccount each time
you start a new PowerShell session.
Azure PowerShell
Disable-AzContextAutosave
Due to the Azure Active Directory breaking change requiring AppId Uri in single tenant
applications
to require use of default scheme or verified
domains
you must upgrade the
Az.Resources module
to version 4.1.0 or later to continue using New-
AzADServicePrincipal or New-AzADApplication cmdlets.
Timeline
The requirement went into effect October 15, 2021.
Impacted versions
The following versions of Azure PowerShell are affected by the AzureAD breaking
change:
If you are still encountering issues after upgrading, feel free to open an
issue .
Workaround
If you can't upgrade to the PowerShell modules described previously, you may follow
those steps when
creating a service principal:
If needed, add your custom domain name using Azure Active Directory portal
Create an application with an accepted IdentifierUri
Create a service principal referring this application
Other issues
If you experience a product issue with Azure PowerShell not listed in this article or
require
further assistance, file an issue on GitHub .
Frequently asked questions about
Azure PowerShell
FAQ
Azure PowerShell
Azure PowerShell
One disadvantage of the previous example is you'll need to run the command for each
new PowerShell
session unless you add it to your PowerShell profile.
To set the environment variable permanently, you can also use the following example.
Azure PowerShell
[System.Environment]::SetEnvironmentVariable('SuppressAzureRmModulesRetiring
Warning', 'true', [System.EnvironmentVariableTarget]::User)
Azure PowerShell
[System.Environment]::SetEnvironmentVariable('AZURE_PS_HTTP_MAX_RETRIES ',
3, [System.EnvironmentVariableTarget]::User)
If the HTTP response status code is 429, Azure PowerShell uses the value defined in the
AZURE_PS_HTTP_MAX_RETRIES_FOR_429 environment variable. Its minimum value is 1. The
Azure PowerShell
[System.Environment]::SetEnvironmentVariable('AZURE_PS_HTTP_MAX_RETRIES_FOR_
429 ', 3, [System.EnvironmentVariableTarget]::User)