Breaking changes for the AzureRM PowerShell module 6.0.0

This document serves as both a breaking change notification and migration guide for consumers of the Microsoft Azure PowerShell cmdlets. Each section describes both the impetus for the breaking change and the migration path of least resistance. For in-depth context, please refer to the pull request associated with each change.

Table of Contents

• General breaking changes
  • Minimum PowerShell version required bumped to 5.0
  • Context autosaved enabled by default
  • Removal of Tags alias
• Breaking changes to AzureRM.Compute cmdlets
• Breaking changes to AzureRM.DataLakeStore cmdlets
• Breaking changes to AzureRM.Dns cmdlets
• Breaking changes to AzureRM.Insights cmdlets
• Breaking changes to AzureRM.KeyVault cmdlets
• Breaking changes to AzureRM.Network cmdlets
• Breaking changes to AzureRM.RedisCache cmdlets
• Breaking changes to AzureRM.Resources cmdlets
• Breaking changes to AzureRM.Storage cmdlets
• Removed modules
  • AzureRM.ServerManagement
  • AzureRM.SiteRecovery

General breaking changes

Minimum PowerShell version required bumped to 5.0

Previously, Azure PowerShell required at least version 3.0 of PowerShell to run any cmdlet. Moving forward, this requirement will be raised to version 5.0 of PowerShell. For information on upgrading to PowerShell 5.0, please see this table.

Context autosave enabled by default

Context autosave is the storage of Azure sign in information that can be used between new and different PowerShell sessions. For more information on context autosave, please see this document.

Previously by default, context autosave was disabled, which meant the user's Azure authentication information was not stored between sessions until they ran the Enable-AzureRmContextAutosave cmdlet to turn on context persistence. Moving forward, context autosave will be enabled by default, which means that users with no saved context autosave settings will have their context stored the next time they sign in. Users can opt out of this functionality by using the Disable-AzureRmContextAutosave cmdlet.

Removal of Tags alias

The alias Tags for the Tag parameter has been removed across numerous cmdlets. Below is a list of modules (and the corresponding cmdlets) affected by this:

AzureRM.ApiManagement

• New-AzureRmApiManagement
• New-AzureRmApiManagementProperty
• Set-AzureRmApiManagementProperty

AzureRM.Automation

• Set-AzureRmAutomationRunbook

AzureRM.Cdn

• New-AzureRmCdnEndpoint
• New-AzureRmCdnProfile

AzureRM.Compute

• New-AzureRmVM
• Update-AzureRmVM

AzureRM.DataFactories

• New-AzureRmDataFactories

AzureRM.DataLakeAnalytics

• New-AzureRmDataLakeAnalyticsAccount

AzureRM.DataLakeStore

• New-AzureRmDataLakeStoreAccount
• Set-AzureRmDataLakeStoreAccount

AzureRM.MachineLearning

• Update-AzureRmMlCommitmentPlan

AzureRM.Media

• Set-AzureRmMediaService

AzureRM.OperationalInsights

• New-AzureRmOperationalInsightsSavedSearch
• New-AzureRmOperationalInsightsWorkspace
• Set-AzureRmOperationalInsightsSavedSearch
• Set-AzureRmOperationalInsightsWorkspace

Breaking changes to AzureRM.Compute cmdlets

Miscellaneous

• The sku name property nested in types PSDisk and PSSnapshot changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

$disk = Get-AzureRmDisk -ResourceGroupName 'MyResourceGroup' -DiskName 'MyDiskName'
$disk.Sku.Name       # This will now return Standard_LRS or Premium_LRS

$snapshot = Get-AzureRmSnapshot -ResourceGroupName 'MyResourceGroup' -SnapshotName 'MySnapshotName'
$snapshot.Sku.Name   # This will now return Standard_LRS or Premium_LRS

• The storage account type property nested in types PSVirtualMachine, PSVirtualMachineScaleSet and PSImage changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

$vm = Get-AzureRmVM -ResourceGroupName "MyResourceGroup" -Name "MyVM"
$vm.StorageProfile.DataDisks[0].ManagedDisk.StorageAccountType   # This will now return Standard_LRS or Premium_LRS

Add-AzureRmImageDataDisk

• The accepted values for parameter StorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Add-AzureRmVMDataDisk

• The accepted values for parameter StorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Add-AzureRmVmssDataDisk

• The accepted values for parameter StorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

New-AzureRmAvailabilitySet

• The parameter Managed was removed in favor of Sku

# Old
New-AzureRmAvailabilitySet -ResourceGroupName "MyRG" -Name "MyAvailabilitySet" -Location "West US" -Managed

# New
New-AzureRmAvailabilitySet -ResourceGroupName "MyRG" -Name "MyAvailabilitySet" -Location "West US" -Sku "Aligned"

New-AzureRmDiskConfig

• The accepted values for parameter SkuName changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

New-AzureRmDiskUpdateConfig

• The accepted values for parameter SkuName changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

New-AzureRmSnapshotConfig

• The accepted values for parameter SkuName changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

New-AzureRmSnapshotUpdateConfig

• The accepted values for parameter SkuName changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Set-AzureRmImageOsDisk

• The accepted values for parameter StorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Set-AzureRmVMAEMExtension

• The parameter DisableWAD was removed
  • Windows Azure Diagnostics is disabled by default

Set-AzureRmVMDataDisk

• The accepted values for parameter StorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Set-AzureRmVMOSDisk

• The accepted values for parameter StorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Set-AzureRmVmssStorageProfile

• The accepted values for parameter ManagedDisk changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Update-AzureRmVmss

• The accepted values for parameter ManagedDiskStorageAccountType changed from StandardLRS and PremiumLRS to Standard_LRS and Premium_LRS, respectively

Breaking changes to AzureRM.DataLakeStore cmdlets

Export-AzureRmDataLakeStoreItem

• Parameters PerFileThreadCount and ConcurrentFileCount were removed. Please use the Concurrency parameter moving forward

# Old
Export-AzureRmDataLakeStoreItem -Account contoso -Path /test -Destination C:\test -Recurse -Resume -PerFileThreadCount 2 -ConcurrentFileCount 80

# New
Export-AzureRmDataLakeStoreItem -Account contoso -Path /test -Destination C:\test -Recurse -Resume -Concurrency 160

Import-AzureRmDataLakeStoreItem

• Parameters PerFileThreadCount and ConcurrentFileCount were removed. Please use the Concurrency parameter moving forward

# Old
Import-AzureRmDataLakeStoreItem -Account contoso -Path C:\test -Destination /test -Recurse -Resume -ForceBinary -PerFileThreadCount 2 -ConcurrentFileCount 80

# New
Import-AzureRmDataLakeStoreItem -Account contoso -Path C:\test -Destination /test -Recurse -Resume -ForceBinary -Concurrency 160

Remove-AzureRmDataLakeStoreItem

• Parameter Clean was removed

# Old
Remove-AzureRmDataLakeStoreItem -Account "ContosoADL" -path /myFolder -Recurse -Clean

# New
Remove-AzureRmDataLakeStoreItem -Account "ContosoADL" -path /myFolder -Recurse

Breaking changes to AzureRM.Dns cmdlets

New-AzureRmDnsRecordSet

• The parameter Force was removed

Remove-AzureRmDnsRecordSet

• The parameter Force was removed

Remove-AzureRmDnsZone

• The parameter Force was removed

Breaking changes to AzureRM.Insights cmdlets

Add-AzureRmAutoscaleSetting

• The parameter aliases AutoscaleProfiles and Notifications were removed

Add-AzureRmLogProfile

• The parameter aliases Categories and Locations were removed

Add-AzureRmMetricAlertRule

• The parameter alias Actions was removed

Add-AzureRmWebtestAlertRule

• The parameter alias Actions was removed

Get-AzureRmLog

• The parameter aliases MaxRecords and MaxEvents were removed

Get-AzureRmMetricDefinition

• The parameter alias MetricNames was removed

New-AzureRmAlertRuleEmail

• The parameter aliases CustomEmails and SendToServiceOwners were removed

New-AzureRmAlertRuleWebhook

• The parameter alias Properties was removed

New-AzureRmAutoscaleNotification

• The parameter aliases CustomEmails, SendEmailToSubscriptionCoAdministrators and Webhooks were removed

New-AzureRmAutoscaleProfile

• The parameter aliases Rules, ScheduleDays, ScheduleHours and ScheduleMinutes were removed

New-AzureRmAutoscaleWebhook

• The parameter alias Properties was removed

Breaking changes to AzureRM.KeyVault cmdlets

Add-AzureKeyVaultCertificate

• The CertificatePolicy parameter has become mandatory.

Set-AzureKeyVaultManagedStorageSasDefinition

• The cmdlet no longer accepts individual parameters that compose the access token; instead, the cmdlet replaces explicit token parameters, such as Service or Permissions, with a generic TemplateUri parameter, corresponding to a sample access token defined elsewhere (presumably using Storage PowerShell cmdlets, or composed manually according to the Storage documentation.) The cmdlet retains the ValidityPeriod parameter.

For more information on composing shared access tokens for Azure Storage, please refer to the documentation pages, respectively:

• Constructing a Service SAS
• Constructing an Account SAS

# Old
$sas = Set-AzureKeyVaultManagedStorageSasDefinition -VaultName myVault -Name myKey -Service Blob -Permissions 'rcw' -ValidityPeriod 180d

# New
$sctx=New-AzureStorageContext -StorageAccountName $sa.StorageAccountName -Protocol Https -StorageAccountKey Key1
$start=[System.DateTime]::Now.AddDays(-1)
$end=[System.DateTime]::Now.AddMonths(1)
$at=New-AzureStorageAccountSasToken -Service blob -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -StartTime $start -ExpiryTime $end -Context $sctx
$sas=Set-AzureKeyVaultManagedStorageSasDefinition -AccountName $sa.StorageAccountName -VaultName $kv.VaultName -Name accountsas -TemplateUri $at -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(30))

Set-AzureKeyVaultCertificateIssuer

• The IssuerProvider parameter has become mandatory.

Undo-AzureKeyVaultCertificateRemoval

• The output of this cmdlet has changed from CertificateBundle to PSKeyVaultCertificate.

Undo-AzureRmKeyVaultRemoval

• ResourceGroupName has been removed from the InputObject parameter set, and is instead obtained from the InputObject parameter's ResourceId property.

Set-AzureRmKeyVaultAccessPolicy

• The all permission was removed from PermissionsToKeys, PermissionsToSecrets, and PermissionsToCertificates.

General

• The ValueFromPipelineByPropertyName property was removed from all cmdlets where piping by InputObject was enabled. The cmdlets affected are:

  • Add-AzureKeyVaultCertificate
  • Add-AzureKeyVaultCertificateContact
  • Add-AzureKeyVaultKey
  • Backup-AzureKeyVaultKey
  • Backup-AzureKeyVaultSecret
  • Get-AzureKeyVaultCertficate
  • Get-AzureKeyVaultCertificateContact
  • Get-AzureKeyVaultCertificateIssuer
  • Get-AzureKeyVaultCertificateOperation
  • Get-AzureKeyVaultCertificatePolicy
  • Get-AzureKeyVaultKey
  • Get-AzureKeyVaultManagedStorageAccount
  • Get-AzureKeyVaultManagedStorageSasDefinition
  • Get-AzureKeyVaultSecret
  • Remove-AzureRmKeyVault
  • Remove-AzureRmKeyVaultAccessPolicy
  • Remove-AzureKeyVaultCertificate
  • Remove-AzureKeyVaultCertificateContact
  • Remove-AzureKeyVaultCertificateIssuer
  • Remove-AzureKeyVaultCertificateOperation
  • Remove-AzureKeyVaultKey
  • Remove-AzureKeyVaultManagedStorageAccount
  • Remove-AzureKeyVaultManagedStorageSasDefinition
  • Remove-AzureKeyVaultSecret
  • Restore-AzureKeyVaultKey
  • Restore-AzureKeyVaultSecret
  • Set-AzureRmKeyVaultAccessPolicy
  • Set-AzureKeyVaultCertificateAttribute
  • Set-AzureKeyVaultCertificateIssuer
  • Set-AzureKeyVaultCertificatePolicy
  • Set-AzureKeyVaultKeyAttribute
  • Set-AzureKeyVaultManagedStorageSasDefinition
  • Set-AzureKeyVaultSecret
  • Set-AzureKeyVaultSecretAttribute
  • Stop-AzureKeyVaultCertificateOperation
  • Undo-AzureKeyVaultCertificateRemoval
  • Undo-AzureKeyVaultKeyRemoval
  • Undo-AzureRmKeyVaultRemoval
  • Undo-AzureKeyVaultSecretRemoval
  • Update-AzureKeyVaultManagedStorageAccount
  • Update-AzureKeyVaultManagedStorageAccountKey

• ConfirmImpact levels were removed from all cmdlets. The cmdlets affected are:

  • Remove-AzureRmKeyVault
  • Remove-AzureKeyVaultCertificate
  • Remove-AzureKeyVaultCertificateIssuer
  • Remove-AzureKeyVaultCertificateOperation
  • Remove-AzureKeyVaultKey
  • Remove-AzureKeyVaultManagedStorageAccount
  • Remove-AzureKeyVaultManagedStorageSasDefinition
  • Remove-AzureKeyVaultSecret
  • Stop-AzureKeyVaultCertificateOperation
  • Update-AzureKeyVaultManagedStorageAccountKey

• The IKeyVaultDataServiceClient was updated so all Certificate operations return PSTypes instead of SDK types. This includes:

  • SetCertificateContacts
  • GetCertificateContacts
  • GetCertificate
  • GetDeletedCertificate
  • MergeCertificate
  • ImportCertificate
  • DeleteCertificate
  • RecoverCertificate
  • EnrollCertificate
  • UpdateCertificate
  • GetCertificateOperation
  • DeleteCertificateOperation
  • CancelCertificateOperation
  • GetCertificatePolicy
  • UpdateCertificatePolicy
  • GetCertificateIssuer
  • SetCertificateIssuer
  • DeleteCertificateIssuer

Breaking changes to AzureRM.Network cmdlets

Add-AzureRmApplicationGatewayBackendHttpSettings

• The parameter ProbeEnabled was removed

Add-AzureRmVirtualNetworkPeering

• The parameter alias AlloowGatewayTransit was removed

New-AzureRmApplicationGatewayBackendHttpSettings

• The parameter ProbeEnabled was removed

Set-AzureRmApplicationGatewayBackendHttpSettings

• The parameter ProbeEnabled was removed

Breaking changes to AzureRM.RedisCache cmdlets

New-AzureRmRedisCache

• The parameters Subnet and VirtualNetwork were removed in favor of SubnetId
• The parameter RedisVersion was removed
• The parameter MaxMemoryPolicy was removed in favor of RedisConfiguration

# Old
New-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -Location "North Central US" -MaxMemoryPolicy "allkeys-lru"

# New
New-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -Location "North Central US" -RedisConfiguration @{"maxmemory-policy" = "allkeys-lru"}

Set-AzureRmRedisCache

• The parameter MaxMemoryPolicy was removed in favor of RedisConfiguration

# Old
Set-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -MaxMemoryPolicy "allkeys-lru"

# New
Set-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-lru"}

Breaking changes to AzureRM.Resources cmdlets

Find-AzureRmResource

• This cmdlet was removed and the functionality was moved into Get-AzureRmResource

# Old
Find-AzureRmResource -ResourceType "Microsoft.Web/sites" -ResourceGroupNameContains "ResourceGroup"
Find-AzureRmResource -ResourceType "Microsoft.Web/sites" -ResourceNameContains "test"

# New
Get-AzureRmResource -ResourceType "Microsoft.Web/sites" -ResourceGroupName "*ResourceGroup*"
Get-AzureRmResource -ResourceType "Microsoft.Web/sites" -Name "*test*"

Find-AzureRmResourceGroup

• This cmdlet was removed and the functionality was moved into Get-AzureRmResourceGroup

# Old
Find-AzureRmResourceGroup
Find-AzureRmResourceGroup -Tag @{ "testtag" = $null }
Find-AzureRmResourceGroup -Tag @{ "testtag" = "testval" }

# New
Get-AzureRmResourceGroup
Get-AzureRmResourceGroup -Tag @{ "testtag" = $null }
Get-AzureRmResourceGroup -Tag @{ "testtag" = "testval" }

Get-AzureRmRoleDefinition

• Parameter AtScopeAndBelow was removed.

# Old
Get-AzureRmRoleDefinition [other required parameters] -AtScopeAndBelow

# New
Get-AzureRmRoleDefinition [other required parameters]

Breaking changes to AzureRM.Storage cmdlets

New-AzureRmStorageAccount

• The parameter EnableEncryptionService was removed

Set-AzureRmStorageAccount

• The parameters EnableEncryptionService and DisableEncryptionService were removed

Removed modules

AzureRM.ServerManagement

The Server Management Tools service was retired last year, and as a result, the corresponding module for SMT, AzureRM.ServerManagement, was removed from AzureRM and will stop shipping moving forward.

AzureRM.SiteRecovery

The AzureRM.SiteRecovery module is being superseded by AzureRM.RecoveryServices.SiteRecovery, which is a functional superset of the AzureRM.SiteRecovery module and includes a new set of equivalent cmdlets. The full list of mappings from old to new cmdlets can be found below: