Definir as 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ções interruptivas. Antes do módulo Az PowerShell versão 9, não havia uma maneira centralizada ou granular de definir as configurações globais do Azure PowerShell.

Configuração centralizada

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

Configurações granulares

É possível aplicar configurações que são efetivas apenas em um escopo específico. Os seguintes valores são válidos para o parâmetro Scope:

  • 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 em que o valor padrão não foi alterado.
  • Environment. Escopo somente leitura em que o valor foi configurado por meio de uma variável de ambiente.

Além dos escopos, é possível aplicar as configurações a todos os módulos do Az PowerShell ou apenas a um único. Com o parâmetro AppliesTo, é possível especificar quão amplamente você deseja aplicar a configuração. 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 interruptiva para os cmdlets no módulo Az.Compute, use o cmdlet Update-AzConfig 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 interruptiva permanece ativa para os cmdlets em todos os módulos do Az PowerShell, exceto Az.Compute.

Assinatura padrão

Por padrão, ao se autenticar no Azure, todas as assinaturas que podem ser acessadas por você 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, quando a primeira assinatura retornada é um ambiente de produção.

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

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

Observação

Para não ser confundida com a assinatura do contexto padrão, a configuração DefaultSubscriptionForLogin entra em vigor somente durante a autenticação no Azure.

Notificações de atualização

As notificações da ferramenta para atualizações de versão do Azure PowerShell são um recurso lançado no módulo do Az PowerShell versão 10.3.0. Quando uma nova versão do Azure PowerShell estiver 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 cmdlet Get-AzConfig com o parâmetro CheckForUpgrade, conforme mostrado no exemplo a seguir.

Get-AzConfig -CheckForUpgrade

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

Update-AzConfig -CheckForUpgrade $true

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

Update-AzConfig -CheckForUpgrade $false

Identificação de região do Azure

Os clientes do Azure podem optar por implantar recursos em várias 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.

Desabilitar a mensagem de recomendação de região

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

Update-AzConfig -DisplayRegionIdentified $false

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

Replicação de configurações

Para replicar suas configurações de um ambiente para outro, use o cmdlet Export-AzConfig a fim de exportá-las para um arquivo JSON.

Export-AzConfig -Path $HOME\AzConfig.json

Para importar suas configurações, use o cmdlet Import-AzConfig e referencie o arquivo JSON exportado anteriormente.

Import-AzConfig -Path $HOME\AzConfig.json

Limpeza de configuração

Para redefinir uma ou mais configurações globais do Azure PowerShell para o padrão, use o cmdlet Clear-AzConfig. No exemplo a seguir, ocorreu a limpeza da configuração DefaultSubscriptionForLogin.

Clear-AzConfig -DefaultSubscriptionForLogin