Connect-ExchangeOnline
此 cmdlet 仅在 Exchange Online PowerShell 模块中可用。 有关详细信息,请参阅关于 Exchange Online PowerShell 模块。
使用 Exchange Online PowerShell 模块中的 Connect-ExchangeOnline cmdlet,使用新式身份验证连接到 Exchange Online PowerShell 或 PowerShell,以获取用于本地邮箱的内置安全加载项。 此 cmdlet 适用于具有或不具有多重身份验证 (MFA) 的帐户。
若要连接到 Security & Compliance PowerShell,请使用 Connect-IPPSSession cmdlet。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
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>]
说明
此 cmdlet 创建与 Exchange Online 组织的 PowerShell 连接。
如果用于连接的帐户的配置文件路径包含特殊 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 密钥保管库中。
示例 4
Connect-ExchangeOnline -Device
在 PowerShell 7.0.3 或更高版本中使用该模块的版本 2.0.4 或更高版本中,此示例在没有 Web 浏览器的计算机上的交互式脚本方案中连接到 Exchange Online PowerShell。
命令返回一个与会话绑定的URL和唯一代码。 需要在任意计算机上的浏览器中打开 URL,然后输入唯一代码。 在 Web 浏览器中完成登录后,Powershell 7 窗口中的会话将通过常规 Microsoft Entra 身份验证流进行身份验证,并在几秒钟后导入 Exchange Online cmdlet。
示例 6
Connect-ExchangeOnline -InlineCredential
在使用 2.0.4 或更高版本模块的 PowerShell 7.0.3 或更高版本中,此示例通过直接在 PowerShell 窗口中传递凭据连接到交互式脚本场景中的 Exchange Online PowerShell。
参数
-AccessToken
适用:Exchange Online
注意:此参数在模块版本 3.1.0-Preview1 或更高版本中可用。
AccessToken 参数指定用于连接到 Exchange Online 的 OAuth JSON Web 令牌 (JWT) 。
根据访问令牌的类型,需要将此参数与 Organization、DelegatedOrganization 或 UserPrincipalName 参数一起使用。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AppId
适用:Exchange Online
AppId 参数指定基于证书的身份验证 (CBA) 中使用的服务主体的应用程序 ID。 有效值是应用程序 ID (服务主体) 的 GUID。 例如,36ee4c6c-0812-40a2-b820-b22ebd02bce3。
有关详细信息,请参阅 Exchange Online PowerShell 模块中无人参与脚本的仅应用身份验证。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AzureADAuthorizationEndpointUri
适用:Exchange Online
注意:如果使用 ExchangeEnvironmentName 参数,则无需使用 AzureADAuthorizationEndpointUri 或 ConnectionUri 参数。
AzureADAuthorizationEndpointUri 参数指定可发出 OAuth2 访问令牌的 Microsoft Entra 授权终结点。 支持以下 Exchange Online PowerShell 环境和相关值:
- Microsoft 365 或 Microsoft 365 GCC:请勿使用此参数。 必需值为
https://login.microsoftonline.com/organizations,但这也是默认值,因此无需使用此参数。 - Office 365 Germany:
https://login.microsoftonline.de/organizations - Microsoft 365 GCC High 或 Microsoft 365 DoD:
https://login.microsoftonline.us/organizations
结尾 /organizations 的 URI 值仅允许工作或学校帐户。 结尾的/common较旧 URI 值仍然有效,但可能会提示你在个人帐户和工作或学校帐户之间进行选择。 在应排除消费者帐户的企业方案中,建议 /organizations 使用 URI 值。
如果使用 UserPrincipalName 参数,则无需在通常需要 UserPrincipalName 或 AzureADAuthorizationEndpointUri 的环境中对 MFA 或联合用户使用 AzureADAuthorizationEndpointUri 参数, (UserPrincipalName 或 AzureADAuthorizationEndpointUri 是必需的;可以同时使用这两种) 。
注意: MFA 身份验证或联合身份验证在世纪互联运营的 Office 365 中不可用。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 1 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-BypassMailboxAnchoring
适用:Exchange Online
BypassMailboxAnchoring 开关绕过使用邮箱定位提示。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Certificate
适用:Exchange Online
证书参数指定用于基于证书的身份验证 (CBA) 的证书。 有效值是证书的 X509Certificate2 对象值。
请勿将此参数与 CertificateFilePath 或 CertificateThumbprint 参数一起使用。
有关 CBA 的详细信息,请参阅 Exchange Online PowerShell 模块中无人参与脚本的仅应用身份验证。
参数属性
| 类型: | X509Certificate2 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CertificateFilePath
适用:Exchange Online
CertificateFilePath 参数指定用于 CBA 的证书。 有效值是证书文件的完整公共路径。 将 CertificatePassword 参数与此参数一起使用。
请勿将此参数与 Certificate 或 CertificateThumbprint 参数一起使用。
有关 CBA 的详细信息,请参阅 Exchange Online PowerShell 模块中无人参与脚本的仅应用身份验证。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CertificatePassword
适用:Exchange Online
使用 CertificateFilePath 参数标识用于 CBA 的证书时,CertificatePassword 参数指定打开证书文件所需的密码。
可以使用以下方法作为此参数的值:
-
(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 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CertificateThumbprint
适用:Exchange Online
CertificateThumbprint 参数指定用于 CBA 的证书。 有效值是证书的指纹值。 例如,83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1。
请勿将此参数与 Certificate 或 CertificateFilePath 参数一起使用。
注意:仅 Microsoft Windows 支持 CertificateThumbprint 参数。
有关 CBA 的详细信息,请参阅 Exchange Online PowerShell 模块中无人参与脚本的仅应用身份验证。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CommandName
适用:Exchange Online
CommandName 参数指定要导入会话的命令列表(以逗号分隔)。 对使用一组特定 cmdlet 的应用程序或脚本使用此参数。 减少会话中的 cmdlet 数量有助于提高性能并减少应用程序或脚本的内存占用量。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | 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 Germany:
https://outlook.office.de/PowerShell-LiveID - 由世纪互联运营的 Office 365:
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 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | 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 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DelegatedOrganization
适用:Exchange Online
DelegatedOrganization 参数指定要管理的客户组织。 此参数的有效值是客户组织的主 .onmicrosoft.com 域或租户 ID。
仅当客户组织同意通过 CSP 计划委派管理时,此参数才有效。
成功进行身份验证后,此会话中的 cmdlet 将映射到客户组织,并且此会话中的所有操作都将在客户组织上完成。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 4 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Device
适用:Exchange Online
注意:此参数在模块版本 2.0.4-Preview6 或更高版本中可用,并且仅在 PowerShell 7 中可用。
设备开关通常用于没有 Web 浏览器的计算机。 不必为此开关指定值。
使用此开关可生成包含 URL https://microsoft.com/devicelogin 和唯一代码的屏幕消息。 在具有 Web 浏览器和 Internet 访问权限的任何其他设备上,打开 URL,输入唯一代码,然后在后续页面中输入凭据。
如果登录成功,则 PowerShell 连接将继续。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DisableWAM
适用:Exchange Online
注意:此参数在模块版本 3.7.2-Preview1 或更高版本中可用。
DisableWAM 开关禁用 Web 帐户管理器 (WAM) 。 不必为此开关指定值。
从 3.7.0 版开始,连接到 Exchange Online 时默认启用 WAM。 如果在登录过程中遇到与 WAM 相关的问题,可以使用此开关禁用 WAM。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-EnableErrorReporting
适用:Exchange Online
EnableErrorReporting 开关指定是否启用错误报告。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | 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 Germany:
O365GermanyCloud - 由世纪互联运营的 Office 365:
O365China - Microsoft 365 GCC High:
O365USGovGCCHigh - Microsoft 365 DoD:
O365USGovDoD
参数属性
| 类型: | ExchangeEnvironment |
| 默认值: | O365Default |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 2 |
| 必需: | 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 |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-FormatTypeName
适用:Exchange Online
FormatTypeName 参数指定 cmdlet 的输出格式。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | 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 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-LoadCmdletHelp
适用:Exchange Online
注意:此参数在模块版本 3.7.0-Preview1 或更高版本中可用。
LoadCmdletHelp 开关下载 REST API 连接中 Get-Help cmdlet 的 cmdlet 帮助文件。 不必为此开关指定值。
从 v3.7.0-Preview1 开始,默认情况下不下载命令行的帮助文件。 使用此开关在命令行下载 cmdlet 帮助的文件。
提示: 此参数替换 SkipLoadingCmdletHelp 参数。 不再需要 SkipLoadingCmdletHelp 参数,并且不再有效,因为默认情况下不再下载 cmdlet 帮助文件。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-LogDirectoryPath
适用:Exchange Online
LogDirectoryPath 参数指定日志文件的位置。 默认位置为 %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv。
如果指定包含空格的自定义位置和文件名,请将该值括在引号 (“) 中。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-LogLevel
适用:Exchange Online
LogLevel 参数指定日志记录级别。 有效值为“默认”和“全部”。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ManagedIdentity
适用:Exchange Online
ManagedIdentity 开关指定你正在使用托管身份进行连接。 不必为此开关指定值。
以下类型的 Azure 资源当前支持托管标识连接:
- Azure 自动化 runbook
- Azure 虚拟机
- Azure 虚拟机规模集
- Azure Functions
必须将此开关与组织参数一起使用。
对于用户分配的托管标识,还必须将此开关与 ManagedIdentityAccountId 参数配合使用。
有关使用托管标识连接的详细信息,请参阅使用 Azure 托管标识连接到 Exchange Online PowerShell。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ManagedIdentityAccountId
适用:Exchange Online
ManagedIdentityAccountId 参数指定用于连接的用户分配的托管标识。 此参数的有效值是服务主体的应用程序 ID (GUID) ,与 Azure 中用户分配的托管标识相对应。
必须将此参数与组织参数和 ManagedIdentity 开关一起使用。
有关使用托管标识连接的详细信息,请参阅使用 Azure 托管标识连接到 Exchange Online PowerShell。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Organization
适用:Exchange Online
使用 CBA 或托管标识连接时,组织参数指定组织。 此参数的有效值是组织的主要 .onmicrosoft.com 域。
有关与 CBA 连接的详细信息,请参阅 Exchange Online PowerShell 模块中无人参与脚本的仅应用身份验证。
有关使用托管标识连接的详细信息,请参阅使用 Azure 托管标识连接到 Exchange Online PowerShell。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PageSize
适用:Exchange Online
PageSize 参数指定每页的最大条目数量。 此参数的有效输入是介于 1 和 1000 之间的整数。 默认值为 1000。
参数属性
| 类型: | UInt32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Prefix
适用:Exchange Online
Prefix 参数指定在连接时要添加到 Exchange Online PowerShell cmdlet 名称的文本值。 例如,如果对此参数使用值 Contoso,则 Get-InboundConnector 变为 Get-ContosoInboundConnector。
- 前缀值不能包含空格或下划线或星号等特殊字符。
- 不能使用前缀值 EXO。 该值是为模块中内置的 9 个独占 Get-EXO* cmdlet 保留的。
- Prefix 参数仅影响导入的 Exchange Online cmdlet 名称。 它不会影响模块 (内置的 cmdlet 的名称,例如 Disconnect-ExchangeOnline) 。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 5 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PSSessionOption
适用:Exchange Online
注意:此参数在 REST API 连接中不起作用。
PSSessionOption 参数指定在连接到 Exchange Online 时要使用的 PowerShell 会话选项。 仅当你还在同一命令中使用 UseRPSSession 开关时,此参数才起作用。
将 New-PSSessionOption 命令的输出存储在变量 ((例如 $PSOptions = New-PSSessionOption <Settings>) )中,并将变量名称用作此参数的值, (例如 $PSOptions) 。
参数属性
| 类型: | PSSessionOption |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 3 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ShowBanner
适用:Exchange Online
ShowBanner 开关显示或隐藏运行 Connect-ExchangeOnline 时显示的横幅消息。 不必为此开关指定值。
- 若要显示横幅,无需使用此开关, (默认) 显示横幅。
- 若要隐藏横幅,请使用以下确切语法:
-ShowBanner:$false。
参数属性
| 类型: | SwitchParameter |
| 默认值: | $true |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ShowProgress
适用:Exchange Online
ShowProgress 参数指定在连接时是显示还是隐藏导入的 cmdlet 的进度栏。 有效值包含:
- $true:显示进度栏。 此值为默认值。
- $false:目前,此值不起作用。
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SigningCertificate
适用:Exchange Online
注意:此参数在模块版本 3.2.0-Preview4 或更高版本中可用。
SigningCertificate 参数指定用于对格式文件进行签名的客户端证书 (*。Format.ps1xml) 或脚本模块文件 (.psm1) Connect-ExchangeOnline 创建的临时模块中。
此参数的有效值是包含证书的变量,或获取证书的命令或表达式。
若要查找证书,请使用 Microsoft.PowerShell.Security 模块中的 Get-PfxCertificate cmdlet,或使用 Cert:) 驱动器 (证书中的 Get-ChildItem cmdlet。 如果证书无效或没有足够的颁发机构,则该命令将失败。
参数属性
| 类型: | X509Certificate2 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SkipLoadingCmdletHelp
适用:Exchange Online
注意:此参数在模块版本 3.3.0-Preview1 或更高版本中可用。
在版本 3.7.0-Preview1 或更高版本中,此参数替换为 LoadCmdletHelp 参数。 不再需要 SkipLoadingCmdletHelp 参数,并且不再执行任何操作,因为默认情况下不再下载 cmdlet 帮助文件。
SkipLoadingCmdletHelp 开关阻止在 REST API 连接中下载 Get-Help cmdlet 的 cmdlet 帮助文件。 不必为此开关指定值。
使用此开关时,不会在命令行获取任何 cmdlet 的本地帮助文件。
此开关不能与 UseRPSSession 开关一起使用。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SkipLoadingFormatData
适用:Exchange Online
SkipLoadingFormatData 开关阻止下载 REST API 连接的格式数据。 不必为此开关指定值。
使用此开关时,任何 Exchange cmdlet 的输出都未格式化。
使用此开关可避免从 Windows 服务或 Windows PowerShell SDK 内连接到 Exchange Online PowerShell 时发生错误。
此开关不能与 UseRPSSession 开关一起使用。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TrackPerformance
适用:Exchange Online
TrackPerformance 参数测量其他事件 (例如 CPU 负载和内存消耗) 。 有效值包含:
- $true:启用性能跟踪。
- $false:禁用绩效跟踪。 此值为默认值。
此参数仅在启用日志记录时有效。
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UseMultithreading
适用:Exchange Online
UseMultithreading 参数指定是在 Exchange Online PowerShell 模块中禁用还是启用多线程。 有效值包含:
- $true:启用多线程。 此值为默认值。
- $false:禁用多线程。 此值会降低模块中的九个独占 Get-EXO* cmdlet 的性能。
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UserPrincipalName
适用:Exchange Online
例如 UserPrincipalName 参数指定要用于连接 (的帐户,例如 navin@contoso.onmicrosoft.com) 。 使用此参数可让你在系统提示你输入密码) (跳过在新式身份验证凭据提示中输入用户名。
如果使用 UserPrincipalName 参数,则无需在通常需要 UserPrincipalName 或 AzureADAuthorizationEndpointUri 的环境中对 MFA 或联合用户使用 AzureADAuthorizationEndpointUri 参数, (UserPrincipalName 或 AzureADAuthorizationEndpointUri 是必需的;可以同时使用这两种) 。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UseRPSSession
适用:Exchange Online
注意:此参数在模块版本 3.9.2 或更高版本中已弃用。 REST API 连接于 2023 年 10 月替换了 Exchange Online PowerShell 中的远程 PowerShell 连接。 有关详细信息,请参阅 Exchange Online 中远程 PowerShell 的弃用。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持以下常用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。