Configure Azure PowerShell upgrade notifications

This article is designed to raise awareness about the new in-tool upgrade notification feature added to Azure PowerShell in Az PowerShell module version 10.3.0. This new feature notifies you when a new version of the Az PowerShell module is available.

An Azure subscription and the Az PowerShell module are required to follow along in the examples shown in this article.

Use the Get-AzConfig cmdlet with the CheckForUpgrade parameter to determine if upgrade notifications are enabled:

1Get-AzConfig -CheckForUpgrade

Upgrade notification status

Piping Get-AzConfig -CheckForUpgrade to Select-Object -Property * or Format-List -Property * returns all properties, including additional information:

1Get-AzConfig -CheckForUpgrade | Select-Object -Property *

Upgrade notification status with all properties

Use the Update-AzConfig cmdlet with the CheckForUpgrade parameter and $true for its value to enable upgrade notifications:

1Update-AzConfig -CheckForUpgrade $true

Enable upgrade notifications

Use the Update-AzConfig cmdlet with the CheckForUpgrade parameter and $false for its value to turn off upgrade notifications:

1Update-AzConfig -CheckForUpgrade $false

Disable upgrade notifications

Az version 10.3.0 also added the Set-AzConfig alias for the Update-AzConfig cmdlet.

The upgrade notification message is displayed in your interactive PowerShell session when using cmdlets from the Az PowerShell module. The following example shows the upgrade notification message that's displayed when a new version of the Az PowerShell module is available:

1(Get-AzResourceGroup).ResourceGroupName

Upgrade notification message

You can configure granular settings for the upgrade notification feature in the $HOME/.Azure/AzPSFrequencyService.json configuration file. The following example shows the default settings:

1Get-Content -Path $HOME/.Azure/AzPSFrequencyService.json | ConvertFrom-Json -AsHashtable

Granular upgrade notification settings

Summary

The Az PowerShell module is updated monthly, and it's easy to miss a new version being released. The new in-tool upgrade notification feature helps to ensure you're always using the latest version of Azure PowerShell.

References