Connect-ExchangeOnline
此 Cmdlet 僅適用於 Exchange Online PowerShell 模組。 如需詳細資訊,請參閱 關於 Exchange Online PowerShell 模組。
使用 Exchange Online PowerShell 模組中的 Connect-ExchangeOnline Cmdlet,使用新式驗證連線到Exchange Online PowerShell 或Exchange Online Protection PowerShell,以取得內部部署電子郵件環境的雲端保護。 此 Cmdlet 適用於具有或不具有多重要素驗證 (MFA) 的帳戶。
若要連線到安全性 & 合規性 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>]
Description
此 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
在使用 2.0.4 版或更新版本模組的 PowerShell 7.0.3 或更新版本中,此範例會在沒有網頁瀏覽器的電腦上的互動式腳本案例中連線到 Exchange Online PowerShell。
命令會傳回與工作階段綁定的 URL 和唯一代碼。 您需要在任何電腦上的瀏覽器中開啟該 URL,然後輸入唯一代碼。 在網頁瀏覽器中完成登入之後,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) 之服務主體的應用程式識別碼。 有效值是應用程式識別碼 (服務主體) 的 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/common,但這也是預設值,因此您不需要使用此參數。 - Office 365 德國:
https://login.microsoftonline.de/common - Microsoft 365 GCC High 或 Microsoft 365 DoD:
https://login.microsoftonline.us/common
如果您使用 UserPrincipalName 參數,則不需要針對 MFA 或同盟使用者使用 AzureADAuthorizationEndpointUri 參數,這些參數通常需要 UserPrincipalName 或 AzureADAuthorizationEndpointUri (可以同時使用這兩種) 。
注意: MFA 驗證或同盟驗證無法在 21Vianet 營運的 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
Certificate 參數會指定用於憑證型驗證 (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
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 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-CertificateThumbprint
適用:Exchange Online
CertificateThumbprint 參數會指定用於 CBA 的憑證。 有效值是憑證的指紋值。 例如,83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1。
請勿將此參數與 Certificate 或 CertificateFilePath 參數搭配使用。
附註: CertificateThumbprint 參數僅在 Microsoft Windows 中受支援。
如需 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 德國:
https://outlook.office.de/PowerShell-LiveID - 由 21Vianet 營運的 Office 365:
https://partner.outlook.cn/PowerShell - Microsoft 365 GCC 高:
https://outlook.office365.us/powershell-liveID - Microsoft 365 國防部:
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 網域或租用戶識別碼。
只有在客戶組織已同意透過 CSP 程式委派管理時,此參數才有效。
成功驗證之後,此工作階段中的 Cmdlet 會對應至客戶組織,而且此工作階段中的所有作業都會在客戶組織上完成。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | 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 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DisableWAM
適用:Exchange Online
附註: 此參數在模組版本 3.7.2-Preview1 或更新版本中可用。
DisableWAM 開關會停用 Web Account Manager (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 德國:
O365GermanyCloud - 由 21Vianet 營運的 Office 365:
O365China - Microsoft 365 GCC 高:
O365USGovGCCHigh - Microsoft 365 國防部:
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模組的暫存副本儲存在用戶端本端,以進行階段作業連線。 依預設,模組的暫存複本會儲存在預設情況下 C:\Users\<UserName>\AppData\Local\Temp 的 %TMP% 資料夾 () 。
參數屬性
| 類型: | 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 參數會指定記錄層級。 有效值為 Default 和 All。
參數屬性
| 類型: | 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 參數會指定您用來連線的使用者指派受控識別。 此參數的有效值是服務主體的應用程式識別碼 (GUID) ,對應至 Azure 中使用者指派的受控識別。
您必須將此參數與 Organization 參數和 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。 該值會保留給模組內建的九個獨佔 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 參數,則不需要針對 MFA 或同盟使用者使用 AzureADAuthorizationEndpointUri 參數,這些參數通常需要 UserPrincipalName 或 AzureADAuthorizationEndpointUri (可以同時使用這兩種) 。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UseRPSSession
適用:Exchange Online
附註: 與 Exchange Online PowerShell 的遠端 PowerShell 連線已被取代。 如需詳細資訊,請參閱 取代 Exchange Online 中遠端 PowerShell。
UseRPSSession 參數可讓您使用傳統遠端 PowerShell 存取所有 Cmdlet 來連線到 Exchange Online PowerShell。 您不需要使用此參數指定值。
如果您不使用此參數,則會使用 REST API 模式進行連線,因此不需要 WinRM 中的基本驗證。
參數屬性
| 類型: | 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。