Rename-AzContext
Renomeie um contexto de Azure. Por padrão, os contextos são nomeados por conta de usuário e assinatura.
Sintaxe
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
Renomeie um contexto de 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 '' com a assinatura '12345-6789-2345-3567890' como 'Work'. Após esse comando, você poderá direcionar o contexto usando 'Select-AzContext Work'. Observe que você pode percorrer os valores de 'SourceName' usando a conclusão da guia.
Exemplo 2: renomear um contexto usando parâmetros posicionais
Rename-AzContext "My context" "Work"
Renomeie o contexto chamado "Meu contexto" como "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.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, o locatário e a assinatura usados para comunicação com o azure
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Force
Renomeie o contexto mesmo se o contexto de destino já existir
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
Um objeto de contexto, normalmente passado pelo pipeline.
Tipo: PSAzureContext
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
RenameByInputObject
Cargo: Named
Obrigatório: True
Valor do pipeline: True
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-PassThru
Retorne o contexto renomeado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Scope
Determina o escopo das alterações de contexto, por exemplo, se as alterações se aplicam somente ao processo atual ou a todas as sessões iniciadas por esse usuário
Propriedades do parâmetro
Tipo: ContextModificationScope
Valor padrão: None
Valores aceitos: Process, CurrentUser
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-SourceName
O nome do contexto
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
RenameByName
Cargo: 0
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-TargetName
O novo nome do contexto
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: 1
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: 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.
Saídas