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

  • [アーティクル]

Azure PowerShell では、破壊的変更の警告メッセージの無効化など、いくつかのグローバル設定がサポートされています。 Az PowerShell モジュール バージョン 9 より前は、Azure PowerShell のグローバル設定を一元的または詳細に構成する方法はありませんでした。

集中管理構成

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

詳細な設定

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

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

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

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

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

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

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

既定では、Azure に対して認証を行うと、アクセスできるすべてのサブスクリプションが取得されます。 Connect-AzAccount でサブスクリプションを指定しない限り、Azure によって返される最初のサブスクリプションが使用されます。 返される最初のサブスクリプションが運用環境である場合などには、この動作は危険な場合があります。

既定のサブスクリプションを構成するには、次の例に示すように、Update-AzConfig コマンドレットを DefaultSubscriptionForLogin パラメーターと共に使用します。

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

注意

既定のコンテキストのサブスクリプションと混同されないように、DefaultSubscriptionForLogin 構成は、Azure への認証時にのみ有効になります。

アップグレード通知

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

Azure リージョンの特定

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

リージョンの推奨メッセージを無効にする

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

Update-AzConfig -DisplayRegionIdentified $false

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

設定のレプリケート

ある環境から別の環境に設定をレプリケートするには、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