Definir as configurações globais do Azure PowerShell

O Azure PowerShell oferece várias configurações globais, como a opção de desabilitar mensagens de aviso de alteração interruptiva. Antes da versão 9 do módulo Az PowerShell, não havia nenhum método centralizado ou detalhado para definir essas configurações globais.

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:

• Get-AzConfig
• Update-AzConfig
• Export-AzConfig
• Import-AzConfig
• Clear-AzConfig

Configurações granulares

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

• Current User: o escopo padrão ao aplicar uma configuração.
• Process: a configuração é aplicada somente à sessão atual do PowerShell.
• Default: um escopo somente leitura em que o valor padrão não foi alterado.
• Environment: um 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. Ao usar 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 que fazem parte do Azure PowerShell.

Opções de configuração

Há várias opções de configuração que você pode definir com os cmdlets *-AzConfig. Muitas dessas opções de configuração são mostradas nesta seção. Execute o comando a seguir para ver uma lista completa das opções de configuração do Azure PowerShell que você pode definir com os cmdlets *-AzConfig.

Get-AzConfig | Format-List

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 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

Assinatura padrão

Por padrão, ao iniciar com o módulo do Az PowerShell versão 12.0.0, caso tenha acesso a várias assinaturas, será solicitado que você selecione uma assinatura do Azure com a qual se conectar.

Para evitar que seja solicitado a selecionar uma assinatura sempre que você fizer logon interativamente, use o cmdlet Update-AzConfig com o parâmetro DefaultSubscriptionForLogin para definir sua assinatura padrão, 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.

Descoberta da instância

A configuração de desativação da descoberta de instância foi projetada para situações em que o ponto de extremidade de metadados está inacessível, como em nuvens privadas ou ambientes do Azure Stack. A descoberta da instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao habilitar essa configuração (definindo-a como true), você desabilitará a descoberta de instância e a validação de autoridade. Portanto, é essencial garantir que o host de autoridade configurado seja válido e confiável.

Para desabilitar a descoberta de instância e a validação de autoridade, habilite essa configuração (defina-a como true).

Update-AzConfig -DisableInstanceDiscovery $true

Mensagens de aviso de alteração interruptiva

Para desabilitar mensagens de aviso de alteração interruptivas para cmdlets em todos os módulos do Az, use o cmdlet Update-AzConfig com o parâmetro DisplayBreakingChangeWarning, conforme mostrado no exemplo a seguir:

Update-AzConfig -DisplayBreakingChangeWarning $false

Para desabilitar a mensagem de aviso de alteração interruptiva especificamente 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.

Identificação de região do Azure

Os clientes do Azure podem optar por implantar recursos em várias regiões diferentes. Às vezes, 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 exibe a região a ser escolhida para implantações futuras.

Para desabilitar as mensagens de recomendação de região, use o cmdlet Update-AzConfig com o parâmetro DisplayRegionIdentified, conforme mostrado no exemplo a seguir.

Update-AzConfig -DisplayRegionIdentified $false

Para saber mais sobre as regiões do Azure, confira Escolher a região do Azure certa para você.

Exibir aviso de segredos

O Azure PowerShell exibe uma mensagem de aviso por padrão começando com a versão 12.0.0 para ajudar você a proteger informações confidenciais quando identifica um segredo potencial na saída de um comando.

No exemplo a seguir, o cmdlet Update-AzConfig é usado para desabilitar a mensagem da aviso.

Update-AzConfig -DisplaySecretsWarning $false

Pesquisas

Ao usar o Azure PowerShell, você pode receber um convite para participar de uma pesquisa sobre sua experiência. Embora apreciemos os insights fornecidos por esses dados, entendemos que nem todos desejam receber solicitações para participar de pesquisas.

Você pode desabilitar o recebimento de solicitações para participar de pesquisas com o cmdlet Update-AzConfig, conforme mostrado no exemplo a seguir.

Update-AzConfig -DisplaySurveyMessage $false

Coleta de dados

Por padrão, os cmdlets do Azure PowerShell enviam dados de telemetria para a Microsoft para aprimorar a experiência do cliente. Para obter mais informações, confira nossa política de privacidade: aka.ms/privacy.

Update-AzConfig -EnableDataCollection $false

Registros de erro

Por padrão, os registros de erro do Azure PowerShell são gravados em $HOME/.Azure/ErrorRecords.

Para desabilitar registros de erro persistentes, use o cmdlet Update-AzConfig com o parâmetro EnableErrorRecordsPersistence, conforme mostrado no exemplo a seguir.

Update-AzConfig -EnableErrorRecordsPersistence $false

Gerenciador de Contas da Web (WAM)

Ao iniciar com o módulo do Az PowerShell versão 12.0.0, os sistemas Windows usam o WAM (Gerenciador de Contas Web) e os sistemas do Linux e macOS usam logon baseado em navegador por padrão.

Para usar o logon baseado em navegador no Windows 10 e posterior ou no Windows Server 2019 e posterior com o Az 12.0.0 e superior, desabilite o WAM para uso com o Azure PowerShell. Use o comando a seguir para desabilitar o WAM e retornar ao logon baseado em navegador, o padrão antes do Az 12.0.0.

Update-AzConfig -EnableLoginByWam $false

A nova experiência de logon

Ao iniciar com o módulo do Az PowerShell versão 12.0.0, caso tenha acesso a várias assinaturas, será solicitado que você selecione uma assinatura do Azure com a qual fazer logon.

Quando a nova experiência de logon estiver desabilitada e você tiver acesso a várias assinaturas, você será conectado à primeira assinatura retornada pelo Azure, a menos que você especifique uma assinatura com Connect-AzAccount. Por padrão, os comandos são executados para essa assinatura. Esse comportamento pode ser perigoso, por exemplo, quando a primeira assinatura retornada é um ambiente de produção.

Para desabilitar a nova experiência de logon, use o cmdlet Update-AzConfig, conforme mostrado no exemplo a seguir.

Update-AzConfig -LoginExperienceV2 Off

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