Connect-IPPSSession

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

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

Примечание . Если ваша организация является локальной службой Exchange и у вас есть лицензии Exchange Enterprise CAL со службами для Exchange Online Protection (EOP), используйте командлет Connect-ExchangeOnline в инструкциях по подключению Exchange Online PowerShell для подключения к среде EOP PowerShell.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета 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>]
       [<CommonParameters>]

Описание

Этот командлет позволяет создать удаленный сеанс PowerShell в средах PowerShell, связанных с Exchange, кроме Exchange Online PowerShell. Например, PowerShell & безопасности или автономный Exchange Online Protection PowerShell (для организаций без Exchange Online почтовых ящиков).

Примеры

Пример 1

$UserCredential = Get-Credential
Connect-IPPSSession -Credential $UserCredential

Этот пример подключается к PowerShell & безопасности в организации Microsoft 365.

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

Вторая команда подключает текущий сеанс PowerShell с использованием учетных данных в $UserCredential, для которого не включена многофакторная проверка подлинности.

После завершения Connect-IPPSSession ключ пароля в переменной $UserCredential очищается, и вы можете запустить командлеты PowerShell для обеспечения & безопасности.

Пример 2

Connect-IPPSSession -Credential (Get-Credential) -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/

Этот пример подключается к автономной Exchange Online Protection PowerShell в организации, в Exchange Online почтовых ящиков.

Пример 3

Connect-IPPSSession -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com"

Используя модуль Exchange Online PowerShell версии 2.0.6-Preview5 или более поздней версии, в этом примере выполняется подключение к PowerShell для обеспечения соответствия требованиям & в сценарии автоматического создания скриптов с использованием открытого ключа сертификата.

Пример 4

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

С помощью модуля Exchange Online PowerShell версии 2.0.6-Preview5 или более поздней версии этот пример подключается к PowerShell для обеспечения соответствия требованиям & безопасности в сценарии автоматического создания скриптов с использованием отпечатка сертификата.

Пример 5

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

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

Параметры

-AppId

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

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

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

-AzureADAuthorizationEndpointUri

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

  • Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. Это обязательное значение 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-BypassMailboxAnchoring

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

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateFilePath

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

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

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

Type:String
Position:Named
Default value:None
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.

Type:SecureString
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CommandName

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

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

-ConnectionUri

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

  • Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. Это обязательное значение 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/
  • Exchange Online Protection PowerShell в автономных организациях EOP без Exchange Online почтовых ящиков:https://ps.protection.outlook.com/powershell-liveid/
Type:String
Position:0
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-DelegatedOrganization

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

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

-FormatTypeName

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

Type:String[]
Position:6
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PSSessionOption

Параметр PSSessionOption указывает параметры сеанса PowerShell для использования в подключении к Exchange Online. Выходные данные команды New-PSSessionOption сохраняются в переменной, например:

$Options = New-PSSessionOption <Settings>

Имя переменной используется в качестве значения для этого параметра (например, $Options).

Type:PSSessionOption
Position:3
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Префикс

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

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