Connect-ExchangeOnline
Этот командлет доступен только в модуле PowerShell Exchange Online. Дополнительные сведения см. в разделе Сведения о модуле PowerShell Exchange Online.
Используйте командлет Connect-ExchangeOnline в модуле Exchange Online PowerShell, чтобы использовать современную проверку подлинности для подключения к Exchange Online PowerShell или PowerShell для встроенной надстройки безопасности для локальных почтовых ящиков. Этот командлет работает для учетных записей с многофакторной проверкой подлинности (MFA) или без нее.
Чтобы подключиться к PowerShell для обеспечения соответствия требованиям безопасности &, используйте командлет Connect-IPPSSession .
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Default (По умолчанию)
Connect-ExchangeOnline
[[-ConnectionUri] <String>]
[[-AzureADAuthorizationEndpointUri] <String>]
[[-ExchangeEnvironmentName] <ExchangeEnvironment>]
[[-PSSessionOption] <PSSessionOption>]
[[-DelegatedOrganization] <String>]
[[-Prefix] <String>]
[[-CommandName] <String[]>]
[[-FormatTypeName] <String[]>]
[-AccessToken <String>]
[-AppId <String>]
[-BypassMailboxAnchoring]
[-Certificate <X509Certificate2>]
[-CertificateFilePath <String>]
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-Device]
[-DisableWAM]
[-EnableErrorReporting]
[-EXOModuleBasePath <String>]
[-InlineCredential]
[-LoadCmdletHelp]
[-LogDirectoryPath <String>]
[-LogLevel <LogLevel>]
[-ManagedIdentity]
[-ManagedIdentityAccountId <String>]
[-Organization <String>]
[-PageSize <UInt32>]
[-ShowBanner]
[-ShowProgress <Boolean>]
[-SigningCertificate <X509Certificate2>]
[-SkipLoadingCmdletHelp]
[-SkipLoadingFormatData]
[-TrackPerformance <Boolean>]
[-UseMultithreading <Boolean>]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]
Описание
Этот командлет создает подключение PowerShell к Exchange Online организации.
Команды connect, скорее всего, завершатся ошибкой, если путь к профилю учетной записи, используемой для подключения, содержит специальные символы PowerShell (например, $). Обходной путь заключается в подключении с помощью другой учетной записи, которая не содержит специальных символов в пути к профилю.
Примеры
Пример 1
Connect-ExchangeOnline -UserPrincipalName chris@contoso.com
В этом примере выполняется подключение к Exchange Online PowerShell с использованием современной проверки подлинности с многофакторной проверкой подлинности (MFA) или без нее. Подключение использует режим REST API и не требует включения обычной проверки подлинности в WinRM на локальном компьютере.
Пример 2
Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"
В этом примере выполняется подключение к Exchange Online PowerShell в сценарии автоматического скрипта с помощью отпечатка сертификата.
Пример 3
Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"
В этом примере выполняется подключение к Exchange Online PowerShell в сценарии автоматического скрипта с помощью файла сертификата. Этот метод лучше всего подходит для сценариев, когда сертификат хранится на удаленных компьютерах и извлекается во время выполнения. Например, сертификат хранится в Azure Key Vault.
Пример 4
Connect-ExchangeOnline -Device
В PowerShell 7.0.3 или более поздней версии с использованием модуля 2.0.4 или более поздней версии этот пример подключается к Exchange Online PowerShell в интерактивных сценариях сценариев на компьютерах без веб-браузеров.
Команда возвращает URL-адрес и уникальный код, связанный с сеансом. Откройте URL-адрес в браузере на любом компьютере и введите уникальный код. После завершения входа в веб-браузере сеанс в окне PowerShell 7 проходит проверку подлинности с помощью обычного потока проверки подлинности Microsoft Entra, а командлеты Exchange Online импортируются через несколько секунд.
Пример 6
Connect-ExchangeOnline -InlineCredential
В PowerShell 7.0.3 или более поздней версии с помощью модуля 2.0.4 или более поздней версии этот пример подключается к Exchange Online PowerShell в интерактивных сценариях, передавая учетные данные непосредственно в окне PowerShell.
Параметры
-AccessToken
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 3.1.0-Preview1 или более поздней.
Параметр AccessToken указывает веб-токен OAuth JSON (JWT), который используется для подключения к Exchange Online.
В зависимости от типа маркера доступа этот параметр необходимо использовать с параметрами Organization, DelegatedOrganization или UserPrincipalName.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AppId
Применимо: Exchange Online
Параметр AppId указывает идентификатор приложения субъекта-службы, который используется для проверки подлинности на основе сертификатов (CBA). Допустимым значением является GUID идентификатора приложения (субъекта-службы). Например, 36ee4c6c-0812-40a2-b820-b22ebd02bce3.
Дополнительные сведения см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AzureADAuthorizationEndpointUri
Применимо: Exchange Online
Примечание. Если вы используете параметр ExchangeEnvironmentName, вам не нужно использовать параметры AzureADAuthorizationEndpointUri или ConnectionUri.
Параметр AzureADAuthorizationEndpointUri указывает конечную точку авторизации Microsoft Entra, которая может выдавать маркеры доступа OAuth2. Поддерживаются следующие Exchange Online среды PowerShell и связанные значения:
- Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательное значение —
https://login.microsoftonline.com/organizations, но это также значение по умолчанию, поэтому использовать этот параметр не нужно. - Office 365 Германии:
https://login.microsoftonline.de/organizations - Microsoft 365 GCC High или Microsoft 365 DoD:
https://login.microsoftonline.us/organizations
Значение URI, заканчивающееся на /organizations , разрешает использовать только рабочие или учебные учетные записи. Старое значение URI, заканчивающееся на/common, по-прежнему работает, но может предложить выбрать между личная учетная запись и рабочей или учебной учетной записью. Мы рекомендуем использовать /organizations значение URI в корпоративных сценариях, в которых следует исключить учетные записи потребителей.
Если вы используете параметр UserPrincipalName, вам не нужно использовать параметр AzureADAuthorizationEndpointUri для MFA или федеративных пользователей в средах, которым он обычно требуется (UserPrincipalName или AzureADAuthorizationEndpointUri является обязательным; ОК для использования обоих вариантов).
Примечание. Проверка подлинности MFA или федеративная проверка подлинности недоступна в Office 365 под управлением 21Vianet.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-BypassMailboxAnchoring
Применимо: Exchange Online
Параметр BypassMailboxAnchoring обходит использование указания привязки почтового ящика. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Certificate
Применимо: Exchange Online
Параметр Certificate указывает сертификат, используемый для проверки подлинности на основе сертификата (CBA). Допустимым значением является значение объекта X509Certificate2 сертификата.
Не используйте этот параметр с параметрами CertificateFilePath или CertificateThumbprint.
Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.
Свойства параметров
| Тип: | X509Certificate2 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CertificateFilePath
Применимо: Exchange Online
Параметр CertificateFilePath указывает сертификат, используемый для CBA. Допустимым значением является полный открытый путь к файлу сертификата. Используйте параметр CertificatePassword с этим параметром.
Не используйте этот параметр с параметрами Certificate или CertificateThumbprint.
Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.
Свойства параметров
| Тип: | String |
| Default value: | 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 см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.
Примечание. Использование команды ConvertTo-SecureString для локального хранения пароля сертификата не позволяет использовать метод безопасного подключения для сценариев автоматизации. Использование команды Get-Credential для безопасного запроса пароля сертификата не подходит для сценариев автоматизации. Другими словами, на самом деле нет автоматизированного и безопасного способа подключения с помощью локального сертификата.
Свойства параметров
| Тип: | SecureString |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CertificateThumbprint
Применимо: Exchange Online
Параметр CertificateThumbprint указывает сертификат, используемый для CBA. Допустимое значение — это значение отпечатка сертификата. Например, 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.
Не используйте этот параметр с параметрами Certificate или CertificateFilePath.
Примечание. Параметр CertificateThumbprint поддерживается только в Microsoft Windows.
Дополнительные сведения о CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CommandName
Применимо: Exchange Online
Параметр CommandName указывает разделенный запятыми список команд для импорта в сеанс. Используйте этот параметр для приложений или сценариев, использующих определенный набор командлетов. Уменьшение количества командлетов в сеансе помогает повысить производительность и уменьшить объем памяти приложения или скрипта.
Свойства параметров
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 6 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ConnectionUri
Применимо: Exchange Online
Примечание. Если вы используете параметр ExchangeEnvironmentName, вам не нужно использовать параметры AzureADAuthorizationEndpointUri или ConnectionUri.
Параметр ConnectionUri указывает конечную точку подключения для сеанса PowerShell. Поддерживаются следующие Exchange Online среды PowerShell и связанные значения:
- Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательное значение —
https://outlook.office365.com/powershell-liveid/, но это также значение по умолчанию, поэтому использовать этот параметр не нужно. - Office 365 Германии:
https://outlook.office.de/PowerShell-LiveID - Office 365 управляется компанией 21Vianet:
https://partner.outlook.cn/PowerShell - Microsoft 365 GCC High:
https://outlook.office365.us/powershell-liveID - Microsoft 365 DoD:
https://webmail.apps.mil/powershell-liveID
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 0 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Credential
Применимо: Exchange Online
Параметр Credential указывает имя пользователя и пароль, используемые для подключения к Exchange Online PowerShell. Как правило, этот параметр используется в сценариях, или если требуется указывать различные учетные данные, которые предоставляют необходимые разрешения. Не используйте этот параметр для учетных записей, использующих многофакторную проверку подлинности (MFA).
Перед выполнением команды Connect-ExchangeOnline сохраните имя пользователя и пароль в переменной (например, $UserCredential = Get-Credential). Затем используйте имя переменной ($UserCredential) для этого параметра.
После выполнения команды Connect-ExchangeOnline ключ пароля в переменной очищается.
Чтобы указать пароль для файла сертификата, не используйте этот параметр. вместо этого используйте параметр CertificatePassword.
Свойства параметров
| Тип: | PSCredential |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-DelegatedOrganization
Применимо: Exchange Online
Параметр DelegatedOrganization указывает организацию клиента, которой вы хотите управлять. Допустимым значением для этого параметра является основной домен onmicrosoft.com или идентификатор клиента организации клиента.
Этот параметр работает, только если организация-клиент согласилась на делегированное управление с помощью программы CSP.
После успешной проверки подлинности командлеты в этом сеансе сопоставляются с клиентской организацией, а все операции в этом сеансе выполняются в организации клиента.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 4 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Device
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 2.0.4-Preview6 или более поздней и только в PowerShell 7.
Переключатель устройства обычно используется на компьютерах без веб-браузеров. С этим параметром не нужно указывать значение.
При использовании этого параметра появится экранное сообщение, содержащее URL-адрес https://microsoft.com/devicelogin и уникальный код. На любом другом устройстве с веб-браузером и доступом к Интернету откройте URL-адрес, введите уникальный код и введите свои учетные данные на последующих страницах.
Если вход выполнен успешно, подключение к PowerShell продолжается.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-DisableWAM
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 3.7.2-Preview1 или более поздней.
Параметр DisableWAM отключает диспетчер веб-учетных записей (WAM). С этим параметром не нужно указывать значение.
Начиная с версии 3.7.0, WAM включен по умолчанию при подключении к Exchange Online. Если во время входа возникают проблемы, связанные с WAM, этот параметр можно использовать для отключения WAM.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-EnableErrorReporting
Применимо: Exchange Online
Параметр EnableErrorReporting указывает, следует ли включать отчеты об ошибках. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ExchangeEnvironmentName
Применимо: Exchange Online
ExchangeEnvironmentName указывает среду Exchange Online и устраняет необходимость использования параметров AzureADAuthorizationEndpointUri и ConnectionUri. Поддерживаются следующие Exchange Online средах PowerShell:
- Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательное значение —
O365Default, но это также значение по умолчанию, поэтому использовать этот параметр не нужно. - Office 365 Германии:
O365GermanyCloud - Office 365 управляется компанией 21Vianet:
O365China - Microsoft 365 GCC High:
O365USGovGCCHigh - Microsoft 365 DoD:
O365USGovDoD
Свойства параметров
| Тип: | ExchangeEnvironment |
| Default value: | O365Default |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 2 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-EXOModuleBasePath
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 3.9.1-Preview1 или более поздней.
Параметр EXOModuleBasePath указывает папку, в которой хранится локальная временная копия модуля PowerShell Exchange Online. Если значение содержит пробелы, его необходимо заключить в кавычки (").
Connect-ExchangeOnline команды хранят временную копию модуля Exchange Online локально на клиенте для подключения к сеансу. По умолчанию временная копия модуля хранится в папке %TMP% (по умолчанию). C:\Users\<UserName>\AppData\Local\Temp
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-FormatTypeName
Применимо: Exchange Online
Параметр FormatTypeName указывает формат выходных данных командлета.
Свойства параметров
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 7 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-InlineCredential
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 2.0.4-Preview6 или более поздней и только в PowerShell 7.
Параметр InlineCredential указывает, следует ли передавать учетные данные непосредственно в окне Windows PowerShell. С этим параметром не нужно указывать значение.
Этот параметр аналогичен параметру Credential, но с добавленной безопасностью. Для параметра InlineCredential не требуется хранить учетные данные локально в скрипте, и вы можете ввести учетные данные непосредственно в интерактивном сеансе PowerShell.
Этот параметр не работает с учетными записями, используюющими MFA.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LoadCmdletHelp
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 3.7.0-Preview1 или более поздней.
Параметр LoadCmdletHelp скачивает файлы справки для командлета Get-Help в подключениях REST API. С этим параметром не нужно указывать значение.
Начиная с версии 3.7.0-Preview1 файлы справки для командной строки не загружаются по умолчанию. Используйте этот параметр, чтобы скачать файлы для справки по командлетам в командной строке.
Совет. Этот параметр заменяет параметр SkipLoadingCmdletHelp. Параметр SkipLoadingCmdletHelp больше не требуется и больше не работает, так как файлы справки командлетов больше не загружаются по умолчанию.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LogDirectoryPath
Применимо: Exchange Online
Параметр LogDirectoryPath указывает расположение файлов журнала. Расположение по умолчанию — %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv.
Если указать пользовательское расположение и имя файла, содержащие пробелы, заключите значение в кавычки (").
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LogLevel
Применимо: Exchange Online
Параметр LogLevel указывает уровень ведения журнала. Допустимые значения: Default и All.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ManagedIdentity
Применимо: Exchange Online
Параметр ManagedIdentity указывает, что для подключения используется управляемое удостоверение. С этим параметром не нужно указывать значение.
Подключения управляемых удостоверений в настоящее время поддерживаются для следующих типов ресурсов Azure:
- модули Runbook служба автоматизации Azure
- Виртуальные машины Azure
- Azure Масштабируемые наборы виртуальных машин
- Функции Azure
Этот параметр необходимо использовать с параметром Organization.
Для управляемого удостоверения, назначаемого пользователем, этот параметр также необходимо использовать с параметром ManagedIdentityAccountId.
Дополнительные сведения о подключении с помощью управляемого удостоверения см. в статье Использование Azure управляемых удостоверений для подключения к Exchange Online PowerShell.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ManagedIdentityAccountId
Применимо: Exchange Online
Параметр ManagedIdentityAccountId указывает управляемое удостоверение, назначаемое пользователем, которое вы используете для подключения. Допустимым значением для этого параметра является идентификатор приложения (GUID) субъекта-службы, соответствующий управляемому удостоверению, назначаемому пользователем, в Azure.
Этот параметр необходимо использовать вместе с параметром Organization и параметром ManagedIdentity.
Дополнительные сведения о подключении с помощью управляемого удостоверения см. в статье Использование Azure управляемых удостоверений для подключения к Exchange Online PowerShell.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Organization
Применимо: Exchange Online
Параметр Organization указывает организацию при подключении с помощью CBA или управляемого удостоверения. Допустимым значением для этого параметра является основной домен .onmicrosoft.com организации.
Дополнительные сведения о подключении с помощью CBA см. в статье Проверка подлинности только для приложений для автоматических сценариев в модуле Exchange Online PowerShell.
Дополнительные сведения о подключении с помощью управляемого удостоверения см. в статье Использование Azure управляемых удостоверений для подключения к Exchange Online PowerShell.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PageSize
Применимо: Exchange Online
Параметр PageSize указывает максимальное число записей на странице. Допустимое значение для этого параметра — целое число от 1 до 1000. Значение по умолчанию — 1000.
Свойства параметров
| Тип: | UInt32 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Prefix
Применимо: Exchange Online
Параметр Prefix задает текстовое значение, добавляемое к именам Exchange Online командлетов PowerShell при подключении. Например, Get-InboundConnector становится Get-ContosoInboundConnector при использовании значения Contoso для этого параметра.
- Значение префикса не может содержать пробелы или специальные символы, такие как символы подчеркивания или звездочки.
- Нельзя использовать значение префикса EXO. Это значение зарезервировано для девяти эксклюзивных командлетов Get-EXO* , встроенных в модуль.
- Параметр Prefix влияет только на импортированные Exchange Online имена командлетов. Он не влияет на имена командлетов, встроенных в модуль (например, Disconnect-ExchangeOnline).
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 5 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PSSessionOption
Применимо: Exchange Online
Примечание. Этот параметр не работает в подключениях REST API.
Параметр PSSessionOption указывает параметры сеанса PowerShell для использования в подключении к Exchange Online. Этот параметр работает только в том случае, если вы также используете параметр UseRPSSession в той же команде.
Сохраните выходные данные команды New-PSSessionOption в переменной (например, $PSOptions = New-PSSessionOption <Settings>) и используйте имя переменной в качестве значения для этого параметра (например, $PSOptions).
Свойства параметров
| Тип: | PSSessionOption |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 3 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ShowBanner
Применимо: Exchange Online
Переключатель ShowBanner отображает или скрывает сообщение баннера, которое отображается при запуске Connect-ExchangeOnline. С этим параметром не нужно указывать значение.
- Чтобы отобразить баннер, вам не нужно использовать этот параметр (баннер отображается по умолчанию).
- Чтобы скрыть баннер, используйте следующий синтаксис:
-ShowBanner:$false.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | $true |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ShowProgress
Применимо: Exchange Online
Параметр ShowProgress указывает, следует ли отображать или скрывать индикатор выполнения импортированных командлетов при подключении. Допустимые значения:
- $true: отображается индикатор выполнения. Это значение является значением по умолчанию.
- $false. В настоящее время это значение не действует.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SigningCertificate
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 3.2.0-Preview4 или более поздней.
Параметр SignCertificate указывает сертификат клиента, который используется для подписи файлов форматирования (*. Format.ps1xml) или файлы модуля скриптов (PSM1) во временном модуле, который Connect-ExchangeOnline создает.
Допустимым значением для этого параметра является переменная, содержащая сертификат, либо команда или выражение, которое получает сертификат.
Чтобы найти сертификат, используйте командлет Get-PfxCertificate в модуле Microsoft.PowerShell.Security или командлет Get-ChildItem на диске certificate (Cert:). Если сертификат не действителен или не имеет достаточных полномочий, команда завершится ошибкой.
Свойства параметров
| Тип: | X509Certificate2 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SkipLoadingCmdletHelp
Применимо: Exchange Online
Примечание. Этот параметр доступен в модуле версии 3.3.0-Preview1 или более поздней.
В версии 3.7.0-Preview1 или более поздней этот параметр заменяется параметром LoadCmdletHelp. Параметр SkipLoadingCmdletHelp больше не требуется и больше ничего не делает, так как файлы справки командлетов больше не загружаются по умолчанию.
Параметр SkipLoadingCmdletHelp предотвращает скачивание файлов справки командлета для командлета Get-Help в подключениях REST API. С этим параметром не нужно указывать значение.
При использовании этого параметра локальные файлы справки для командлетов не будут отображаться в командной строке.
Этот параметр не работает с параметром UseRPSSession.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SkipLoadingFormatData
Применимо: Exchange Online
Параметр SkipLoadingFormatData запрещает скачивание данных формата для подключений REST API. С этим параметром не нужно указывать значение.
При использовании этого параметра выходные данные любого командлета Exchange неформатируются.
Используйте этот параметр, чтобы избежать ошибок при подключении к Exchange Online PowerShell из службы Windows или пакета SDK для Windows PowerShell.
Этот параметр не работает с параметром UseRPSSession.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-TrackPerformance
Применимо: Exchange Online
Параметр TrackPerformance измеряет дополнительные события (например, загрузку ЦП и потребляемую память). Допустимые значения:
- $true: включено отслеживание производительности.
- $false. Отслеживание производительности отключено. Это значение является значением по умолчанию.
Этот параметр работает, только если ведение журнала включено.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-UseMultithreading
Применимо: Exchange Online
Параметр UseMultithreading указывает, следует ли отключить или включить многопоточность в модуле Exchange Online PowerShell. Допустимые значения:
- $true: включение многопотоковой поддержки. Это значение является значением по умолчанию.
- $false: отключите многопотоочное. Это значение снижает производительность девяти эксклюзивных командлетов Get-EXO* в модуле.
Свойства параметров
| Тип: | Boolean |
| Default value: | 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 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-UseRPSSession
Применимо: Exchange Online
Примечание. Этот параметр не рекомендуется использовать в модуле версии 3.9.2 или более поздней. Удаленные подключения PowerShell к Exchange Online PowerShell были устарели в октябре 2023 г. Дополнительные сведения см. в разделе Прекращение поддержки удаленной оболочки PowerShell в Exchange Online.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | 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.