Set-AzureRmContext
Define o locatário, a assinatura e o ambiente para os cmdlets a serem usados na sessão atual.
Aviso
O módulo PowerShell do AzureRM foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.
Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.
Sintaxe
Set-AzureRmContext
[-Context] <PSAzureContext>
[-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-Name <String>]
[-Force]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmContext
[-TenantObject] <PSAzureTenant>
[-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-Name <String>]
[-Force]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmContext
[-SubscriptionObject] <PSAzureSubscription>
[-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-Name <String>]
[-Force]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmContext
[-Tenant <String>]
[-Subscription] <String>
[-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-Name <String>]
[-Force]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmContext
-Tenant <String>
[-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-Name <String>]
[-Force]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Set-AzureRmContext define informações de autenticação para cmdlets que você executa na sessão atual. O contexto inclui informações de locatário, assinatura e ambiente.
Exemplos
Exemplo 1: Definir o contexto de assinatura
PS C:\>Set-AzureRmContext -SubscriptionId "xxxx-xxxx-xxxx-xxxx"
Name Account SubscriptionName Environment TenantId
---- ------- ---------------- ----------- --------
Work test@outlook.com Subscription1 AzureCloud xxxxxxxx-x...
Esse comando define o contexto para usar a assinatura especificada.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Context
Especifica o contexto da sessão atual.
Tipo: | PSAzureContext |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-DefaultProfile
As credenciais, o locatário e a assinatura usados para comunicação com o Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ExtendedProperty
Propriedades de contexto adicionais
Tipo: | IDictionary<TKey,TValue>[System.String,System.String] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Force
Substitua o contexto existente com o mesmo nome, se houver.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Name
Nome do contexto
Tipo: | String |
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 |
-Subscription
O nome ou a ID da assinatura para a qual o contexto deve ser definido. Esse parâmetro tem aliases para -SubscriptionName e -SubscriptionId, portanto, para maior clareza, qualquer um deles pode ser usado em vez de -Subscription ao especificar name e id, respectivamente.
Tipo: | String |
Aliases: | SubscriptionId, SubscriptionName |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-SubscriptionObject
Um objeto de assinatura
Tipo: | PSAzureSubscription |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Tenant
Nome ou ID do locatário
Tipo: | String |
Aliases: | Domain, TenantId |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-TenantObject
Um objeto de locatário
Tipo: | PSAzureTenant |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
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: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
Parâmetros: Contexto (ByValue)
Parâmetros: TenantObject (ByValue)
Parâmetros: SubscriptionObject (ByValue)