Definir configurações globais do Azure PowerShell

  • Artigo

O Azure PowerShell dá suporte a várias configurações globais, como desabilitar mensagens de aviso de alteração de quebra. Antes da versão 9 do módulo Az PowerShell, não havia uma maneira centralizada ou granular de definir configurações globais para o Azure PowerShell.

Configuração centralizada

O módulo Az PowerShell versão 9 e superior inclui cmdlets para gerenciar a configuração de configurações globais para o Azure PowerShell. Esses *-AzConfig cmdlets fazem parte do módulo Az.Accounts PowerShell:

Configurações granulares

Você pode aplicar configurações que só são efetivas em um escopo específico. Os valores válidos para o parâmetro Scope são:

  • Current User. O padrão ao aplicar uma configuração.
  • Process. A configuração só é aplicada à sessão atual do PowerShell.
  • Default. Escopo somente leitura onde o valor padrão não foi alterado.
  • Environment. Escopo somente leitura onde o valor foi configurado por meio de uma variável de ambiente.

Além dos escopos, você pode aplicar as configurações a todos os módulos do Az PowerShell ou apenas a um único módulo. Com o parâmetro AppliesTo , você pode especificar o quão amplo você deseja que a configuração seja aplicada. O valor Az indica que a configuração é aplicada a todos os módulos disponíveis que fazem parte do Azure PowerShell.

Para desabilitar a mensagem de aviso de alteração de quebra para cmdlets no módulo Az.Compute , use o Update-AzConfig cmdlet com os parâmetros DisplayBreakingChangeWarning e AppliesTo, conforme mostrado no exemplo a seguir.

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

Nesse cenário, a mensagem de aviso de alteração de quebra permanece ativa para cmdlets em todos os módulos do Az PowerShell, exceto Az.Compute.

Subscrição predefinida

Por padrão, quando você se autentica no Azure, todas as assinaturas que você pode acessar são recuperadas. A primeira assinatura retornada pelo Azure é usada, a menos que você especifique uma assinatura com Connect-AzAccount. Esse comportamento pode ser perigoso, por exemplo, se a primeira assinatura retornada for um ambiente de produção.

Para configurar sua assinatura padrão, use o Update-AzConfig cmdlet com o parâmetro DefaultSubscriptionForLogin , conforme mostrado no exemplo a seguir.

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

Nota

Não confundir com a assinatura do contexto padrão, a configuração DefaultSubscriptionForLogin entra em vigor somente ao autenticar no Azure.

Notificações de atualização

As notificações na ferramenta para atualizações de versão do Azure PowerShell são um recurso lançado no módulo Az PowerShell versão 10.3.0. Quando uma nova versão do Azure PowerShell está disponível, uma notificação de atualização é exibida em sua sessão interativa do PowerShell.

Para determinar se as notificações de atualização estão habilitadas, use o Get-AzConfig cmdlet com o parâmetro CheckForUpgrade , conforme mostrado no exemplo a seguir.

Get-AzConfig -CheckForUpgrade

Para habilitar notificações de atualização para o Azure PowerShell, use o Update-AzConfig cmdlet com o parâmetro CheckForUpgrade e $true para seu valor, conforme mostrado no exemplo a seguir.

Update-AzConfig -CheckForUpgrade $true

Para desativar as notificações de atualização, use o Update-AzConfig cmdlet com o parâmetro CheckForUpgrade e $false para seu valor, conforme mostrado no exemplo a seguir.

Update-AzConfig -CheckForUpgrade $false

Identificação da região do Azure

Os clientes do Azure podem optar por implantar recursos em muitas regiões diferentes. Em alguns casos, os clientes podem reduzir os custos selecionando regiões próximas que oferecem os mesmos serviços. Se uma região próxima for identificada, uma mensagem exibirá a região a ser selecionada para implantações futuras.

Desativando mensagem de recomendação de região

No exemplo a seguir, o Update-AzConfig cmdlet é usado para desabilitar a mensagem de recomendação de região:

Update-AzConfig -DisplayRegionIdentified $false

Para obter mais informações sobre as regiões do Azure, consulte escolher a região do Azure certa para você.

Replicando configurações

Para replicar suas configurações de um ambiente para outro, use o Export-AzConfig cmdlet para exportar as configurações para um arquivo JSON.

Export-AzConfig -Path $HOME\AzConfig.json

Para importar suas configurações, use o Import-AzConfig cmdlet e faça referência ao arquivo JSON exportado anteriormente.

Import-AzConfig -Path $HOME\AzConfig.json

Configuração de limpeza

Para redefinir a definição de configuração de uma ou mais configurações globais do Azure PowerShell para o padrão, use o Clear-AzConfig cmdlet. No exemplo a seguir, a configuração DefaultSubscriptionForLogin está desmarcada.

Clear-AzConfig -DefaultSubscriptionForLogin