Update-AzConfig

Atualiza as configurações do Azure PowerShell.

Syntax

Update-AzConfig
      [-AppliesTo <String>]
      [-Scope <ConfigScope>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-CheckForUpgrade <Boolean>]
      [-DefaultSubscriptionForLogin <String>]
      [-DisableErrorRecordsPersistence <Boolean>]
      [-DisableInstanceDiscovery <Boolean>]
      [-DisplayBreakingChangeWarning <Boolean>]
      [-DisplayRegionIdentified <Boolean>]
      [-DisplaySurveyMessage <Boolean>]
      [-EnableDataCollection <Boolean>]
      [-EnableLoginByWam <Boolean>]
      [<CommonParameters>]

Description

Atualiza as configurações do Azure PowerShell. Dependendo de qual configuração atualizar, você pode especificar o escopo onde a configuração é persistente e a qual módulo ou cmdlet ela se aplica.

Observação

É desaconselhável atualizar configurações em vários processos do PowerShell. Faça isso em um processo ou verifique se as atualizações estão no escopo do processo (-Scope Process) para evitar efeitos colaterais inesperados.

Exemplos

Exemplo 1

Update-AzConfig -DefaultSubscriptionForLogin "Name of subscription"

Key                         Value                Applies To Scope       Help Message
---                         -----                ---------- -----       ------------
DefaultSubscriptionForLogin Name of subscription Az         CurrentUser Subscription name or GUID. Sets the default context for Azure PowerShell when lo…

Define a configuração "DefaultSubscriptionForLogin" como "Nome da assinatura". Quando Connect-AzAccount a assinatura especificada será selecionada como a assinatura padrão.

Exemplo 2

Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo "Az.KeyVault"

Key                          Value Applies To  Scope       Help Message
---                          ----- ----------  -----       ------------
DisplayBreakingChangeWarning False Az.KeyVault CurrentUser Controls if warning messages for breaking changes are displayed or suppressed. When enabled,…

Define a configuração "DisplayBreakingChangeWarnings" como "$false" para o módulo "Az.KeyVault". Isso impede que todas as mensagens de aviso para as próximas alterações de quebra no módulo Az.KeyVault sejam solicitadas.

Exemplo 3

Update-AzConfig -EnableDataCollection $true

Key                  Value Applies To Scope       Help Message
---                  ----- ---------- -----       ------------
EnableDataCollection True  Az         CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experi…

Define a configuração "EnableDataCollection" como "$true". Isso permite o envio dos dados de telemetria. A configuração dessa configuração é equivalente a Enable-AzDataCollection e Disable-AzDataCollection.

Exemplo 4

Update-AzConfig -DisplaySecretsWarning $true

Key                   Value Applies To Scope       Help Message
---                   ----- ---------- -----       ------------
DisplaySecretsWarning True  Az         CurrentUser When enabled, a warning message for secrets redaction will be displ…

Define a configuração "DisplaySecretsWarning" como "$true". Isso habilita a detecção de segredos durante a execução do cmdlet e exibe uma mensagem de aviso se algum segredo for encontrado na saída.

Parâmetros

-AppliesTo

Especifica a qual parte do Azure PowerShell a configuração se aplica. Os valores possíveis são:

  • "Az": a configuração se aplica a todos os módulos e cmdlets do Azure PowerShell.
  • Nome do módulo: a configuração se aplica a um determinado módulo do Azure PowerShell. Por exemplo, "Az.Storage".
  • Nome do cmdlet: a configuração se aplica a um determinado cmdlet do Azure PowerShell. Por exemplo, "Get-AzKeyVault". Se não for especificado, ao obter ou limpar configurações, o padrão será todos os itens acima; ao atualizar, o padrão é "Az".
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CheckForUpgrade

Quando habilitado, o Azure PowerShell verificará se há atualizações automaticamente e exibirá uma mensagem de dica quando uma atualização estiver disponível. O valor padrão é true.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultSubscriptionForLogin

Nome da assinatura ou GUID. Define o contexto padrão do Azure PowerShell ao fazer logon sem especificar uma assinatura.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisableErrorRecordsPersistence

Quando desabilitados, os registros de erro não serão gravados em ~/. Azure/ErrorRecords. Essa configuração será substituída por "EnableErrorRecordsPersistence" como opt-in na próxima versão principal do Az por volta de novembro de 2023.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisableInstanceDiscovery

Defina-o como true para desabilitar a descoberta de instância e a validação de autoridade. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de https://login.microsoft.com/ autoridade para validar a autoridade. Ao definir isso como true, a validação da autoridade é desabilitada. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayBreakingChangeWarning

Controla se as mensagens de aviso para alterações de interrupção são exibidas ou suprimidas. Quando habilitado, um aviso de alteração de interrupção é exibido ao executar cmdlets com alterações de quebra em uma versão futura.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayRegionIdentified

Quando habilitado, o Azure PowerShell exibe recomendações sobre regiões que podem reduzir seus custos.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplaySecretsWarning

Quando habilitada, uma mensagem de aviso será exibida quando a saída do cmdlet contiver segredos. Saiba mais em https://go.microsoft.com/fwlink/?linkid=2258844

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplaySurveyMessage

Quando habilitado, você é solicitado com pouca frequência a participar de pesquisas de experiência do usuário para o Azure PowerShell.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EnableDataCollection

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EnableLoginByWam

[Pré-visualização] Quando habilitado, o Gerenciador de Contas da Web (WAM) será a experiência de logon interativo padrão. Ele voltará a usar o navegador se a plataforma não suportar WAM. Observe que esse recurso está em visualização. Conta da Microsoft (MSA) não é suportada no momento. Sinta-se à vontade para entrar em contato com a equipe do PowerShell do Azure se tiver comentários: https://aka.ms/azpsissue

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scope

Determina o escopo das alterações de configuração, por exemplo, se as alterações se aplicam somente ao processo atual ou a todas as sessões iniciadas por esse usuário. Por padrão, é CurrentUser.

Type:ConfigScope
Accepted values:CurrentUser, Process, Default, Environment
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

Boolean

String

Saídas

PSConfig