Definir Azure PowerShell configurações globais

Azure PowerShell oferece várias configurações globais, como a opção de desabilitar mensagens de aviso de mudanças disruptivas. Antes da versão 9 do módulo do 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 na versão 9 e superior inclui cmdlets para gerenciar a configuração global para Azure PowerShell. Esses *-AzConfig cmdlets fazem parte do módulo do PowerShell do Az.Accounts :

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

Configurações granulares

Você pode aplicar configurações que são efetivas em 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 em que o valor padrão não foi alterado.
• Environment: um escopo somente leitura em que 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 do Az PowerShell ou apenas a um único módulo. Usando o parâmetro AppliesTo , você pode especificar a amplitude que 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 *-AzConfig cmdlets. 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 de Azure PowerShell que você pode definir com os cmdlets *-AzConfig.

Get-AzConfig | Format-List

Atualizar notificações

As notificações na ferramenta para atualizações de versão Azure PowerShell são um recurso lançado no módulo Az do 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 as notificações de atualização para Azure PowerShell, use o cmdlet Update-AzConfig 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 definindo o valor $false, conforme mostrado no exemplo a seguir.

Update-AzConfig -CheckForUpgrade $false

Assinatura padrão

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

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

A configuração para desabilitar a descoberta de instância é destinada a situações em que o ponto de extremidade de metadados está inacessível, como em nuvens privadas ou em ambientes 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), desabilite 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 mudanças críticas

Para desabilitar mensagens de alerta de mudança significativa 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 desabilitar a mensagem de aviso de mudança crítica especificamente para 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 cmdlets em todos os módulos do Az PowerShell, exceto Az.Compute.

Identificação da região do Azure

Azure clientes podem optar por implantar recursos em várias regiões diferentes. Às vezes, os clientes podem reduzir custos selecionando regiões próximas oferecendo 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 obter mais informações sobre regiões do Azure, consulte Escolha a região do Azure correta para você.

Exibir aviso de segredos

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 Update-AzConfig cmdlet é usado para desabilitar a mensagem de aviso.

Update-AzConfig -DisplaySecretsWarning $false

Pesquisas

Ao usar 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 concluir uma pesquisa.

Você pode desabilitar o aviso para participar de pesquisas com o cmdlet Update-AzConfig, conforme mostrado no exemplo a seguir.

Update-AzConfig -DisplaySurveyMessage $false

Recolha de dados

Por padrão, Azure PowerShell cmdlets enviam dados de telemetria para Microsoft para melhorar a experiência do cliente. Para obter mais informações, consulte 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 Update-AzConfig cmdlet com o parâmetro EnableErrorRecordsPersistence , conforme mostrado no exemplo a seguir.

Update-AzConfig -EnableErrorRecordsPersistence $false

Gerenciador de Contas Web (WAM)

Começando com Az módulo do PowerShell versão 12.0.0, os sistemas Windows usam o WAM (Gerenciador de Contas Web) e os sistemas Linux e macOS usam a entrada baseada em navegador por padrão.

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

Update-AzConfig -EnableLoginByWam $false

A nova experiência de logon

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

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. Os comandos são executados nessa assinatura por padrão. 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 referencie o arquivo JSON exportado anteriormente.

Import-AzConfig -Path $HOME\AzConfig.json

Configuração de limpeza

Para redefinir as configurações de um 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á desmarcada.

Clear-AzConfig -DefaultSubscriptionForLogin