Set-AzContext

Módulo:

Az.Accounts Module

Define o locatário, a assinatura e o ambiente para cmdlets usarem na sessão atual.

Sintaxe

Context (Predefinição)

Set-AzContext
    [-Context] <PSAzureContext>
    [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-Name <String>]
    [-Force]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

TenantObject

Set-AzContext
    [-TenantObject] <PSAzureTenant>
    [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-Name <String>]
    [-Force]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SubscriptionObject

Set-AzContext
    [-SubscriptionObject] <PSAzureSubscription>
    [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-Name <String>]
    [-Force]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Subscription

Set-AzContext
    [-Subscription] <String>
    [-Tenant <String>]
    [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
    [-Name <String>]
    [-Force]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

TenantNameOnly

Set-AzContext
    -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-AzContext define informações de autenticação para cmdlets executados na sessão atual. O contexto inclui informações sobre locatário, assinatura e ambiente.

Exemplos

Exemplo 1: Definir o contexto da subscrição

Set-AzContext -Subscription "xxxx-xxxx-xxxx-xxxx"

Name    Account             SubscriptionName    Environment         TenantId
----    -------             ----------------    -----------         --------
Work    test@outlook.com    Subscription1       AzureCloud          xxxxxxxx-x...

Este comando define o contexto para usar a assinatura especificada.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	False
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

-Context

Especifica o contexto da sessão atual.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

Context

Position:	0
Obrigatório:	True
Valor do pipeline:	True
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

-ExtendedProperty

Propriedades de contexto adicionais

Propriedades dos parâmetros

Tipo:	IDictionary<TKey,TValue>[System.String,System.String]
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

-Force

Substitua o contexto existente com o mesmo nome, se houver.

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

-Name

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

-Subscription

O nome ou id da assinatura para a qual o contexto deve ser definido. Este parâmetro tem aliases para -SubscriptionName e -SubscriptionId, portanto, para maior clareza, qualquer um deles pode ser usado em vez de -Subscription ao especificar nome e id, respectivamente.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Id de Subscrição, Nome da Subscrição

Conjuntos de parâmetros

Subscription

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

-SubscriptionObject

Um objeto de assinatura

Propriedades dos parâmetros

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

Conjuntos de parâmetros

SubscriptionObject

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

-Tenant

Nome de domínio ou ID do locatário

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Domínio, Id de Inquilino

Conjuntos de parâmetros

Subscription

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

-TenantObject

Um objeto de locatário

Propriedades dos parâmetros

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

Conjuntos de parâmetros

TenantObject

Position:	0
Obrigatório:	True
Valor do pipeline:	True
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:	False
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

PSAzureTenant

PSAzureSubscription

Saídas

PSAzureContext

Ligações Relacionadas

• Get-AzContext