Set-AzContext

Moduł:

Az.Accounts Module

Ustawia dzierżawę, subskrypcję i środowisko dla poleceń cmdlet do użycia w bieżącej sesji.

Składnia

Context (domyślnie)

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

Opis

Polecenie cmdlet Set-AzContext ustawia informacje uwierzytelniania dla poleceń cmdlet uruchamianych w bieżącej sesji. Kontekst zawiera informacje o dzierżawie, subskrypcji i środowisku.

Przykłady

Przykład 1. Ustawianie kontekstu subskrypcji

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

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

To polecenie ustawia kontekst, aby używać określonej subskrypcji.

Parametry

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	por

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Context

Określa kontekst bieżącej sesji.

Właściwości parametru

Typ:	PSAzureContext
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

Context

Position:	0
Obowiązkowe:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-DefaultProfile

Poświadczenia, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Właściwości parametru

Typ:	IAzureContextContainer
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	AzContext, AzureRmContext, AzureCredential

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ExtendedProperty

Dodatkowe właściwości kontekstu

Właściwości parametru

Typ:	IDictionary<TKey,TValue>[System.String,System.String]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Force

Zastąp istniejący kontekst tą samą nazwą, jeśli istnieje.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Name

Nazwa kontekstu

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Scope

Określa na przykład zakres zmian kontekstu, czy zmiany mają zastosowanie tylko do bieżącego procesu, czy do wszystkich sesji uruchomionych przez tego użytkownika.

Właściwości parametru

Typ:	ContextModificationScope
Domyślna wartość:	None
Dopuszczalne wartości:	Process, CurrentUser
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Subscription

Nazwa lub identyfikator subskrypcji, na którą powinien być ustawiony kontekst. Ten parametr zawiera aliasy do -SubscriptionName i -SubscriptionId, więc w celu zapewnienia przejrzystości można użyć zamiast -Subscription podczas określania nazwy i identyfikatora, odpowiednio.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Identyfikator subskrypcji, Nazwa subskrypcji

Zestawy parametrów

Subscription

Position:	0
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-SubscriptionObject

Obiekt subskrypcji

Właściwości parametru

Typ:	PSAzureSubscription
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

SubscriptionObject

Position:	0
Obowiązkowe:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Tenant

Nazwa domeny dzierżawy lub identyfikator

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Domena, Identyfikator najemcy

Zestawy parametrów

Subscription

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-TenantObject

Obiekt dzierżawy

Właściwości parametru

Typ:	PSAzureTenant
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

TenantObject

Position:	0
Obowiązkowe:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Wi

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

PSAzureContext

PSAzureTenant

PSAzureSubscription

Dane wyjściowe

PSAzureContext

Linki powiązane

• Get-AzContext