Rename-AzureRmContext

Reference

Module:: AzureRM.Profile

Rename an Azure context. By default contexts are named by user account and subscription.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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>]

Description

Rename an Azure context. By default contexts are named by user account and subscription.

Examples

Rename a context using named parameters

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

Rename the context for 'user1@contoso.org' with subscription '12345-6789-2345-3567890' to 'Work'. After this command, you will be able to target the context using 'Select-AzureRmContext Work'. Note that you can tab through the values for 'SourceName' using tab completion.

Rename a context using positional parameters

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

Rename the context named "My context" to "Work". After this command, you will be able to target the context using Select-AzureRmContext Work

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The credentials, tenant and subscription used for communication with azure

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

-Force

Rename the context even if the target context already exists

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

-InputObject

A context object, normally passed through the pipeline.

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

-PassThru

Return the renamed context.

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

-Scope

Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user

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

-SourceName

The name of the context

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

-TargetName

The new name of the context

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

PSAzureContext

Parameters: InputObject (ByValue)

Outputs