Get-AzContext

  • リファレンス
モジュール:
Az.Accounts

Azure Resource Manager 要求の認証に使用されるメタデータを取得します。

構文

Get-AzContext
   [-DefaultProfile <IAzureContextContainer>]
   [[-Name] <String>]
   [<CommonParameters>]
Get-AzContext
   [-ListAvailable]
   [-RefreshContextFromTokenCache]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzContext コマンドレットは、Azure Resource Manager 要求の認証に使用される現在のメタデータを取得します。 このコマンドレットは、Active Directory アカウント、Active Directory テナント、Azure サブスクリプション、および対象となる Azure 環境を取得します。 Azure Resource Manager コマンドレットは、Azure Resource Manager 要求を行うときに既定でこれらの設定を使用します。 利用可能なサブスクリプションの量が既定の制限である 25 を超えると、一部のサブスクリプションが結果に Get-AzContext -ListAvailable表示されない場合があります。 より多くのコンテキストを取得するには、実行 Connect-AzAccount -MaxContextPopulation <int> してください。

例

例 1: 現在のコンテキストの取得

Connect-AzAccount
Get-AzContext

Name                                     Account             SubscriptionName    Environment         TenantId
----                                     -------             ----------------    -----------         --------
Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com    Subscription1       AzureCloud          xxxxxxxx-x...

この例では、Connect-AzAccount を使用して Azure サブスクリプションを使用してアカウントにログインし、Get-AzContext を呼び出して現在のセッションのコンテキストを取得します。

例 2: 使用可能なすべてのコンテキストを一覧表示する

Get-AzContext -ListAvailable

Name                                     Account             SubscriptionName    Environment         TenantId
----                                     -------             ----------------    -----------         --------
Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com    Subscription1       AzureCloud          xxxxxxxx-x...
Subscription2 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com    Subscription2       AzureCloud          xxxxxxxx-x...
Subscription3 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com    Subscription3       AzureCloud          xxxxxxxx-x...

この例では、現在使用可能なすべてのコンテキストが表示されます。 ユーザーは、Select-AzContext を使用してこれらのコンテキストのいずれかを選択できます。

パラメーター

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ListAvailable

現在のセッションで使用可能なすべてのコンテキストを一覧表示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

コンテキストの名前

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RefreshContextFromTokenCache

トークン キャッシュからコンテキストを更新する

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

出力

PSAzureContext