Azure PowerShell のグローバル設定を構成する

Azure PowerShell には、破壊的変更の警告メッセージを無効にするオプションなど、さまざまなグローバル設定が用意されています。 Az PowerShell モジュールのバージョン 9 より前は、これらのグローバル設定を構成するための一元的または詳細な方法はありませんでした。

一元化された構成

Az PowerShell モジュール バージョン 9 以降には、Azure PowerShell のグローバル設定の構成を管理するためのコマンドレットが含まれています。 これらの *-AzConfig コマンドレットは、 Az.Accounts PowerShell モジュールの一部です。

• Get-AzConfig
• Update-AzConfig
• Export-AzConfig
• Import-AzConfig
• Clear-AzConfig

詳細な設定

特定のスコープ内で有効な設定を適用できます。 Scope パラメーターの有効な値は次のとおりです。

• Current User: 設定を適用するときの既定のスコープ。
• Process: この設定は、現在の PowerShell セッションにのみ適用されます。
• Default: 既定値が変更されていない読み取り専用スコープ。
• Environment: 環境変数を使用して値が構成される読み取り専用スコープ。

スコープに加えて、すべての Az PowerShell モジュールに設定を適用することも、1 つのモジュールにのみ適用することもできます。 AppliesTo パラメーターを使用すると、設定を適用する範囲を指定できます。 Az値は、Azure PowerShell の一部であるすべてのモジュールに設定が適用されることを示します。

構成オプション

*-AzConfig コマンドレットで設定できる構成オプションは多数あります。 このセクションでは、これらの構成オプションの多くを示します。 次のコマンドを実行して、 *-AzConfig コマンドレットで設定できる Azure PowerShell 構成オプションの完全な一覧を表示します。

Get-AzConfig | Format-List

アップグレード通知

Azure PowerShell バージョンのアップグレードに関するツール内通知は、 Az PowerShell モジュール バージョン 10.3.0 でリリースされた機能です。 新しいバージョンの Azure PowerShell が使用可能になると、対話型の PowerShell セッションにアップグレード通知が表示されます。

アップグレード通知が有効になっているかどうかを確認するには、次の例に示すように、 Get-AzConfig コマンドレットと CheckForUpgrade パラメーターを使用します。

Get-AzConfig -CheckForUpgrade

Azure PowerShell のアップグレード通知を有効にするには、次の例に示すように、 Update-AzConfig コマンドレットと CheckForUpgrade パラメーターを使用し、その値に $true します。

Update-AzConfig -CheckForUpgrade $true

アップグレード通知をオフにするには、次の例に示すように、 Update-AzConfig コマンドレットを CheckForUpgrade パラメーターと共に使用し、その値に $false します。

Update-AzConfig -CheckForUpgrade $false

既定のサブスクリプション

既定では、 Az PowerShell モジュール バージョン 12.0.0 以降では、複数のサブスクリプションにアクセスできる場合は、サインインする Azure サブスクリプションを選択するように求められます。

対話形式でサインインするたびにサブスクリプションを選択するように求められるのを防ぐには、次の例に示すように、Update-AzConfig パラメーターを指定して コマンドレットを使用して、既定のサブスクリプションを設定します。

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

インスタンスの検出

インスタンス検出の無効化設定は、プライベート クラウドや Azure Stack 環境など、メタデータ エンドポイントにアクセスできない状況向けに設計されています。 インスタンス検出では、権限を検証するために、 https://login.microsoft.com/ から機関メタデータを取得する必要があります。 この設定 ( trueに設定) を有効にすると、インスタンスの検出と機関の検証の両方が無効になります。 そのため、構成された機関ホストが有効で信頼できることを確認することが不可欠です。

インスタンスの検出と機関の検証の両方を無効にするには、この設定を有効にします ( trueに設定します)。

Update-AzConfig -DisableInstanceDiscovery $true

破壊的変更の警告メッセージ

すべての Az モジュールでコマンドレットの破壊的変更警告メッセージを無効にするには、次の例に示すように、Update-AzConfig パラメーターを指定して DisplayBreakingChangeWarning コマンドレットを使用します。

Update-AzConfig -DisplayBreakingChangeWarning $false

Az.Compute モジュールのコマンドレット専用の破壊的変更警告メッセージを無効にするには、次の例に示すように、Update-AzConfig パラメーターと AppliesTo パラメーターの両方で コマンドレットを使用します。

Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo Az.Compute

このシナリオでは、Az.Compute を除くすべての Az PowerShell モジュールのコマンドレットに対して、破壊的変更警告メッセージがアクティブなままです。

Azure リージョンの識別

Azure のお客様は、複数の異なるリージョンにリソースをデプロイすることを選択できます。 お客様は、同じサービスを提供する近くのリージョンを選択することで、コストを削減できる場合があります。 近くのリージョンが特定されると、今後のデプロイ用に選択するリージョンがメッセージに表示されます。

リージョンのレコメンデーション メッセージを無効にするには、次の例に示すように、Update-AzConfig パラメーターと共に コマンドレットを使用します。

Update-AzConfig -DisplayRegionIdentified $false

Azure リージョンの詳細については、「 適切な Azure リージョンを選択する」を参照してください。

シークレットの表示に関する警告

Azure PowerShell では、既定でバージョン 12.0.0 以降で警告メッセージが表示され、コマンドの出力で潜在的なシークレットを識別するときに機密情報を保護するのに役立ちます。

次の例では、 Update-AzConfig コマンドレットを使用して警告メッセージを無効にします。

Update-AzConfig -DisplaySecretsWarning $false

アンケート

Azure PowerShell を使用する場合は、アンケートに参加して、エクスペリエンスについてお知らせください。 このデータが提供する分析情報に感謝しますが、誰もがアンケートを完了するように求められるとは考えていません。

次の例に示すように、 Update-AzConfig コマンドレットを使用してアンケートへの参加を求めるメッセージを無効にすることができます。

Update-AzConfig -DisplaySurveyMessage $false

データ コレクション

既定では、Azure PowerShell コマンドレットは、カスタマー エクスペリエンスを向上させるために、テレメトリ データを Microsoft に送信します。 詳細については、プライバシーに関する声明「 aka.ms/privacy」を参照してください。

Update-AzConfig -EnableDataCollection $false

エラー レコード

既定では、Azure PowerShell エラー レコードは $HOME/.Azure/ErrorRecordsに書き込まれます。

永続的なエラー レコードを無効にするには、次の例に示すように、 Update-AzConfig コマンドレットと EnableErrorRecordsPersistence パラメーターを使用します。

Update-AzConfig -EnableErrorRecordsPersistence $false

Web アカウント マネージャー (WAM)

Az PowerShell モジュール バージョン 12.0.0 以降、Windows システムでは Web アカウント マネージャー (WAM) が使用され、Linux および macOS システムでは既定でブラウザー ベースのサインインが使用されます。

Az 12.0.0 以降で Windows 10 以降または Windows Server 2019 以降でブラウザー ベースのサインインを使用するには、Azure PowerShell で使用するために WAM を無効にする必要があります。 次のコマンドを使用して WAM を無効にし、ブラウザーベースのサインイン (Az 12.0.0 より前の既定値) に戻ります。

Update-AzConfig -EnableLoginByWam $false

新しいログイン エクスペリエンス

Az PowerShell モジュール バージョン 12.0.0 以降では、複数のサブスクリプションにアクセスできる場合は、サインインに使用する Azure サブスクリプションを選択するように求められます。

新しいログイン エクスペリエンスが無効になっており、複数のサブスクリプションにアクセスできる場合は、 Connect-AzAccountでサブスクリプションを指定しない限り、Azure から返される最初のサブスクリプションにサインインします。 既定では、このサブスクリプションに対してコマンドが実行されます。 この動作は危険な場合があります。たとえば、返される最初のサブスクリプションが運用環境である場合などです。

新しいログイン エクスペリエンスを無効にするには、次の例に示すように、 Update-AzConfig コマンドレットを使用します。

Update-AzConfig -LoginExperienceV2 Off

設定のレプリケート

環境間で設定をレプリケートするには、 Export-AzConfig コマンドレットを使用して設定を JSON ファイルにエクスポートします。

Export-AzConfig -Path $HOME\AzConfig.json

設定をインポートするには、 Import-AzConfig コマンドレットを使用し、以前にエクスポートした JSON ファイルを参照します。

Import-AzConfig -Path $HOME\AzConfig.json

構成のクリア

1 つ以上の Azure PowerShell グローバル設定の構成設定を既定値にリセットするには、 Clear-AzConfig コマンドレットを使用します。 次の例では、 DefaultSubscriptionForLogin 設定がクリアされています。

Clear-AzConfig -DefaultSubscriptionForLogin