Connect-AzureRmAccount

Модуль:

AzureRM.Profile

Подключитесь к Azure с учетной записью, прошедшей проверку подлинности, для использования с запросами командлетов Azure Resource Manager.

Предупреждение

Модуль AzureRM PowerShell официально объявлен устаревшим с 29 февраля 2024 г. Пользователям рекомендуется выполнить миграцию из AzureRM в модуль Az PowerShell, чтобы обеспечить постоянную поддержку и обновления.

Хотя модуль AzureRM по-прежнему может функционировать, он больше не поддерживается или не поддерживается, размещая любое постоянное использование на усмотрение и риск пользователя. Ознакомьтесь с нашими ресурсами миграции, чтобы получить рекомендации по переходу в модуль Az.

Синтаксис

Connect-AzureRmAccount
       [-Environment <String>]
       [[-Credential] <PSCredential>]
       [-TenantId <String>]
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       [-Credential] <PSCredential>
       [-ServicePrincipal]
       -TenantId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       -CertificateThumbprint <String>
       -ApplicationId <String>
       [-ServicePrincipal]
       -TenantId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       [-TenantId <String>]
       -AccessToken <String>
       [-GraphAccessToken <String>]
       [-KeyVaultAccessToken <String>]
       -AccountId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipValidation]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-AzureRmAccount
       [-Environment <String>]
       [-TenantId <String>]
       [-AccountId <String>]
       [-Identity]
       [-ManagedServicePort <Int32>]
       [-ManagedServiceHostName <String>]
       [-ManagedServiceSecret <SecureString>]
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Описание

Командлет Connect-AzureRmAccount подключается к Azure с учетной записью, прошедшей проверку подлинности для использования с запросами командлетов Azure Resource Manager. Эту учетную запись с проверкой подлинности можно использовать только с командлетами Azure Resource Manager. Чтобы добавить проверенную учетную запись для использования с командлетами управления службами, используйте командлет Add-AzureAccount или командлет Import-AzurePublishSettingsFile. Если контекст для текущего пользователя не найден, эта команда заполняет список контекстов пользователя контекстом для каждой из подписок (первые 25). Список контекстов, созданных для пользователя, можно найти, выполнив команду Get-AzureRmContext -ListAvailable. Чтобы пропустить эту популяцию контекста, можно выполнить эту команду с параметром переключателя -SkipContextPopulation. После выполнения этого командлета можно отключиться от учетной записи Azure с помощью Disconnect-AzureRmAccount.

Примеры

Пример 1. Использование интерактивного входа для подключения к учетной записи Azure

PS C:\> Connect-AzureRmAccount

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Эта команда подключается к учетной записи Azure. Чтобы запустить командлеты Azure Resource Manager с этой учетной записью, необходимо указать учетные данные учетной записи Майкрософт или идентификатора организации по запросу. Если для учетных данных включена многофакторная проверка подлинности, необходимо войти в систему с помощью интерактивного параметра или использовать проверку подлинности субъекта-службы.

Пример 2. Подключение к учетной записи Azure с использованием учетных данных идентификатора организации

PS C:\> $Credential = Get-Credential
PS C:\> Connect-AzureRmAccount -Credential $Credential

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Первая команда будет запрашивать учетные данные пользователя (имя пользователя и пароль), а затем хранить их в переменной $Credential. Вторая команда подключается к учетной записи Azure с помощью учетных данных, хранящихся в $Credential. Эта учетная запись выполняет проверку подлинности с помощью Azure Resource Manager с помощью учетных данных идентификатора организации. Для выполнения командлетов Azure Resource Manager с помощью этой учетной записи нельзя использовать многофакторную проверку подлинности или учетные данные учетной записи Майкрософт.

Пример 3. Подключение к учетной записи субъекта-службы Azure

PS C:\> $Credential = Get-Credential

PS C:\> Connect-AzureRmAccount -Credential $Credential -Tenant "xxxx-xxxx-xxxx-xxxx" -ServicePrincipal
Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
xxxx-xxxx-xxxx-xxxx    Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Первая команда получает учетные данные субъекта-службы (идентификатор приложения и секрет субъекта-службы), а затем сохраняет их в переменной $Credential. Вторая команда подключается к Azure с использованием учетных данных субъекта-службы, хранящихся в $Credential для указанного клиента. Параметр коммутатора ServicePrincipal указывает, что учетная запись проходит проверку подлинности в качестве субъекта-службы.

Пример 4. Использование интерактивного входа для подключения к учетной записи для конкретного клиента и подписки

PS C:\> Connect-AzureRmAccount -Tenant "xxxx-xxxx-xxxx-xxxx" -SubscriptionId "yyyy-yyyy-yyyy-yyyy"
Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Эта команда подключается к учетной записи Azure и настраивает AzureRM PowerShell для выполнения командлетов для указанного клиента и подписки по умолчанию.

Пример 5. Добавление учетной записи с помощью имени входа управляемого удостоверения службы

PS C:\> Connect-AzureRmAccount -MSI

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
MSI@50342              Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Эта команда подключается с помощью управляемого удостоверения службы среды узла (например, если оно выполнено в VirtualMachine с назначенным управляемым удостоверением службы, это позволит коду войти с помощью этого назначенного удостоверения).

Пример 6. Добавление учетной записи с помощью сертификатов

# For more information on creating a self-signed certificate
# and giving it proper permissions, please see the following:
# https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-authenticate-service-principal-powershell
PS C:\> $Thumbprint = "0SZTNJ34TCCMUJ5MJZGR8XQD3S0RVHJBA33Z8ZXV"
PS C:\> $TenantId = "00001111-aaaa-2222-bbbb-3333cccc4444"
PS C:\> $ApplicationId = "00001111-aaaa-2222-bbbb-3333cccc4444"
PS C:\> Connect-AzureRmAccount -CertificateThumbprint $Thumbprint -ApplicationId $ApplicationId -Tenant $TenantId -ServicePrincipal

Account             SubscriptionName TenantId            Environment
-------             ---------------- --------            -----------
xxxx-xxxx-xxxx-xxxx Subscription1    xxxx-xxxx-xxxx-xxxx AzureCloud

Account          : 00001111-aaaa-2222-bbbb-3333cccc4444
SubscriptionName : MyTestSubscription
SubscriptionId   : 85f0f653-1f86-4d2c-a9f1-042efc00085c
TenantId         : 00001111-aaaa-2222-bbbb-3333cccc4444
Environment      : AzureCloud

Эта команда подключается к учетной записи Azure с помощью проверки подлинности субъекта-службы на основе сертификатов. Субъект-служба, используемый для проверки подлинности, должен быть создан с заданным сертификатом.

Параметры

-AccessToken

Указывает маркер доступа.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-AccountId

Идентификатор учетной записи для маркера доступа

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ApplicationId

имя участника-службы

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-CertificateThumbprint

Хэш сертификата (отпечаток)

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Confirm

Запрос подтверждения перед выполнением командлета.

Тип:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ContextName

Имя контекста по умолчанию из этого имени входа. После входа вы сможете выбрать этот контекст по этому имени.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Credential

Указывает объект PSCredential. Дополнительные сведения о объекте PSCredential введите Get-Help Get-Credential. Объект PSCredential предоставляет идентификатор пользователя и пароль для учетных данных идентификатора организации или идентификатор приложения и секрет для учетных данных субъекта-службы.

Тип:	PSCredential
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-DefaultProfile

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

Тип:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Environment

Среда, содержащая учетную запись для входа

Тип:	String
Aliases:	EnvironmentName
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Force

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-GraphAccessToken

AccessToken для службы Graph

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Identity

Войдите с помощью управляемого удостоверения службы в текущей среде.

Тип:	SwitchParameter
Aliases:	MSI, ManagedService
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-KeyVaultAccessToken

AccessToken для службы KeyVault

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ManagedServiceHostName

Имя узла для имени входа управляемой службы

Тип:	String
Position:	Named
Default value:	localhost
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ManagedServicePort

Номер порта для имени входа управляемой службы

Тип:	Int32
Position:	Named
Default value:	50342
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ManagedServiceSecret

Секрет, используемый для некоторых видов имени входа управляемой службы.

Тип:	SecureString
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Scope

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

Тип:	ContextModificationScope
Допустимые значения:	Process, CurrentUser
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ServicePrincipal

Указывает, что эта учетная запись проходит проверку подлинности, предоставляя учетные данные субъекта-службы.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SkipContextPopulation

Пропускает заполнение контекста, если контексты не найдены.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SkipValidation

Пропуск проверки для маркера доступа

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Subscription

Имя или идентификатор подписки

Тип:	String
Aliases:	SubscriptionName, SubscriptionId
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TenantId

Необязательное доменное имя или идентификатор клиента. Доменное имя не будет работать во всех ситуациях входа. Для входа поставщик облачных решений (CSP) требуется идентификатор клиента.

Тип:	String
Aliases:	Domain
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-WhatIf

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

Тип:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

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

String

Параметры: подписка (ByValue)

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

PSAzureProfile