Edit

Configure Azure PowerShell global settings

  • Article

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:

Granular settings

You can apply settings that are only effective in a particular scope. The valid values for the Scope parameter are:

  • Current User. The default when applying a setting.
  • Process. Setting is only applied to the current PowerShell session.
  • 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.

Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo Az.Compute

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.

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

Note

Not to be confused with the subscription of the default context, the DefaultSubscriptionForLogin configuration takes effect only when authenticating to Azure.

Upgrade notifications

In-tool notifications for version upgrades of Azure PowerShell is a feature released in Az PowerShell module version 10.3.0. When a new version of Azure PowerShell is available, an upgrade notification is displayed in your interactive PowerShell session.

To determine if upgrade notifications are enabled, use the Get-AzConfig cmdlet with the CheckForUpgrade parameter, as shown in the following example.

Get-AzConfig -CheckForUpgrade

To enable upgrade notifications for Azure PowerShell, use the Update-AzConfig cmdlet with the CheckForUpgrade parameter and $true for its value, as shown in the following example.

Update-AzConfig -CheckForUpgrade $true

To turn off upgrade notifications, use the Update-AzConfig cmdlet with the CheckForUpgrade parameter and $false for its value, as shown in the following example.

Update-AzConfig -CheckForUpgrade $false

Azure region identification

Azure customers can choose to deploy resources in many different regions. In some cases, customers may be able to reduce costs by selecting nearby regions offering the same services. If a nearby region is identified, a message will display the region to select for future deployments.

Disabling region recommendation message

In the following example, the Update-AzConfig cmdlet is used to disable the region recommendation message:

Update-AzConfig -DisplayRegionIdentified $false

For more information about Azure regions, see choose the right Azure region for you.

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.

Export-AzConfig -Path $HOME\AzConfig.json

To import your settings, use the Import-AzConfig cmdlet and reference the previously exported JSON file.

Import-AzConfig -Path $HOME\AzConfig.json

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.

Clear-AzConfig -DefaultSubscriptionForLogin