Update-AzConfig
Azure PowerShell の構成を更新します。
構文
Update-AzConfig
[-AppliesTo <String>]
[-Scope <ConfigScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-CheckForUpgrade <Boolean>]
[-DefaultSubscriptionForLogin <String>]
[-DisableErrorRecordsPersistence <Boolean>]
[-DisableInstanceDiscovery <Boolean>]
[-DisplayBreakingChangeWarning <Boolean>]
[-DisplayRegionIdentified <Boolean>]
[-DisplaySurveyMessage <Boolean>]
[-EnableDataCollection <Boolean>]
[-EnableLoginByWam <Boolean>]
[<CommonParameters>] 説明
Azure PowerShell の構成を更新します。 更新する構成に応じて、構成を永続化するスコープと、それが適用されるモジュールまたはコマンドレットを指定できます。
Note
複数の 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" に設定します。 これにより、テレメトリ データの送信が可能になります。
この構成の設定は、次とDisable-AzDataCollection同じですEnable-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" です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CheckForUpgrade
有効にすると、Azure PowerShell によって更新プログラムが自動的にチェックされ、更新プログラムが利用可能になったときにヒント メッセージが表示されます。 既定値は true です。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| 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: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisableErrorRecordsPersistence
無効にすると、エラー レコードは ~/ に書き込まれません。Azure/ErrorRecords。 この構成は、2023 年 11 月頃に Az の次のメジャー リリースでオプトインとして "EnableErrorRecordsPersistence" に置き換えられます。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisableInstanceDiscovery
インスタンスの検出と機関の検証の両方を無効にするには、true に設定します。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオで使用することを目的としています。 インスタンス検出のプロセスでは、機関のメタデータ https://login.microsoft.com/ を取得して機関を検証する必要があります。 これを true に設定すると、権限の検証が無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisplayBreakingChangeWarning
重大な変更に関する警告メッセージを表示または非表示にするかどうかを制御します。 有効にすると、将来のリリースで重大な変更を含むコマンドレットを実行すると、重大な変更警告が表示されます。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisplayRegionIdentified
有効にすると、Azure PowerShell によってリージョンに関する推奨事項が表示され、コストが削減される可能性があります。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisplaySecretsWarning
有効にすると、コマンドレットの出力にシークレットが含まれていると、警告メッセージが表示されます。 詳細については、https://go.microsoft.com/fwlink/?linkid=2258844 を参照してください
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisplaySurveyMessage
有効にすると、Azure PowerShell のユーザー エクスペリエンス調査に参加するように求められる頻度が低い。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableDataCollection
有効にすると、Azure PowerShell コマンドレットによってテレメトリ データが Microsoft に送信され、カスタマー エクスペリエンスが向上します。 詳細については、プライバシーに関する声明を参照してください。 https://aka.ms/privacy
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableLoginByWam
[プレビュー]有効にすると、Web アカウント マネージャー (WAM) が既定の対話型ログイン エクスペリエンスになります。 プラットフォームが WAM をサポートしていない場合は、ブラウザーの使用にフォールバックします。 この機能はプレビュー段階であることに注意してください。 Microsoft アカウント (MSA) は現在サポートされていません。 フィードバックがある場合は、Azure PowerShell チームにお気軽にお問い合わせください。 https://aka.ms/azpsissue
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |