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


Connect-IPPSSession

Этот командлет доступен только в модуле PowerShell Exchange Online. Дополнительные сведения см. в разделе Сведения о модуле PowerShell Exchange Online.

Используйте командлет Connect-IPPSSession в модуле Exchange Online PowerShell, чтобы подключиться к PowerShell для обеспечения соответствия безопасности & PowerShell с помощью современной проверки подлинности. Командлет работает для учетных записей с поддержкой MFA или без MFA.

Примечание. Версия модуля 3.2.0 или более поздняя поддерживает режим REST API для большинства командлетов PowerShell для соответствия безопасности & (обычная проверка подлинности в WinRM на локальном компьютере не требуется для режима REST API). Дополнительные сведения см. в разделе Предварительные требования для модуля PowerShell Exchange Online.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

Connect-IPPSSession
       [[-ConnectionUri] <String>]
       [[-AzureADAuthorizationEndpointUri] <String>]
       [[-DelegatedOrganization] <String>]
       [[-PSSessionOption] <PSSessionOption>]
       [[-Prefix] <String>]
       [[-CommandName] <String[]>]
       [[-FormatTypeName] <String[]>]
       [-AppId <String>]
       [-BypassMailboxAnchoring]
       [-Certificate <X509Certificate2>]
       [-CertificateFilePath <String>]
       [-CertificatePassword <SecureString>]
       [-CertificateThumbprint <String>]
       [-Credential <PSCredential>]
       [-Organization <String>]
       [-UserPrincipalName <String>]
       [-UseRPSSession]
       [<CommonParameters>]

Описание

Подробные инструкции по подключению, включая предварительные требования, см. в разделе Подключение к PowerShell для соответствия требованиям безопасности&.

Примеры

Пример 1

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com

В этом примере выполняется подключение к PowerShell для соответствия требованиям безопасности & с использованием указанной учетной записи и современной проверки подлинности с MFA или без нее. В версии 3.2.0 или более поздней версии модуля мы подключаемся в режиме REST API, поэтому обычная проверка подлинности в WinRM не требуется на локальном компьютере.

Пример 2

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession

В этом примере выполняется подключение к PowerShell для соответствия требованиям безопасности & с использованием указанной учетной записи и современной проверки подлинности с MFA или без нее. В версии 3.2.0 или более поздней версии модуля мы подключаемся в удаленном режиме PowerShell, поэтому на локальном компьютере требуется обычная проверка подлинности в WinRM.

Пример 3

Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"

В этом примере выполняется подключение к PowerShell соответствия требованиям безопасности & в сценарии автоматического скрипта с помощью отпечатка сертификата.

Пример 4

Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"

В этом примере выполняется подключение к PowerShell соответствия требованиям безопасности & в сценарии автоматического скрипта с помощью файла сертификата. Этот метод лучше всего подходит для сценариев, когда сертификат хранится на удаленных компьютерах и извлекается во время выполнения. Например, сертификат хранится в Key Vault Azure.

Параметры

-AppId

Параметр AppId указывает идентификатор приложения субъекта-службы, который используется для проверки подлинности на основе сертификатов (CBA). Допустимым значением является GUID идентификатора приложения (субъекта-службы). Например, 36ee4c6c-0812-40a2-b820-b22ebd02bce3.

Дополнительные сведения см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-AzureADAuthorizationEndpointUri

Параметр AzureADAuthorizationEndpointUri указывает конечную точку авторизации Azure AD, которая может выдавать маркеры доступа OAuth2. Поддерживаются следующие среды PowerShell и связанные значения:

  • PowerShell для соответствия требованиям безопасности & в Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательное значение — https://login.microsoftonline.com/common, но это также значение по умолчанию, поэтому использовать этот параметр не нужно.
  • PowerShell для обеспечения соответствия требованиям безопасности & в Office 365 управляется 21Vianet:https://login.chinacloudapi.cn/common
  • Соответствие требованиям безопасности & PowerShell в Microsoft GCC High или Microsoft DoD: https://login.microsoftonline.us/common

Если вы используете параметр UserPrincipalName, вам не нужно использовать параметр AzureADAuthorizationEndpointUri для MFA или федеративных пользователей в средах, которым он обычно требуется (UserPrincipalName или AzureADAuthorizationEndpointUri является обязательным; ОК для использования обоих вариантов).

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-BypassMailboxAnchoring

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Certificate

Параметр Certificate указывает сертификат, используемый для проверки подлинности на основе сертификата (CBA). Допустимым значением является значение объекта X509Certificate2 сертификата.

Не используйте этот параметр с параметрами CertificateFilePath или CertificateThumbprint.

Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateFilePath

Параметр CertificateFilePath указывает сертификат, используемый для CBA. Допустимым значением является полный открытый путь к файлу сертификата. Используйте параметр CertificatePassword с этим параметром.

Не используйте этот параметр с параметрами Certificate или CertificateThumbprint.

Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificatePassword

Параметр CertificatePassword указывает пароль, необходимый для открытия файла сертификата при использовании параметра CertificateFilePath для идентификации сертификата, используемого для CBA.

В качестве значения для этого параметра можно использовать следующие методы:

  • (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).
  • Перед выполнением этой команды сохраните пароль как переменную (например, $password = Read-Host "Enter password" -AsSecureString), а затем используйте переменную ($password) в качестве значения.
  • (Get-Credential).password запрос на безопасный ввод пароля при выполнении этой команды.

Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.

Примечание. Использование команды ConvertTo-SecureString для локального хранения пароля сертификата не позволяет использовать метод безопасного подключения для сценариев автоматизации. Использование команды Get-Credential для безопасного запроса пароля сертификата не подходит для сценариев автоматизации. Другими словами, на самом деле нет автоматизированного и безопасного способа подключения с помощью локального сертификата.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateThumbprint

Параметр CertificateThumbprint указывает сертификат, используемый для CBA. Допустимое значение — это значение отпечатка сертификата. Например, 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.

Не используйте этот параметр с параметрами Certificate или CertificateFilePath.

Примечание. Параметр CertificateThumbprint поддерживается только в Microsoft Windows.

Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CommandName

Параметр CommandName указывает разделенный запятыми список команд для импорта в сеанс. Используйте этот параметр для приложений или сценариев, использующих определенный набор командлетов. Уменьшение количества командлетов в сеансе помогает повысить производительность и уменьшить объем памяти приложения или скрипта.

Type:String[]
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-ConnectionUri

Параметр ConnectionUri указывает конечную точку подключения для удаленного сеанса PowerShell. Поддерживаются следующие среды PowerShell и связанные значения:

  • PowerShell для соответствия требованиям безопасности & в Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательное значение — https://ps.compliance.protection.outlook.com/powershell-liveid/, но это также значение по умолчанию, поэтому использовать этот параметр не нужно.
  • PowerShell для обеспечения соответствия требованиям безопасности & в Office 365 управляется 21Vianet:https://ps.compliance.protection.partner.outlook.cn/powershell-liveid
  • Соответствие требованиям безопасности & PowerShell в Microsoft GCC High: https://ps.compliance.protection.office365.us/powershell-liveid/
  • Соответствие требованиям безопасности & PowerShell в Microsoft DoD: https://l5.ps.compliance.protection.office365.us/powershell-liveid/
Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Credential

Параметр Credential указывает имя пользователя и пароль, используемые для подключения к Exchange Online PowerShell. Как правило, этот параметр используется в сценариях, или если требуется указывать различные учетные данные, которые предоставляют необходимые разрешения. Не используйте этот параметр для учетных записей, использующих многофакторную проверку подлинности (MFA).

Перед выполнением команды Connect-IPPSSession сохраните имя пользователя и пароль в переменной (например, $UserCredential = Get-Credential). Затем используйте имя переменной ($UserCredential) для этого параметра.

После выполнения команды Connect-IPPSSession ключ пароля в переменной очищается.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-DelegatedOrganization

Параметр DelegatedOrganization указывает организацию клиента, которой вы хотите управлять (например, contosoelectronics.onmicrosoft.com). Этот параметр работает, только если организация-клиент согласилась на делегированное управление с помощью программы CSP.

После успешной проверки подлинности командлеты в этом сеансе сопоставляются с клиентской организацией, а все операции в этом сеансе выполняются в организации клиента.

Примечания.

  • Используйте основной домен .onmicrosoft.com делегированной организации для значения этого параметра.
  • С этим параметром необходимо использовать параметр AzureADAuthorizationEndpointUri.
Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-FormatTypeName

Параметр FormatTypeName указывает формат выходных данных командлета.

Type:String[]
Position:6
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Organization

Параметр Organization указывает организацию при подключении с помощью CBA. Для значения этого параметра необходимо использовать основной домен .onmicrosoft.com организации.

Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Prefix

Параметр Prefix задает текстовое значение, добавляемое к именам командлетов PowerShell для обеспечения соответствия безопасности & при подключении. Например, Get-ComplianceCase становится Get-ContosoComplianceCase при использовании значения Contoso для этого параметра.

  • Значение префикса не может содержать пробелы или специальные символы, такие как символы подчеркивания или звездочки.
  • Нельзя использовать значение префикса EXO. Это значение зарезервировано для девяти эксклюзивных командлетов Get-EXO* , встроенных в модуль.
  • Параметр Prefix влияет только на импортированные имена командлетов соответствия безопасности & . Он не влияет на имена командлетов, встроенных в модуль (например, Disconnect-ExchangeOnline).
Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PSSessionOption

Параметр PSSessionOption указывает параметры удаленного сеанса PowerShell для использования в подключении к PowerShell соответствия требованиям безопасности & .

Сохраните выходные данные команды New-PSSessionOption в переменной (например, $PSOptions = New-PSSessionOption <Settings>) и используйте имя переменной в качестве значения для этого параметра (например, $PSOptions).

Type:PSSessionOption
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UserPrincipalName

Параметр UserPrincipalName указывает учетную запись, которую вы хотите использовать для подключения (например, navin@contoso.onmicrosoft.com). Использование этого параметра позволяет пропустить ввод имени пользователя в запросе на современные учетные данные проверки подлинности (вам будет предложено ввести пароль).

Если вы используете параметр UserPrincipalName, вам не нужно использовать параметр AzureADAuthorizationEndpointUri для MFA или федеративных пользователей в средах, которым он обычно требуется (UserPrincipalName или AzureADAuthorizationEndpointUri является обязательным; ОК для использования обоих вариантов).

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UseRPSSession

Этот параметр доступен в модуле 3.2.0 или более поздней версии.

Параметр UseRPSSession позволяет подключаться к PowerShell соответствия безопасности & , используя традиционный удаленный доступ PowerShell ко всем командлетам. Указывать значение для этого параметра необязательно.

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

Если этот параметр не используется, обычная проверка подлинности в WinRM не требуется.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online