Partilhar via


Clear-AzConfig

Limpa os valores das configurações definidas pelo usuário.

Sintaxe

ClearAll (Predefinição)

Clear-AzConfig
    [-Force]
    [-PassThru]
    [-AppliesTo <String>]
    [-Scope <ConfigScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ClearByKey

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

Description

Limpa os valores das configurações definidas pelo usuário. Por padrão, todas as configurações serão limpas. Você também pode especificar chaves de configurações para limpar.

Exemplos

Exemplo 1

Clear-AzConfig -Force

Limpe todas as configurações. -Force suprime o prompt de confirmação.

Exemplo 2

Clear-AzConfig -EnableDataCollection

Desmarque a configuração "EnableDataCollection".

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á para todos os itens acima; ao atualizar, o padrão é "Az".

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultProfile

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

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultSubscriptionForLogin

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DisableInstanceDiscovery

Defina-o como true para desativar 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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DisplayBreakingChangeWarning

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DisplayRegionIdentified

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DisplaySurveyMessage

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-EnableDataCollection

Quando habilitados, 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: https://aka.ms/privacy

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-EnableErrorRecordsPersistence

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-EnableLoginByWam

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Force

Não peça confirmação ao limpar todas as configurações.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearAll
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-LoginExperienceV2

Somente ativo ao autenticar interativamente, permite que o usuário escolha a assinatura e o locatário usados nos comandos subsequentes. Valores possíveis ad 'On' (Default) e 'Off'. 'On' requer a entrada do usuário. 'Off' usará o primeiro locatário e a assinatura retornada pelo Azure, pode ser alterada sem aviso prévio e levar à execução de comandos em um contexto indesejado (não recomendado).

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ClearByKey
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PassThru

Retorna true se o cmdlet for executado corretamente.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 dos parâmetros

Tipo:ConfigScope
Default value:None
Valores aceites:CurrentUser, Process, Default, Environment
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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

None

Saídas

Boolean