Rename-AzureRmContext

リファレンス

モジュール:: AzureRM.Profile

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

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

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

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

説明

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

例

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

PS C:\> Rename-AzureRmContext -SourceName "[user1@contoso.org; 12345-6789-2345-3567890]" -TargetName "Work"

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

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

PS C:\> Rename-AzureRmContext "My context" "Work"

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

パラメーター

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
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

-Force

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

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

-InputObject

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

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

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

-SourceName

コンテキストの名前

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

-TargetName

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

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

-WhatIf

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

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

入力

PSAzureContext

Parameters: InputObject (ByValue)

出力