Поделиться через

Set-AzContext

Модуль:
Az.Accounts Module

Задает арендатора, подписку и среду для использования командлетов в текущем сеансе.

Синтаксис

Context (по умолчанию) 

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

Описание

Командлет Set-AzContext задает сведения о проверке подлинности для командлетов, выполняемых в текущем сеансе. Контекст включает сведения о клиенте, подписке и среде.

Примеры

Пример 1. Настройка контекста подписки

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

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

Эта команда задает контекст для использования указанной подписки.

Параметры

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметра

Тип:SwitchParameter
Default value:False
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Context

Указывает контекст текущего сеанса.

Свойства параметра

Тип:PSAzureContext
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Context
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Учетные данные, клиент и подписка, используемые для взаимодействия с Azure.

Свойства параметра

Тип:IAzureContextContainer
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExtendedProperty

Дополнительные свойства контекста

Свойства параметра

Тип:

IDictionary<TKey,TValue>[System.String,System.String]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Force

Перезапись существующего контекста с тем же именем, если таковой есть.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

Имя контекста

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Scope

Определяет область изменений контекста, например, применяются ли изменения только к текущему процессу или ко всем сеансам, запущенным этим пользователем.

Свойства параметра

Тип:ContextModificationScope
Default value:None
Допустимые значения:Process, CurrentUser
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Subscription

Имя или идентификатор подписки, в которую должен быть задан контекст. Этот параметр имеет псевдонимы -SubscriptionName и -SubscriptionId, поэтому для ясности их можно использовать вместо -Subscription при указании имени и идентификатора соответственно.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:ID подписки, Название подписки

Наборы параметров

Subscription
Position:0
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SubscriptionObject

Объект подписки

Свойства параметра

Тип:PSAzureSubscription
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SubscriptionObject
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Tenant

Доменное имя или идентификатор клиента

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:Домен, Идентификатор арендатора (TenantId)

Наборы параметров

Subscription
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-TenantObject

Объект клиента

Свойства параметра

Тип:PSAzureTenant
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

TenantObject
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметра

Тип:SwitchParameter
Default value:False
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

PSAzureContext

PSAzureTenant

PSAzureSubscription

Выходные данные

PSAzureContext