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>]
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/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 參數,則不需要針對 MFA 或環境中的同盟使用者使用 AzureADAuthorizationEndpointUri 參數, (需要 UserPrincipalName 或 AzureADAuthorizationEndpointUri;可以同時使用這兩個) 。
注意:由 21Vianet 所運作的 Office 365 中無法使用 MFA 驗證或同盟驗證。
參數屬性
| 類型: | 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 參數搭配使用。
注意:只有 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 - 由 21Vianet 提供的 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 網域或租用戶識別碼。
只有當客戶組織已同意透過 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 參數會停用 WAM) (網頁帳戶管理員。 您不需要使用此參數指定值。
從版本 3.7.0 開始,WAM 預設會在連線到 Exchange Online 時啟用。 如果您在登入期間遇到 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 - 由 21Vianet 提供的 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
您必須將此參數與 Organization 參數搭配使用。
針對使用者指派的受控識別,您也必須使用此參數搭配 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
注意:此參數在模組版本 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。