Get-AzConfig

Referência

Módulo:: Az.Accounts

Obtém as configurações do Azure PowerShell.

Sintaxe

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

Description

Obtém as configurações do Azure PowerShell. Por padrão, ele lista todas as configurações. Você pode filtrar o resultado usando vários parâmetros.

Nota

As configurações têm prioridades. De um modo geral, o escopo do processo tem prioridade maior do que o escopo do usuário atual; uma configuração que se aplica a um determinado cmdlet tem prioridade maior do que a que se aplica a um módulo, novamente maior do que Az. Para reduzir a confusão, o resultado de Get-AzConfig mostra as configurações que estão entrando em vigor. É uma combinação de todas as configurações, mas não literalmente todas as configurações. No entanto, você sempre pode visualizá-los aplicando parâmetros de filtro diferentes, como -Scope.

Exemplos

Exemplo 1

Get-AzConfig

Key                           Value Applies To Scope       Help Message
---                           ----- ---------- -----       ------------
EnableDataCollection          False Az         CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the custom…
DefaultSubscriptionForLogin         Az         Default     Subscription name or GUID. Sets the default context for Azure PowerShell when logging in with…
DisplayBreakingChangeWarning  True  Az         Default     Controls if warning messages for breaking changes are displayed or suppressed. When enabled, …

Obtém todas as configurações.

Exemplo 2

Get-AzConfig -EnableDataCollection

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

Obtém 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".

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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 predefinido é true.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultProfile

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

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultSubscriptionForLogin

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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DisplayRegionIdentified

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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DisplaySurveyMessage

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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-EnableErrorRecordsPersistence

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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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).

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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.

Tipo:	ConfigScope
Valores aceites:	CurrentUser, Process, Default, Environment
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

None

Saídas

PSConfig

Partilhar via