Get-AzConfig

Referência

Módulo:: Az.Accounts

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

Syntax

Get-AzConfig
   [-AppliesTo <String>]
   [-Scope <ConfigScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-CheckForUpgrade]
   [-DefaultSubscriptionForLogin]
   [-DisableErrorRecordsPersistence]
   [-DisableInstanceDiscovery]
   [-DisplayBreakingChangeWarning]
   [-DisplayRegionIdentified]
   [-DisplaySurveyMessage]
   [-EnableDataCollection]
   [-EnableLoginByWam]
   [<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.

Observação

As configurações têm prioridades. De 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 mais alta do que a que se aplica a um módulo, novamente maior 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á 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:	SwitchParameter
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayRegionIdentified

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

Entradas

None

Saídas

PSConfig

Share via