Get-AzConfig

  • リファレンス
モジュール:
Az.Accounts

Azure PowerShell の構成を取得します。

構文

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

説明

Azure PowerShell の構成を取得します。 既定では、すべての構成が一覧表示されます。 さまざまなパラメーターを使用して結果をフィルター処理できます。

Note

構成には優先順位があります。 一般に、プロセス スコープの優先度は CurrentUser スコープよりも高くなります。特定のコマンドレットに適用される構成は、モジュールに適用される構成よりも優先度が高く、Az よりももう一度高くなります。 混乱を減らすために、その結果 Get-AzConfig 、有効になっている構成が表示されます。 これはすべての構成の組み合わせですが、文字通りすべての構成ではありません。 ただし、次のような -Scopeさまざまなフィルター パラメーターを適用することで、常に表示できます。

例

例 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, …

すべての構成を取得します。

例 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…

"EnableDataCollection" 構成を取得します。

パラメーター

-AppliesTo

構成が適用される Azure PowerShell の部分を指定します。 次のいずれかの値になります。

  • "Az": この構成は、Azure PowerShell のすべてのモジュールとコマンドレットに適用されます。
  • モジュール名: 構成は、Azure PowerShell の特定のモジュールに適用されます。 たとえば、"Az.Storage" などです。
  • コマンドレット名: 構成は、Azure PowerShell の特定のコマンドレットに適用されます。 たとえば、"Get-AzKeyVault" などです。 指定しない場合は、構成を取得またはクリアするときに、既定で上記のすべてに設定されます。更新時の既定値は "Az" です。
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CheckForUpgrade

有効にすると、Azure PowerShell によって更新プログラムが自動的にチェックされ、更新プログラムが利用可能になったときにヒント メッセージが表示されます。 既定値は true です。

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

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

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

-DefaultSubscriptionForLogin

サブスクリプション名または GUID。 サブスクリプションを指定せずにログインしたときに Azure PowerShell の既定のコンテキストを設定します。

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

-DisableErrorRecordsPersistence

無効にすると、エラー レコードは ~/ に書き込まれません。Azure/ErrorRecords。 この構成は、2023 年 11 月頃に Az の次のメジャー リリースでオプトインとして "EnableErrorRecordsPersistence" に置き換えられます。

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

-DisableInstanceDiscovery

インスタンスの検出と機関の検証の両方を無効にするには、true に設定します。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、機関のメタデータ https://login.microsoft.com/ を取得して機関を検証する必要があります。 これを true に設定すると、権限の検証が無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。

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

-DisplayBreakingChangeWarning

重大な変更に関する警告メッセージを表示または非表示にするかどうかを制御します。 有効にすると、将来のリリースで重大な変更を含むコマンドレットを実行すると、重大な変更警告が表示されます。

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

-DisplayRegionIdentified

有効にすると、Azure PowerShell によってリージョンに関する推奨事項が表示され、コストが削減される可能性があります。

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

-DisplaySecretsWarning

有効にすると、コマンドレットの出力にシークレットが含まれていると、警告メッセージが表示されます。 詳細については、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

有効にすると、Azure PowerShell のユーザー エクスペリエンス調査に参加するように求められる頻度が低い。

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

-EnableDataCollection

有効にすると、Azure PowerShell コマンドレットによってテレメトリ データが Microsoft に送信され、カスタマー エクスペリエンスが向上します。 詳細については、プライバシーに関する声明を参照してください。 https://aka.ms/privacy

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

-EnableLoginByWam

[プレビュー]有効にすると、Web アカウント マネージャー (WAM) が既定の対話型ログイン エクスペリエンスになります。 プラットフォームが WAM をサポートしていない場合は、ブラウザーの使用にフォールバックします。 この機能はプレビュー段階であることに注意してください。 Microsoft アカウント (MSA) は現在サポートされていません。 フィードバックがある場合は、Azure PowerShell チームにお気軽にお問い合わせください。 https://aka.ms/azpsissue

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

-Scope

構成変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。 既定では CurrentUser です。

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

入力

None

出力

PSConfig