Get-AzConfig
Azure PowerShellの構成を取得します。
構文
Default (既定)
Get-AzConfig
[-AppliesTo <String>]
[-Scope <ConfigScope>]
[-DefaultProfile <IAzureContextContainer>]
[-CheckForUpgrade]
[-DefaultSubscriptionForLogin]
[-DisableInstanceDiscovery]
[-DisplayBreakingChangeWarning]
[-DisplayRegionIdentified]
[-DisplaySecretsWarning]
[-DisplaySurveyMessage]
[-EnableDataCollection]
[-EnableErrorRecordsPersistence]
[-EnableLoginByWam]
[-LoginExperienceV2]
[<CommonParameters>]
説明
Azure PowerShellの構成を取得します。
既定では、すべての構成が一覧表示されます。 さまざまなパラメーターを使用して結果をフィルター処理できます。
注
構成には優先順位があります。 一般に、プロセス スコープの優先度は 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" です。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-CheckForUpgrade
有効にすると、Azure PowerShellは更新プログラムを自動的にチェックし、更新プログラムが利用可能になったときにヒント メッセージを表示します。 既定値は、true です。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DefaultProfile
Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
型: IAzureContextContainer
規定値: None
ワイルドカードのサポート: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DefaultSubscriptionForLogin
サブスクリプション名または GUID。
サブスクリプションを指定せずにログインするときにAzure PowerShellの既定のコンテキストを設定します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DisableInstanceDiscovery
インスタンスの検出と機関の検証の両方を無効にするには、true に設定します。 この機能は、プライベート クラウドやAzure Stackなど、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、権限を検証するために、https://login.microsoft.com/ から機関メタデータを取得する必要があります。 これを true に設定すると、権限の検証が無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DisplayBreakingChangeWarning
重大な変更に関する警告メッセージを表示または非表示にするかどうかを制御します。 有効にすると、将来のリリースで重大な変更を含むコマンドレットを実行すると、重大な変更警告が表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DisplayRegionIdentified
有効にすると、Azure PowerShellはコストを削減できるリージョンに関する推奨事項を表示します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DisplaySecretsWarning
有効にすると、コマンドレットの出力にシークレットが含まれていると、警告メッセージが表示されます。 詳細については、https://go.microsoft.com/fwlink/?linkid=2258844 を参照してください
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-DisplaySurveyMessage
有効にすると、Azure PowerShellのユーザー エクスペリエンス調査に参加するように求められる頻度が低い。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-EnableDataCollection
有効にすると、Azure PowerShellコマンドレットは、カスタマー エクスペリエンスを向上させるためにテレメトリ データをMicrosoftに送信します。
詳細については、プライバシーに関する声明を参照してください。 https://aka.ms/privacy
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-EnableErrorRecordsPersistence
有効にすると、エラー レコードが ~/ に書き込まれます。Azure/ErrorRecords。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-EnableLoginByWam
[プレビュー]有効にすると、Web アカウント マネージャー (WAM) が既定の対話型ログイン エクスペリエンスになります。
プラットフォームが WAM をサポートしていない場合は、ブラウザーの使用にフォールバックします。
この機能はプレビュー段階であることに注意してください。 Microsoft アカウント (MSA) は現在サポートされていません。
https://aka.ms/azpsissue に関するフィードバックがある場合は、Azure PowerShellチームにお問い合わせください
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-LoginExperienceV2
対話形式で認証する場合にのみアクティブになり、ユーザーは後続のコマンドで使用されるサブスクリプションとテナントを選択できます。 指定できる値は広告 'On' (既定値) と 'Off' です。 "オン" にはユーザーの入力が必要です。 'Off' では、Azureによって返された最初のテナントとサブスクリプションが使用され、予告なしに変更され、不要なコンテキストでコマンドが実行される可能性があります (推奨されません)。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Scope
構成変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。
既定では CurrentUser です。
パラメーターのプロパティ
型: ConfigScope
規定値: None
指定可能な値: CurrentUser, Process, Default, Environment
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParameters を参照してください。
None
出力