Connect-IPPSSession

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

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

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

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

Синтаксис

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

Connect-IPPSSession

    [[-ConnectionUri] <String>]
    [[-AzureADAuthorizationEndpointUri] <String>]
    [[-DelegatedOrganization] <String>]
    [[-PSSessionOption] <PSSessionOption>]
    [[-Prefix] <String>]
    [[-CommandName] <String[]>]
    [[-FormatTypeName] <String[]>]
    [-AccessToken <String>]
    [-AppId <String>]
    [-BypassMailboxAnchoring]
    [-Certificate <X509Certificate2>]
    [-CertificateFilePath <String>]
    [-CertificatePassword <SecureString>]
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    [-DisableWAM]
    [-EnableErrorReporting]
    [-EnableSearchOnlySession]
    [-EXOModuleBasePath <String>]
    [-LogDirectoryPath <String>]
    [-LogLevel <LogLevel>]
    [-Organization <String>]
    [-ShowBanner]
    [-UserPrincipalName <String>]
    [-UseRPSSession]
    [<CommonParameters>]

Описание

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

Примеры

Пример 1

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

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

Пример 2

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

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

Пример 3

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

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

Пример 4

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

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

Параметры

-AccessToken

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.8.0-Preview1 или более поздней.

Параметр AccessToken указывает веб-маркер OAuth JSON (JWT), который используется для подключения к Security and Compliance PowerShell.

В зависимости от типа маркера доступа этот параметр необходимо использовать с параметрами Organization, DelegatedOrganization или UserPrincipalName.

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

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

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

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

-AppId

Применимо: Exchange Online

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

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

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

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

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

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

-AzureADAuthorizationEndpointUri

Применимо: Exchange Online

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

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

Значение URI, заканчивающееся на, /organizations позволяет использовать только рабочие или учебные учетные записи. Старое значение URI, заканчивающееся на "/common", по-прежнему работает, но может предложить вам выбрать между личной учетной записью и рабочей или учебной учетной записью. Значение URI рекомендуется использовать /organizations в корпоративных сценариях, где следует исключить учетные записи потребителей.

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

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

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

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

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

-BypassMailboxAnchoring

Применимо: Exchange Online

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

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

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

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

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

-Certificate

Применимо: Exchange Online

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

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

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

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

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

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

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

-CertificateFilePath

Применимо: Exchange Online

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

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

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

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

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

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

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

-CertificatePassword

Применимо: Exchange Online

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

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

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

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

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

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

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

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

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

-CertificateThumbprint

Применимо: Exchange Online

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

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

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

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

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

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

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

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

-CommandName

Применимо: Exchange Online

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

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

Тип:

String[]

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

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

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

-ConnectionUri

Применимо: Exchange Online

Параметр 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 в Министерстве обороны Майкрософт: https://l5.ps.compliance.protection.office365.us/powershell-liveid/

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

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

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

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

-Credential

Применимо: Exchange Online

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

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

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

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

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

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

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

-DelegatedOrganization

Применимо: Exchange Online

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

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

Примечания.

  • В качестве значения этого параметра используйте основной домен .onmicrosoft.com делегированной организации.
  • С этим параметром необходимо использовать параметр AzureADAuthorizationEndpointUri.

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

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

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

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

-DisableWAM

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.7.2-Preview1 или более поздней.

Переключатель DisableWAM отключает диспетчер учетных веб-записей (WAM). С этим параметром не нужно указывать значение.

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

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

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

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

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

-EnableErrorReporting

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.8.1-Preview1 или более поздней.

Ключ EnableErrorReporting определяет, следует ли включать отчеты об ошибках. С этим параметром не нужно указывать значение.

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

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

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

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

-EnableSearchOnlySession

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.9.0-Preview1 или более поздней.

Ключ EnableSearchOnlySession указывает, следует ли включить определенные функции обнаружения электронных данных и связанные с ними командлеты, которые подключаются к другим службам Microsoft 365. С этим параметром не нужно указывать значение.

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

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

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

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

-EXOModuleBasePath

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.9.1-Preview1 или более поздней.

Параметр EXOModuleBasePath указывает папку, в которой хранится локальная временная копия модуля Exchange Online PowerShell. Если значение содержит пробелы, его необходимо заключить в кавычки (").

Connect-ExchangeOnline команды сохраняют временную копию модуля Exchange Online локально на клиенте для подключения к сеансу. По умолчанию временная копия модуля хранится в папке %TMP% (по умолчанию, C:\Users\<UserName>\AppData\Local\Temp).

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

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

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

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

-FormatTypeName

Применимо: Exchange Online

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

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

Тип:

String[]

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

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

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

-LogDirectoryPath

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.8.1-Preview1 или более поздней.

Параметр LogDirectoryPath определяет расположение файлов журнала. Расположение по умолчанию: %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv.

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

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

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

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

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

-LogLevel

Применимо: Exchange Online

Примечание: Этот параметр доступен в модуле версии 3.8.1-Preview1 или более поздней.

Параметр LogLevel определяет уровень ведения журнала. Допустимые значения: "Default" и "All".

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

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

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

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

-Organization

Применимо: Exchange Online

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

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

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

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

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

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

-Prefix

Применимо: Exchange Online

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

  • Значение Prefix не может содержать пробелы и специальные символы, такие как символы подчеркивания или звездочки.
  • Использовать значение префикса EXO невозможно. Это значение зарезервировано для девяти эксклюзивных командлетов Get-EXO* , встроенных в модуль.
  • Параметр Prefix влияет только на имена импортированных командлетов безопасности & соответствия. Она не влияет на имена командлетов, встроенных в модуль (например, Disconnect-ExchangeOnline).

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

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

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

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

-PSSessionOption

Применимо: Exchange Online

Примечание. Этот параметр не работает в подключениях REST API.

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

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

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

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

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

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

-ShowBanner

Применимо: Exchange Online

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

Переключатель ShowBanner показывает или скрывает сообщение баннера, отображаемое при запуске Connect-IPPSSession. С этим параметром не нужно указывать значение.

  • Для отображения баннера использовать этот переключатель не нужно (баннер отображается по умолчанию).
  • Чтобы скрыть баннер, используйте следующий точный синтаксис: -ShowBanner:$false.

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

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

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

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

-UserPrincipalName

Применимо: Exchange Online

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

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

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

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

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

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

-UseRPSSession

Применимо: Exchange Online

Примечание: Этот параметр не рекомендуется использовать в модуле версии 3.9.2 или более поздней. Удаленные подключения PowerShell к службам безопасности & соответствия требованиям PowerShell устарели в октябре 2023 года. Дополнительные сведения см. в разделе Устаревание удаленной оболочки PowerShell в разделе "Безопасность и соответствие требованиям PowerShell".

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

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

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

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

CommonParameters

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