Connect-Entra

Модуль:: Microsoft.Entra.Authentication Module v1.3

Подключитесь к Microsoft Entra ID с помощью учетной записи, прошедшей проверку подлинности.

Синтаксис

UserParameterSet (По умолчанию)

Connect-Entra
[[-Scopes]
    [[-Scopes] <String[]>]
    [[-ClientId] <String>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-UseDeviceCode]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

AppCertificateParameterSet

Connect-Entra
[-ClientId]
    [-ClientId] <String>
    [[-CertificateSubjectName] <String>]
    [[-CertificateThumbprint] <String>]
    [-SendCertificateChain <Boolean>]
    [-Certificate <X509Certificate2>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

IdentityParameterSet

Connect-Entra
[[-ClientId]
    [[-ClientId] <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-Identity]
    [-NoWelcome]
    [<CommonParameters>]

AppSecretCredentialParameterSet

Connect-Entra
[-ClientSecretCredential
    [-ClientSecretCredential <PSCredential>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

AccessTokenParameterSet

Connect-Entra
[-AccessToken]
    [-AccessToken] <SecureString>
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

EnvironmentVariableParameterSet

Connect-Entra
[-ContextScope
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-EnvironmentVariable]
    [-NoWelcome]
    [<CommonParameters>]

Описание

Командлет Connect-Entra подключается к Microsoft Entra ID с учетной записью, прошедшей проверку подлинности.

В зависимости от варианта использования поддерживается несколько сценариев проверки подлинности, таких как делегированные (интерактивные) и только приложения (неинтерактивные).

Connect-Entra является псевдонимом для Connect-MgGraph.

Примеры

Пример 1. Делегированный доступ. Подключение сеанса PowerShell к клиенту

Connect-Entra

В этом примере показано, как подключить текущий сеанс PowerShell к клиенту Microsoft Entra ID с помощью учетных данных.

Пример 2. Делегированный доступ. Подключение сеанса PowerShell к клиенту с необходимыми областями

Connect-Entra -Scopes 'User.Read.All', 'Group.ReadWrite.All'

Welcome to Microsoft Graph!

В этом примере показано, как пройти проверку подлинности для Microsoft Entra ID с областями.

Пример 3. Делегированный доступ: использование маркера доступа

$secureString = ConvertTo-SecureString -String $AccessToken -AsPlainText -Force
Connect-Entra -AccessToken $secureString

Welcome to Microsoft Graph!

В этом примере показано, как интерактивно пройти проверку подлинности для Microsoft Entra ID с помощью маркера доступа.

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

Пример 4. Делегированный доступ: использование потока кода устройства

Connect-Entra -UseDeviceCode

To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code A1B2CDEFGH to authenticate.

В этом примере показано, как интерактивно пройти проверку подлинности для Microsoft Entra ID с помощью потока кода устройства.

Дополнительные сведения см. в разделе "Поток кода устройства".

Пример 5. Доступ только для приложений: использование учетных данных клиента с отпечатком сертификата

$connectParams = @{
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    ApplicationId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    CertificateThumbprint = 'AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00'
}

Connect-Entra @connectParams

Welcome to Microsoft Graph!

В этом примере показано, как выполнить проверку подлинности с помощью ApplicationId и CertificateThumbprint.

Дополнительные сведения о том, как получить или создать CertificateThumbprint, см. в статье "Проверка подлинности с доступом только для приложений".

Пример 6. Доступ только для приложений: использование учетных данных клиента с именем сертификата

$params = @{
    ClientId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    CertificateName = 'YOUR_CERT_SUBJECT'
}

Connect-Entra @params

 $Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
 Connect-Entra -ClientId '<App-Id>' -TenantId '<Tenant-Id>' -Certificate $Cert

Субъект сертификата можно найти, выполнив приведенную выше команду.

Пример 7. Доступ только для приложений: использование учетных данных клиента с сертификатом

$Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
$params = @{
    ClientId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    Certificate = $Cert
}

Connect-Entra @params

Пример 8. Доступ только для приложений: использование учетных данных секрета клиента

$ClientSecretCredential = Get-Credential -Credential '00001111-aaaa-2222-bbbb-3333cccc4444'
# Enter client_secret in the password prompt.
Connect-Entra -TenantId 'aaaabbbb-0000-cccc-1111-dddd2222eeee' -ClientSecretCredential $ClientSecretCredential

Этот метод проверки подлинности идеально подходит для фонового взаимодействия.

Дополнительные сведения о том, как получить учетные данные, см. в команде Get-Credential .

Пример 9. Доступ только для приложений: использование управляемого удостоверения: назначаемое системой управляемое удостоверение

Connect-Entra -Identity

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

Пример 10. Доступ только для приложений: использование управляемого удостоверения: назначаемое пользователем управляемое удостоверение

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Использует управляемое удостоверение, созданное пользователем, в качестве автономного Azure ресурса.

Пример 11. Подключение к среде в качестве другого удостоверения

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Чтобы подключиться как другое удостоверение, отличное от CurrentUser, укажите параметр ContextScope со значением Process.

Дополнительные сведения о том, как получить текущий контекст, см. в команде Get-EntraContext .

Пример 12. Подключение к среде или облаку

Get-EntraEnvironment

Name     AzureADEndpoint                   GraphEndpoint                           Type
----     ---------------                   -------------                           ----
China    https://login.chinacloudapi.cn    https://microsoftgraph.chinacloudapi.cn Built-in
Global   https://login.microsoftonline.com https://graph.microsoft.com             Built-in
USGov    https://login.microsoftonline.us  https://graph.microsoft.us              Built-in
USGovDoD https://login.microsoftonline.us  https://dod-graph.microsoft.us          Built-in

Connect-Entra -Environment 'Global'

При использовании Connect-Entra можно выбрать целевой объект для других сред. По умолчанию Connect-Entra предназначено для глобального общедоступного облака.

Пример 13. Задает время ожидания клиента HTTP в секундах

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

В этом примере задает время ожидания клиента HTTP в секундах.

Пример 14. Скрытие приветственного сообщения

Connect-Entra -NoWelcome

В этом примере скрывается приветственное сообщение.

Пример 15. Разрешает проверку подлинности с помощью переменных среды

Connect-Entra -EnvironmentVariable

Этот пример позволяет выполнять проверку подлинности с помощью переменных среды.

Параметры

-AccessToken

Указывает маркер носителя для службы Microsoft Entra. Время ожидания маркеров доступа и их обновление необходимо обработать.

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

Тип:	SecureString
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

AccessTokenParameterSet

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

-Certificate

Сертификат X.509, предоставленный во время вызова.

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

Тип:	X509Certificate2
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

AppCertificateParameterSet

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

-CertificateSubjectName

Различающееся имя сертификата субъекта. Сертификат извлекается из хранилища сертификатов текущего пользователя.

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

Тип:	System.String
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	CertificateSubject, CertificateName

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

AppCertificateParameterSet

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

-CertificateThumbprint

Указывает отпечаток сертификата цифрового открытого ключа X.509 учетной записи пользователя, которая имеет разрешение на выполнение этого действия.

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

Тип:	System.String
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

AppCertificateParameterSet

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

-ClientId

Указывает идентификатор приложения субъекта-службы.

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

Тип:	System.String
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AppId, ApplicationId

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

UserParameterSet

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

IdentityParameterSet

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

AppCertificateParameterSet

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

-ClientSecretCredential

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

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

Тип:	PSCredential
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	SecretCredential, Credential

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

AppSecretCredentialParameterSet

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

-ClientTimeout

Задает время ожидания клиента HTTP в секундах.

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

Тип:	System.Double
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

(All)

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

-ContextScope

Определяет область контекста проверки подлинности. Этот ContextScope принимает Process текущий процесс или CurrentUser для всех сеансов, запущенных пользователем.

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

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

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

UserParameterSet

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

AppCertificateParameterSet

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

IdentityParameterSet

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

AppSecretCredentialParameterSet

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

EnvironmentVariableParameterSet

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

-Environment

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

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

Тип:	System.String
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	Имя среды, NationalCloud

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

(All)

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

-EnvironmentVariable

Разрешает проверку подлинности с помощью переменных среды, настроенных на хост-компьютере. См. https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

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

Тип:	System.Management.Automation.SwitchParameter
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

EnvironmentVariableParameterSet

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

-Identity

Вход с помощью управляемого удостоверения

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

Тип:	System.Management.Automation.SwitchParameter
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	ManagedIdentity, ManagedServiceIdentity, MSI

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

IdentityParameterSet

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

-NoWelcome

Скрывает приветственное сообщение.

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

Тип:	System.Management.Automation.SwitchParameter
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

(All)

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

-Scopes

Массив делегированных разрешений для предоставления согласия.

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

Тип:	System.String[]
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

UserParameterSet

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

-SendCertificateChain

Включите заголовок x5c в утверждения клиента при получении маркера для включения проверки подлинности на основе субъекта или издателя с помощью данного сертификата.

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

Тип:	Boolean
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

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

AppCertificateParameterSet

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

-TenantId

Указывает идентификатор клиента.

Если этот параметр не указан, учетная запись проходит проверку подлинности с помощью домашнего клиента.

Необходимо указать параметр TenantId для проверки подлинности в качестве субъекта-службы или при использовании учетная запись Майкрософт.

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

Тип:	System.String
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	Аудитория, Tenant

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

UserParameterSet

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

AppCertificateParameterSet

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

AppSecretCredentialParameterSet

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

-UseDeviceCode

Используйте проверку подлинности кода устройства вместо элемента управления браузером.

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

Тип:	System.Management.Automation.SwitchParameter
Значение по умолчанию:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	UseDeviceAuthentication, DeviceCode, DeviceAuth, Устройство

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

UserParameterSet

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

CommonParameters

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

Disconnect-Entra

Обратная связь

Были ли сведения на этой странице полезными?

Connect-Entra

Синтаксис

UserParameterSet (По умолчанию)

AppCertificateParameterSet

IdentityParameterSet

AppSecretCredentialParameterSet

AccessTokenParameterSet

EnvironmentVariableParameterSet

Описание

Примеры

Пример 1. Делегированный доступ. Подключение сеанса PowerShell к клиенту

Пример 2. Делегированный доступ. Подключение сеанса PowerShell к клиенту с необходимыми областями

Пример 3. Делегированный доступ: использование маркера доступа

Пример 4. Делегированный доступ: использование потока кода устройства

Пример 5. Доступ только для приложений: использование учетных данных клиента с отпечатком сертификата

Пример 6. Доступ только для приложений: использование учетных данных клиента с именем сертификата

Пример 7. Доступ только для приложений: использование учетных данных клиента с сертификатом

Пример 8. Доступ только для приложений: использование учетных данных секрета клиента

Пример 9. Доступ только для приложений: использование управляемого удостоверения: назначаемое системой управляемое удостоверение

Пример 10. Доступ только для приложений: использование управляемого удостоверения: назначаемое пользователем управляемое удостоверение

Пример 11. Подключение к среде в качестве другого удостоверения

Пример 12. Подключение к среде или облаку

Пример 13. Задает время ожидания клиента HTTP в секундах

Пример 14. Скрытие приветственного сообщения

Пример 15. Разрешает проверку подлинности с помощью переменных среды

Параметры

-AccessToken

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

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

-Certificate

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

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

-CertificateSubjectName

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

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

-CertificateThumbprint

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

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

-ClientId

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

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

-ClientSecretCredential

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

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

-ClientTimeout

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

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

-ContextScope

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

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

-Environment

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

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

-EnvironmentVariable

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

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

-Identity

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

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

-NoWelcome

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

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

-Scopes

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

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

-SendCertificateChain

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

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

-TenantId

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

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

-UseDeviceCode

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

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

CommonParameters

Связанные ссылки

Обратная связь