Set-AzContext

モジュール:

Az.Accounts

現在のセッションで使用するコマンドレットのテナント、サブスクリプション、および環境を設定します。

構文

Set-AzContext
   [-Context] <PSAzureContext>
   [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
   [-Name <String>]
   [-Force]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzContext
   [-TenantObject] <PSAzureTenant>
   [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
   [-Name <String>]
   [-Force]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzContext
   [-SubscriptionObject] <PSAzureSubscription>
   [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
   [-Name <String>]
   [-Force]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzContext
   [-Tenant <String>]
   [-Subscription] <String>
   [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
   [-Name <String>]
   [-Force]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzContext
   -Tenant <String>
   [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
   [-Name <String>]
   [-Force]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzContext コマンドレットは、現在のセッションで実行するコマンドレットの認証情報を設定します。 コンテキストには、テナント、サブスクリプション、環境の情報が含まれます。

例

例 1: サブスクリプション コンテキストを設定する

Set-AzContext -Subscription "xxxx-xxxx-xxxx-xxxx"

Name    Account             SubscriptionName    Environment         TenantId
----    -------             ----------------    -----------         --------
Work    test@outlook.com    Subscription1       AzureCloud          xxxxxxxx-x...

このコマンドは、指定したサブスクリプションを使用するコンテキストを設定します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Context

現在のセッションのコンテキストを指定します。

Type:	PSAzureContext
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

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

-ExtendedProperty

その他のコンテキスト プロパティ

Type:	IDictionary<TKey,TValue>[System.String,System.String]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

既存のコンテキストを同じ名前で上書きします (存在する場合)。

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

-Name

コンテキストの名前

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

-Scope

コンテキストの変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。

Type:	ContextModificationScope
Accepted values:	Process, CurrentUser
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Subscription

コンテキストを設定する必要があるサブスクリプションの名前または ID。 このパラメーターには -SubscriptionName と -SubscriptionId のエイリアスがあるため、わかりやすくするために、それぞれ名前と ID を指定するときに、-Subscription の代わりにこれらのいずれかを使用できます。

Type:	String
Aliases:	SubscriptionId, SubscriptionName
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionObject

サブスクリプション オブジェクト

Type:	PSAzureSubscription
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Tenant

テナント ドメイン名または ID

Type:	String
Aliases:	Domain, TenantId
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-TenantObject

テナント オブジェクト

Type:	PSAzureTenant
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSAzureContext

PSAzureTenant

PSAzureSubscription

出力

PSAzureContext

関連リンク

• Get-AzContext