Rename-AzContext

Módulo:
Az.Accounts Module

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

Sintaxe

RenameByInputObject (Predefinição) 

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

RenameByName 

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

Description

Renomear 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 este comando, você será capaz de direcionar o contexto usando 'Select-AzContext Work'. Observe que você pode percorrer os valores para 'SourceName' usando o preenchimento da guia.

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 o Select-AzContext Work

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultProfile

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

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Force

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Um objeto de contexto, normalmente passado pelo pipeline.

Propriedades dos parâmetros

Tipo:PSAzureContext
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

RenameByInputObject
Position:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PassThru

Retorne o contexto renomeado.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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

Propriedades dos parâmetros

Tipo:ContextModificationScope
Default value:None
Valores aceites:Process, CurrentUser
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-SourceName

O nome do contexto

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

RenameByName
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-TargetName

O novo nome do contexto

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSAzureContext

Saídas

PSAzureContext