Update-AzConfig
Azure PowerShell の構成を更新します。
構文
Default (既定)
Update-AzConfig
[-AppliesTo <String>]
[-Scope <ConfigScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-CheckForUpgrade <Boolean>]
[-DefaultSubscriptionForLogin <String>]
[-DisableInstanceDiscovery <Boolean>]
[-DisplayBreakingChangeWarning <Boolean>]
[-DisplayRegionIdentified <Boolean>]
[-DisplaySecretsWarning <Boolean>]
[-DisplaySurveyMessage <Boolean>]
[-EnableDataCollection <Boolean>]
[-EnableErrorRecordsPersistence <Boolean>]
[-EnableLoginByWam <Boolean>]
[<CommonParameters>]
説明
Azure PowerShell の構成を更新します。
更新する構成に応じて、構成を永続化するスコープと、それが適用されるモジュールまたはコマンドレットを指定できます。
注
複数の PowerShell プロセスで構成を更新することはお勧めしません。 1 つのプロセスで行うか、予期しない副作用を回避するために、更新プログラムがプロセス スコープ (-Scope Process) にあることを確認します。
例
例 1
Update-AzConfig -DefaultSubscriptionForLogin "Name of subscription"
Key Value Applies To Scope Help Message
--- ----- ---------- ----- ------------
DefaultSubscriptionForLogin Name of subscription Az CurrentUser Subscription name or GUID. Sets the default context for Azure PowerShell when lo…
"DefaultSubscriptionForLogin" 構成を "サブスクリプションの名前" として設定します。
Connect-AzAccountすると、指定したサブスクリプションが既定のサブスクリプションとして選択されます。
例 2
Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo "Az.KeyVault"
Key Value Applies To Scope Help Message
--- ----- ---------- ----- ------------
DisplayBreakingChangeWarning False Az.KeyVault CurrentUser Controls if warning messages for breaking changes are displayed or suppressed. When enabled,…
"DisplayBreakingChangeWarnings" 構成を "Az.KeyVault" モジュールの "$false" として設定します。 これにより、Az.KeyVault モジュールの今後の重大な変更に関するすべての警告メッセージがプロンプト表示されなくなります。
例 3
Update-AzConfig -EnableDataCollection $true
Key Value Applies To Scope Help Message
--- ----- ---------- ----- ------------
EnableDataCollection True Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experi…
"EnableDataCollection" 構成を "$true" に設定します。 これにより、テレメトリ データの送信が可能になります。
この構成の設定は、 Enable-AzDataCollection と Disable-AzDataCollectionと同じです。
例 4
Update-AzConfig -DisplaySecretsWarning $true
Key Value Applies To Scope Help Message
--- ----- ---------- ----- ------------
DisplaySecretsWarning True Az CurrentUser When enabled, a warning message for secrets redaction will be displ…
"DisplaySecretsWarning" 構成を "$true" として設定します。 これにより、コマンドレットの実行中にシークレットの検出が有効になり、出力にシークレットが見つかった場合は警告メッセージが表示されます。
パラメーター
-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 です。
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(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 の既定のコンテキストを設定します。
パラメーターのプロパティ
型: String
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-DisableInstanceDiscovery
インスタンスの検出と機関の検証の両方を無効にするには、true に設定します。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、権限を検証するために、https://login.microsoft.com/ から機関メタデータを取得する必要があります。 これを true に設定すると、権限の検証が無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-DisplayBreakingChangeWarning
重大な変更に関する警告メッセージを表示または非表示にするかどうかを制御します。 有効にすると、将来のリリースで重大な変更を含むコマンドレットを実行すると、重大な変更警告が表示されます。
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-DisplayRegionIdentified
有効にすると、Azure PowerShell によってリージョンに関する推奨事項が表示され、コストが削減される可能性があります。
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-DisplaySecretsWarning
有効にすると、コマンドレットの出力にシークレットが含まれていると、警告メッセージが表示されます。 詳細については、https://go.microsoft.com/fwlink/?linkid=2258844 を参照してください
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-DisplaySurveyMessage
有効にすると、Azure PowerShell のユーザー エクスペリエンス調査に参加するように求められる頻度が低い。
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-EnableDataCollection
有効にすると、Azure PowerShell コマンドレットによってテレメトリ データが Microsoft に送信され、カスタマー エクスペリエンスが向上します。
詳細については、プライバシーに関する声明を参照してください。 https://aka.ms/privacy
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-EnableErrorRecordsPersistence
有効にすると、エラー レコードが ~/ に書き込まれます。Azure/ErrorRecords。
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-EnableLoginByWam
[プレビュー]有効にすると、Web アカウント マネージャー (WAM) が既定の対話型ログイン エクスペリエンスになります。
プラットフォームが WAM をサポートしていない場合は、ブラウザーの使用にフォールバックします。
この機能はプレビュー段階であることに注意してください。 Microsoft アカウント (MSA) は現在サポートされていません。
フィードバックがある場合は、Azure PowerShell チームにお気軽にお問い合わせください。 https://aka.ms/azpsissue
パラメーターのプロパティ
型: Boolean
規定値: None ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-LoginExperienceV2
対話形式で認証する場合にのみアクティブになり、ユーザーは後続のコマンドで使用されるサブスクリプションとテナントを選択できます。 指定できる値は広告 'On' (既定値) と 'Off' です。 "オン" にはユーザーの入力が必要です。 'Off' は、Azure によって返された最初のテナントとサブスクリプションを使用します。予告なしに変更され、不要なコンテキストでコマンドが実行される可能性があります (推奨されません)。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: True 残りの引数からの値: False
-Scope
構成変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。
既定では CurrentUser です。
パラメーターのプロパティ
型: ConfigScope
規定値: None 指定可能な値: CurrentUser, Process, Default, Environment ワイルドカードのサポート: False DontShow: False
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: False 残りの引数からの値: False
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
型: SwitchParameter
規定値: None ワイルドカードのサポート: False DontShow: False Aliases: ウィスコンシン
パラメーター セット
(All)
配置: Named 必須: False パイプラインからの値: False プロパティ名別のパイプラインからの値: False 残りの引数からの値: False
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParameters を参照してください。
出力
