Compartilhar via


Rename-AzContext

Renomeie um contexto do Azure. Por padrão, os contextos são nomeados por conta de usuário e assinatura.

Sintaxe

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

Description

Renomeie um contexto do Azure. Por padrão, os contextos são nomeados por conta de usuário e assinatura.

Exemplos

Exemplo 1: Renomear um contexto usando parâmetros nomeados

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

Renomeie o contexto para 'user1@contoso.org' com a assinatura '12345-6789-2345-3567890' para 'Trabalho'. Após esse comando, você poderá direcionar o contexto usando 'Select-AzContext Work'. Observe que você pode percorrer os valores de 'SourceName' usando o preenchimento de tabulação.

Exemplo 2: Renomear um contexto usando parâmetros posicionais

Rename-AzContext "My context" "Work"

Renomeie o contexto chamado "Meu contexto" para "Trabalho". Após esse comando, você poderá direcionar o contexto usando Select-AzContext Work

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, o locatário e a assinatura usados para comunicação com o Azure

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

Renomeie o contexto mesmo que o contexto de destino já exista

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Um objeto de contexto, normalmente passado pelo pipeline.

Tipo:PSAzureContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

Retorne o contexto renomeado.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Scope

Determina o escopo das alterações de contexto, por exemplo, se as alterações se aplicam apenas ao processo atual ou a todas as sessões iniciadas por esse usuário

Tipo:ContextModificationScope
Valores aceitos:Process, CurrentUser
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SourceName

O nome do contexto

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-TargetName

O novo nome do contexto

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSAzureContext

Saídas

PSAzureContext