Rename-AzContext

モジュール:

Az.Accounts

Azure コンテキストの名前を変更します。 既定では、コンテキストにはユーザー アカウントとサブスクリプションによって名前が付けられます。

構文

Rename-AzContext
      -InputObject <PSAzureContext>
      [-Force]
      [-PassThru]
      [-Scope <ContextModificationScope>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-TargetName] <String>
      [<CommonParameters>]

Rename-AzContext
      [-Force]
      [-PassThru]
      [-Scope <ContextModificationScope>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SourceName] <String>
      [-TargetName] <String>
      [<CommonParameters>]

説明

Azure コンテキストの名前を変更します。 既定では、コンテキストにはユーザー アカウントとサブスクリプションによって名前が付けられます。

例

例 1: 名前付きパラメーターを使用してコンテキストの名前を変更する

Rename-AzContext -SourceName "[user1@contoso.org; 12345-6789-2345-3567890]" -TargetName "Work"

サブスクリプション '12345-6789-2345-3567890' の "user1@contoso.org" のコンテキストの名前を 'Work' に変更します。 このコマンドの後、'Select-AzContext Work' を使用してコンテキストをターゲットにすることができます。 タブ補完を使用して、'SourceName' の値をタブで表示できることに注意してください。

例 2: 位置パラメーターを使用してコンテキストの名前を変更する

Rename-AzContext "My context" "Work"

"My context" という名前のコンテキストの名前を "Work" に変更します。 このコマンドの後、Select-AzContext Work を使用してコンテキストをターゲットにすることができます。

パラメーター

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Force

ターゲット コンテキストが既に存在する場合でもコンテキストの名前を変更する

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

通常はパイプラインを介して渡されるコンテキスト オブジェクト。

型:	PSAzureContext
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PassThru

名前が変更されたコンテキストを返します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Scope

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

型:	ContextModificationScope
指定可能な値:	Process, CurrentUser
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SourceName

コンテキストの名前

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TargetName

コンテキストの新しい名前

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSAzureContext

出力

PSAzureContext