Compartilhar via


Update-AzConfig

Atualiza as configurações do Azure PowerShell.

Sintaxe

Default (Default)

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

Description

Atualiza as configurações do Azure PowerShell. Dependendo da configuração a ser atualizada, você pode especificar o escopo em que a configuração é mantida e a qual módulo ou cmdlet ele se aplica.

Observação

Não é recomendá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 alterações significativas futuras 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. Definir essa 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, ele usará como padrão todas as configurações acima; ao atualizar, ele usa como padrão "Az".

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultSubscriptionForLogin

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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 atingido, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao definir isso como true, a validação da autoridade está desabilitada. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável.

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DisplayBreakingChangeWarning

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

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DisplayRegionIdentified

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

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DisplaySurveyMessage

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

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-EnableDataCollection

Quando habilitados, os cmdlets do Azure PowerShell 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

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-EnableErrorRecordsPersistence

Quando habilitado, os registros de erro serão gravados em ~/. Azure/ErrorRecords.

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-EnableLoginByWam

[Versão prévia] Quando habilitado, o WAM (Gerenciador de Contas Web) será a experiência de logon interativa padrão. Ele retornará ao uso do navegador se a plataforma não oferecer suporte ao WAM. Observe que esse recurso está em versão prévia. No momento, não há suporte para MSA (Conta da Microsoft). Fique à vontade para entrar em contato com a equipe do Azure PowerShell se você tiver comentários: https://aka.ms/azpsissue

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-LoginExperienceV2

Somente ativo ao autenticar interativamente, permite que o usuário escolha a assinatura e o locatário usados nos comandos subsequentes. Os valores possíveis são "Ativado" (Padrão) e "Desativados". 'Ativado' requer a entrada do usuário. 'Off' usará o primeiro locatário e a assinatura retornada pelo Azure, poderá ser alterado sem aviso prévio e levar à execução de comando em um contexto indesejado (não recomendado).

Propriedades do parâmetro

Tipo:LoginExperienceConfig
Valor padrão:None
Valores aceitos:On, Off
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Scope

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

Propriedades do parâmetro

Tipo:ConfigScope
Valor padrão:None
Valores aceitos:CurrentUser, Process, Default, Environment
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Boolean

String

Saídas

PSConfig