Import-AzureRmContext
ファイルから Azure 認証情報を読み込みます。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Import-AzureRmContext
[-Path] <String>
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Import-AzureRmContext
[-AzureContext] <AzureRmProfile>
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Import-AzureRmContext コマンドレットは、Azure 環境とコンテキストを設定するためにファイルから認証情報を読み込みます。 現在のセッションで実行するコマンドレットは、この情報を使用して Azure Resource Manager への要求を認証します。
例
例 1: AzureRmProfile からコンテキストをインポートする
PS C:\> Import-AzureRmContext -AzureContext (Connect-AzureRmAccount)
Account SubscriptionName TenantId Environment
------- ---------------- -------- -----------
azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud
この例では、コマンドレットに渡される PSAzureProfile からコンテキストをインポートします。
例 2: JSON ファイルからのコンテキストのインポート
PS C:\> Import-AzureRmContext -Path C:\test.json
Account SubscriptionName TenantId Environment
------- ---------------- -------- -----------
azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud
この例では、コマンドレットに渡される JSON ファイルからコンテキストを選択します。 この JSON ファイルは Save-AzureRmContext から作成できます。
パラメーター
-AzureContext
このコマンドレットが読み取る Azure コンテキストを指定します。 コンテキストを指定しない場合、このコマンドレットはローカルの既定のコンテキストから読み取ります。
Type: | AzureRmProfile |
Aliases: | Profile |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、テナント、およびサブスクリプション
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Save-AzureRMContext を使用して保存されたコンテキスト情報へのパスを指定します。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Scope
コンテキスト変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。
Type: | ContextModificationScope |
Accepted values: | Process, CurrentUser |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |