Get-AzureRmContext
Azure Resource Manager 要求の認証に使用されるメタデータを取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Get-AzureRmContext
[-DefaultProfile <IAzureContextContainer>]
[[-Name] <String>]
[<CommonParameters>]
Get-AzureRmContext
[-ListAvailable]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzureRmContext コマンドレットは、Azure Resource Manager 要求の認証に使用される現在のメタデータを取得します。 このコマンドレットは、Active Directory アカウント、Active Directory テナント、Azure サブスクリプション、および対象となる Azure 環境を取得します。 Azure Resource Manager コマンドレットは、Azure Resource Manager 要求を行うときに既定でこれらの設定を使用します。
例
例 1: 現在のコンテキストの取得
PS C:\> Connect-AzureRmAccount
PS C:\> Get-AzureRmContext
Name Account SubscriptionName Environment TenantId
---- ------- ---------------- ----------- --------
Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription1 AzureCloud xxxxxxxx-x...
この例では、Connect-AzureRmAccount を使用して Azure サブスクリプションを使用してアカウントにログインし、Get-AzureRmContext を呼び出して現在のセッションのコンテキストを取得します。
例 2: 使用可能なすべてのコンテキストを一覧表示する
PS C:\> Get-AzureRmContext -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-AzureRmContext を使用して、これらのコンテキストのいずれかを選択できます。
パラメーター
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
Type: | IAzureContextContainer |
Aliases: | 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 |
Accepted values: | Default |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
None