Configurar as definições globais do Azure PowerShell

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

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

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 somente leitura onde o valor padrão não foi alterado.
• Environment: Um escopo somente leitura onde o valor é configurado através de uma variável de ambiente.

Além dos escopos, você pode aplicar configurações a todos os módulos do Az PowerShell ou apenas a um único módulo. Usando 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 definição é aplicada a todos os módulos que fazem parte de Azure PowerShell.

Opções de configuração

Há várias opções de configuração que você pode definir com os *-AzConfig cmdlets. Muitas dessas opções de configuração são mostradas nesta seção. Execute o comando seguinte para ver a lista completa das opções de configuração Azure PowerShell que 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 uma funcionalidade lançada 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 na 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 ativar notificações de atualização para Azure PowerShell, use o cmdlet Update-AzConfig com o parâmetro CheckForUpgrade e $true para o seu valor, como mostrado no exemplo seguinte.

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

Subscrição predefinida

Por defeito, a começar pela versão 12.0.0 do módulo PowerShell Az, se tiver acesso a várias assinaturas, será solicitado a que selecione uma assinatura Azure para iniciar sessão.

Para evitar que seja solicitado a selecionar uma assinatura sempre que você entrar interativamente, use o Update-AzConfig cmdlet com o parâmetro DefaultSubscriptionForLogin para definir sua assinatura padrão, conforme mostrado no exemplo a seguir.

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

Descoberta de instâncias

A configuração para desativar a descoberta de instâncias foi concebida para situações em que o endpoint de metadados é inacessível, como em clouds privadas ou em ambientes do Azure Stack. A descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para efeitos de validação da 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

Quebrando mensagens de aviso de alteração

Para desativar mensagens de aviso de alterações disruptivas para cmdlets em todos os módulos Az, use 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 de quebra especificamente para os 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ções críticas permanece ativa para cmdlets em todos os módulos Az PowerShell, exceto o Az.Compute.

Identificação da região Azure

Os clientes do Azure podem optar por implementar 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 Update-AzConfig cmdlet com o parâmetro DisplayRegionIdentified , conforme mostrado no exemplo a seguir.

Update-AzConfig -DisplayRegionIdentified $false

Para mais informações sobre Azure regiões, consulte Escolha a região Azure certa para si.

Exibir aviso de informações confidenciais

O Azure PowerShell apresenta uma mensagem de aviso por defeito a partir da versão 12.0.0 para ajudar a proteger informações sensíveis quando identifica um potencial segredo na saída de um comando.

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

Update-AzConfig -DisplaySecretsWarning $false

Sondagens

Ao usar o Azure PowerShell, pode ser convidado a participar num inquérito para nos contar a 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 ser solicitado a participar de pesquisas com o Update-AzConfig cmdlet, 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 registos de erro do Azure PowerShell são escritos em $HOME/.Azure/ErrorRecords.

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

Update-AzConfig -EnableErrorRecordsPersistence $false

Gestor de Conta Web (WAM)

A partir da versão 12.0.0 do módulo PowerShell Az, os sistemas Windows utilizam o Gestor de Conta Web (WAM), e os sistemas Linux e macOS utilizam início de sessão baseado em browser, por predefinição.

Para usar login baseado em navegador em Windows 10 e versões posteriores ou em Windows Server 2019 e posteriores com Az 12.0.0 e superiores, deve desativar o WAM para uso com 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 de Az módulo PowerShell versão 12.0.0, se tiver acesso a várias subscrições, é solicitado a selecionar uma subscrição Azure para iniciar sessão.

Quando a nova experiência de login está desativada e tens acesso a múltiplas subscrições, ficas ligado à primeira subscrição que a Azure devolve, a menos que especifiques 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 Update-AzConfig cmdlet, 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 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 configuração de uma ou mais definições globais Azure PowerShell para o padrão, use o cmdlet Clear-AzConfig. No exemplo a seguir, a configuração DefaultSubscriptionForLogin está desmarcada.

Clear-AzConfig -DefaultSubscriptionForLogin