Partilhar via

Definir configurações globais do Azure PowerShell

  • Artigo

O Azure PowerShell oferece várias configurações globais, como a opção de desativar mensagens de aviso de alteração crítica. 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 Az PowerShell versão 9 e superior inclui cmdlets para gerenciar a configuração de configurações globais para o Azure PowerShell. Esses cmdlets *-AzConfig fazem parte do módulo Az.Accounts PowerShell:

Configurações granulares

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

  • 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 de leitura única onde o valor padrão permanece inalterado.
  • Environment: Um escopo somente leitura onde o valor é configurado por meio de uma variável de ambiente.

Além dos escopos, você pode aplicar configurações a todos os módulos Az PowerShell ou apenas a um único módulo. Usando o parâmetro AppliesTo, você pode especificar o quão amplo deseja que a configuração seja aplicada. 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 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 cmdlet Get-AzConfig 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 cmdlet Update-AzConfig com o parâmetro CheckForUpgrade e com o valor $true, conforme mostrado no exemplo a seguir.

Update-AzConfig -CheckForUpgrade $true

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

Update-AzConfig -CheckForUpgrade $false

Subscrição predefinida

Por padrão, a partir de módulo Az PowerShell versão 12.0.0, se você tiver acesso a várias assinaturas, será solicitado que você selecione uma assinatura do Azure com a qual entrar.

Para evitar ser solicitado a selecionar uma assinatura sempre que você entrar 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

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

Descoberta de instâncias

A configuração desabilitar a 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 de 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ê desabilita 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ções disruptivas

Para desativar mensagens de aviso de alterações significativas para cmdlets em todos os módulos Az, utilize o cmdlet Update-AzConfig com o parâmetro DisplayBreakingChangeWarning, conforme mostrado no exemplo a seguir:

Update-AzConfig -DisplayBreakingChangeWarning $false

Para desativar a mensagem de aviso de alteração importante 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 disruptiva permanece ativa para cmdlets em todos os módulos do Az PowerShell, exceto no Az.Compute.

Identificação da 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 exibirá 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 obter mais informações sobre as regiões do Azure, consulte 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 ajudá-lo 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 de aviso.

Update-AzConfig -DisplaySecretsWarning $false

Sondagens

Ao usar o Azure PowerShell, você pode ser convidado a participar de uma pesquisa para nos contar sobre sua experiência. Embora apreciemos os insights que esses dados fornecem, entendemos que nem todos querem ser solicitados a responder a uma pesquisa.

Você pode desabilitar a solicitação de participação em pesquisas com o cmdlet Update-AzConfig, conforme mostrado no exemplo a seguir.

Update-AzConfig -DisplaySurveyMessage $false

Recolha de dados

Por padrão, os cmdlets do Azure PowerShell enviam dados de telemetria para a Microsoft para melhorar a experiência do cliente. Para mais informações, consulte a nossa declaração de privacidade: aka.ms/privacy.

Update-AzConfig -EnableDataCollection $false

Registos de erros

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 com o parâmetro EnableErrorRecordsPersistence, conforme mostrado no exemplo a seguir.

Update-AzConfig -EnableErrorRecordsPersistence $false

Gerente de Conta Web (WAM)

A partir do módulo Az PowerShell versão 12.0.0, os sistemas Windows usam o Web Account Manager (WAM) e os sistemas Linux e macOS usam o login baseado em navegador por padrão.

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

Update-AzConfig -EnableLoginByWam $false

A nova experiência de login

A partir módulo Az PowerShell versão 12.0.0, se você tiver acesso a várias assinaturas, será solicitado que você selecione uma assinatura do Azure com a qual entrar.

Quando a nova experiência de início de sessão está desativada e tem acesso a várias subscrições, inicia sessão na primeira subscrição que o Azure apresenta, a menos que especifique uma subscrição com Connect-AzAccount. Por padrão, os comandos são executados nessa assinatura. Esse comportamento pode ser perigoso, por exemplo, se a primeira assinatura retornada for 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

Replicando configurações

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

Export-AzConfig -Path $HOME\AzConfig.json

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

Import-AzConfig -Path $HOME\AzConfig.json

Configuração de eliminação

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

Clear-AzConfig -DefaultSubscriptionForLogin