Connect-ExchangeOnline

Синтаксис

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>]

Описание

Примеры

Пример 1

Connect-ExchangeOnline -UserPrincipalName chris@contoso.com

Пример 2

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

Пример 3

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

Пример 4

Connect-ExchangeOnline -Device

Пример 6

Connect-ExchangeOnline -InlineCredential

Параметры

-AccessToken

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

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

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

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

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

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

-AppId

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

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

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

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

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

-AzureADAuthorizationEndpointUri

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

Примечание. Если вы используете параметр ExchangeEnvironmentName, вам не нужно использовать параметры AzureADAuthorizationEndpointUri или ConnectionUri.

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

• Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательным является https://login.microsoftonline.com/organizationsзначение , но оно также является значением по умолчанию, поэтому вам не нужно использовать этот параметр.
• Office 365 Germanyhttps://login.microsoftonline.de/organizations
• Microsoft 365 GCC High или Microsoft 365 DoD: https://login.microsoftonline.us/organizations

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

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

Примечание. Проверка подлинности с помощью MFA или федеративная проверка подлинности недоступна в службе Office 365, предоставляемой 21Vianet.

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

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

-BypassMailboxAnchoring

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

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

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

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

-Certificate

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

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

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

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

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

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

-CertificateFilePath

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

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

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

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

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

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

-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 для безопасного запроса пароля сертификата не подходит для сценариев автоматизации. Другими словами, на самом деле не существует автоматизированного и безопасного способа подключения с помощью локального сертификата.

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

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

-CertificateThumbprint

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

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

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

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

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

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

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

-CommandName

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

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

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

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

-ConnectionUri

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

Примечание. Если вы используете параметр ExchangeEnvironmentName, вам не нужно использовать параметры AzureADAuthorizationEndpointUri или ConnectionUri.

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

• Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательным является https://outlook.office365.com/powershell-liveid/значение , но оно также является значением по умолчанию, поэтому вам не нужно использовать этот параметр.
• Office 365 Germanyhttps://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: https://webmail.apps.mil/powershell-liveID

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

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

-Credential

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

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

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

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

Чтобы задать пароль для файла сертификата, не используйте этот параметр; вместо него используйте параметр CertificatePassword.

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

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

-DelegatedOrganization

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

Параметр DelegatedOrganization указывает организацию-клиента, которой нужно управлять. Допустимым значением для этого параметра является основной идентификатор домена или клиента .onmicrosoft.com организации-клиента.

Этот параметр работает только в том случае, если организация-заказчик согласилась на делегированное управление через программу CSP.

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

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

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

-Device

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

Примечание. Этот параметр доступен в модуле версии 2.0.4-Preview6 или более поздней и только в PowerShell 7.

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

Использование этого переключателя приводит к отображению на экране сообщения с URL-адресом https://microsoft.com/devicelogin и уникальным кодом. На любом другом устройстве с веб-браузером и доступом в Интернет откройте URL-адрес, введите уникальный код и введите свои учетные данные на следующих страницах.

Если вход выполнен успешно, подключение PowerShell продолжается.

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

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

-DisableWAM

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

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

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

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

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

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

-EnableErrorReporting

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

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

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

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

-ExchangeEnvironmentName

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

ExchangeEnvironmentName определяет среду Exchange Online и избавляет от необходимости использовать параметры AzureADAuthorizationEndpointUri и ConnectionUri. Поддерживаются следующие среды PowerShell Exchange Online:

• Microsoft 365 или Microsoft 365 GCC: не используйте этот параметр. Обязательным является O365Defaultзначение , но оно также является значением по умолчанию, поэтому вам не нужно использовать этот параметр.
• Office 365 GermanyO365GermanyCloud
• Office 365, предоставляемый 21Vianet:O365China
• Microsoft 365 GCC High: O365USGovGCCHigh
• Министерство обороны Microsoft 365: O365USGovDoD

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

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

-EXOModuleBasePath

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

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

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

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

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

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

-FormatTypeName

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

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

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

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

-InlineCredential

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

Примечание. Этот параметр доступен в модуле версии 2.0.4-Preview6 или более поздней и только в PowerShell 7.

Ключ InlineCredential определяет, следует ли передавать учетные данные непосредственно в окне Windows PowerShell. С этим параметром не нужно указывать значение.

Этот переключатель аналогичен параметру Credential, но имеет дополнительную защиту. Ключ InlineCredential не требует локального хранения учетных данных в сценарии, и вы можете вводить учетные данные непосредственно в интерактивном сеансе PowerShell.

Этот ключ не работает с учетными записями, использующими MFA.

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

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

-LoadCmdletHelp

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

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

Переключатель LoadCmdletHelp скачивает файлы справки командлета для командлета Get-Help в подключениях REST API. С этим параметром не нужно указывать значение.

Начиная с версии 3.7.0-Preview1, файлы справки для командной строки не скачиваются по умолчанию. Используйте этот ключ для загрузки файлов справки командлета в командной строке.

Совет. Этот параметр заменяет параметр SkipLoadingCmdletHelp. Параметр SkipLoadingCmdletHelp больше не требуется и больше не работает, так как файлы справки командлетов больше не скачиваются по умолчанию.

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

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

-LogDirectoryPath

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

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

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

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

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

-LogLevel

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

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

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

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

-ManagedIdentity

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

Переключатель ManagedIdentity указывает, что для подключения используется управляемое удостоверение. С этим параметром не нужно указывать значение.

Управляемые подключения удостоверений в настоящее время поддерживаются для следующих типов ресурсов Azure:

• Модули Runbook службы автоматизации Azure
• Виртуальные машины Azure
• Azure Масштабируемые наборы виртуальных машин
• Функции Azure

Этот переключатель необходимо использовать с параметром Organization.

Для назначенных пользователем управляемых удостоверений необходимо также использовать этот переключатель с параметром ManagedIdentityAccountId.

Дополнительные сведения о подключении с помощью управляемого удостоверения см. в статье Использование управляемых удостоверений Azure для подключения к Exchange Online PowerShell.

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

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

-ManagedIdentityAccountId

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

Параметр ManagedIdentityAccountId указывает назначенное пользователю управляемое удостоверение, которое используется для подключения. Допустимым значением для этого параметра является идентификатор приложения (GUID) субъекта-службы, который соответствует назначенному пользователем управляемому удостоверению в Azure.

Этот параметр необходимо использовать вместе с параметром Organization и переключателем ManagedIdentity.

Дополнительные сведения о подключении с помощью управляемого удостоверения см. в статье Использование управляемых удостоверений Azure для подключения к Exchange Online PowerShell.

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

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

-Organization

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

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

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

Дополнительные сведения о подключении с помощью управляемого удостоверения см. в статье Использование управляемых удостоверений Azure для подключения к Exchange Online PowerShell.

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

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

-PageSize

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

Параметр PageSize указывает максимальное число записей на странице. Допустимое значение для этого параметра — целое число от 1 до 1000. Значение по умолчанию — 1000.

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

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

-Prefix

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

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

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

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

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

-PSSessionOption

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

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

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

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

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

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

-ShowBanner

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

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

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

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

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

-ShowProgress

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

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

• $true: отображается индикатор выполнения. Это значение используется по умолчанию.
• $false: Сейчас это значение не действует.

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

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

-SigningCertificate

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

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

Параметр SigningCertificate указывает сертификат клиента, который используется для подписи файлов формата (*. Format.ps1xml) или файлы модуля сценариев (.psm1) во временном модуле, который Connect-ExchangeOnline создает.

Допустимым значением для этого параметра является переменная, содержащая сертификат, команда или выражение, получающее сертификат.

Чтобы найти сертификат, используйте командлет Get-PfxCertificate в модуле Microsoft.PowerShell.Security или командлет Get-ChildItem в диске сертификата (Cert:). Если сертификат недействителен или не имеет достаточных полномочий, команда завершится ошибкой.

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

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

-SkipLoadingCmdletHelp

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

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

В версии 3.7.0-Preview1 и более поздних версиях этот параметр заменяется параметром LoadCmdletHelp. Параметр SkipLoadingCmdletHelp больше не требуется и больше ничего не делает, так как файлы справки командлета больше не загружаются по умолчанию.

Переключатель SkipLoadingCmdletHelp не позволяет скачивать файлы справки командлета для командлета Get-Help в подключениях REST API. С этим параметром не нужно указывать значение.

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

Этот ключ не работает с параметром UseRPSSession.

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

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

-SkipLoadingFormatData

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

Ключ SkipLoadingFormatData не позволяет скачивать данные формата для подключений REST API. С этим параметром не нужно указывать значение.

При использовании этого параметра выходные данные любого командлета Exchange будут неформатированными.

Используйте этот параметр, чтобы избежать ошибок при подключении к Exchange Online PowerShell из службы Windows или пакета SDK Windows PowerShell.

Этот ключ не работает с параметром UseRPSSession.

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

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

-TrackPerformance

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

Параметр TrackPerformance измеряет дополнительные события (например, загрузку ЦП и потребление памяти). Допустимые значения:

• $true: отслеживание производительности включено.
• $false. Отслеживание производительности отключено. Это значение используется по умолчанию.

Этот параметр работает, только если ведение журнала включено.

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

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

-UseMultithreading

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

Параметр UseMultithreading указывает, следует ли отключить или включить многопоточность в модуле PowerShell Exchange Online. Допустимые значения:

• $true: включение многопоточности. Это значение используется по умолчанию.
• $false: отключение многопоточности. Это значение снижает производительность девяти эксклюзивных командлетов Get-EXO* в модуле.

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

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

-UserPrincipalName

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

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

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

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

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

-UseRPSSession

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

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

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

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

CommonParameters