Connect-IPPSSession
此 Cmdlet 僅適用於 Exchange Online PowerShell 模組。 如需詳細資訊,請參閱 關於 Exchange Online PowerShell 模組。
使用 Exchange Online PowerShell 模組中的 Connect-IPPSSession Cmdlet,使用新式驗證連線到安全性 & 合規性 PowerShell。 Cmdlet 適用於 MFA 或未啟用 MFA 的帳戶。
附註: 模組的 3.2.0 版或更新版本支援幾乎所有安全性 & 合規性 PowerShell Cmdlet 的 REST API 模式 (REST API 模式) 不需要本機電腦上 WinRM 中的基本驗證。 如需詳細資訊,請參閱 Exchange Online PowerShell 模組的必要條件。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
Default (預設值)
Connect-IPPSSession
[[-ConnectionUri] <String>]
[[-AzureADAuthorizationEndpointUri] <String>]
[[-DelegatedOrganization] <String>]
[[-PSSessionOption] <PSSessionOption>]
[[-Prefix] <String>]
[[-CommandName] <String[]>]
[[-FormatTypeName] <String[]>]
[-AccessToken <String>]
[-AppId <String>]
[-BypassMailboxAnchoring]
[-Certificate <X509Certificate2>]
[-CertificateFilePath <String>]
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-DisableWAM]
[-EnableErrorReporting]
[-EnableSearchOnlySession]
[-LogDirectoryPath <String>]
[-LogLevel <LogLevel>]
[-Organization <String>]
[-ShowBanner]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]
Description
如需詳細的連線指示,包括必要條件,請參閱 連線到安全性 & 合規性 PowerShell。
範例
範例 1
Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com
此範例會使用指定的帳戶和新式驗證連線到安全性 & 合規性 PowerShell,無論是否使用 MFA。 在模組的 v3.2.0 或更新版本中,我們會以 REST API 模式連線,因此本機電腦不需要 WinRM 中的基本驗證。
範例 2
Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession
此範例會使用指定的帳戶和新式驗證連線到安全性 & 合規性 PowerShell,無論是否使用 MFA。 在模組的 v3.2.0 或更新版本中,我們會以遠端 PowerShell 模式連線,因此本機電腦需要 WinRM 中的基本驗證。
範例 3
Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"
此範例會使用憑證指紋連線到自動腳本案例中的安全性 & 合規性 PowerShell。
範例 4
Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"
此範例會使用憑證檔案,在自動腳本案例中連線到安全性 & 合規性 PowerShell。 此方法最適合憑證儲存在遠端電腦中並在執行階段擷取的案例。 例如,憑證會儲存在 Azure 金鑰保存庫中。
參數
-AccessToken
適用:Exchange Online
附註:此參數在模組版本 3.8.0-Preview1 或更新版本中可用。
AccessToken 參數會指定用來連線到安全性與合規性 PowerShell 的 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
AzureADAuthorizationEndpointUri 參數會指定可發出 OAuth2 存取權杖的 Microsoft Entra 授權端點。 支援下列 PowerShell 環境和相關值:
- Microsoft 365 或 Microsoft 365 GCC 中的安全性 & 合規性 PowerShell:請勿使用此參數。 必要值是
https://login.microsoftonline.com/common,但這也是預設值,因此您不需要使用此參數。 - 安全性 & 合規性 PowerShell 在 21Vianet 所營運的Office 365中:
https://login.chinacloudapi.cn/common - Microsoft GCC High 或 Microsoft DoD 中的安全性 & 合規性 PowerShell:
https://login.microsoftonline.us/common
如果您使用 UserPrincipalName 參數,則不需要針對 MFA 或同盟使用者使用 AzureADAuthorizationEndpointUri 參數,這些參數通常需要 UserPrincipalName 或 AzureADAuthorizationEndpointUri (可以同時使用這兩種) 。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-BypassMailboxAnchoring
適用:Exchange Online
BypassMailboxAnchoring 參數會略過信箱錨定提示的使用。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | 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: | 5 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ConnectionUri
適用:Exchange Online
ConnectionUri 參數會指定 PowerShell 會話的連線端點。 支援下列 PowerShell 環境和相關值:
- Microsoft 365 或 Microsoft 365 GCC 中的安全性 & 合規性 PowerShell:請勿使用此參數。 必要值是
https://ps.compliance.protection.outlook.com/powershell-liveid/,但這也是預設值,因此您不需要使用此參數。 - 安全性 & 合規性 PowerShell 在 21Vianet 所營運的Office 365中:
https://ps.compliance.protection.partner.outlook.cn/powershell-liveid - Microsoft GCC High 中的安全性 & 合規性 PowerShell:
https://ps.compliance.protection.office365.us/powershell-liveid/ - Microsoft DoD 中的安全性 & 合規性 PowerShell:
https://l5.ps.compliance.protection.office365.us/powershell-liveid/
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Credential
適用:Exchange Online
Credential 參數會指定用來連線到 Exchange Online PowerShell 的使用者名稱和密碼。 通常您會在指令碼中使用此參數,或在您必須提供具有必要權限的其他認證時使用此參數。 請勿將此參數用於使用多重要素驗證 (MFA) 的帳戶。
在執行 Connect-IPPSSession 指令之前,請將使用者名稱和密碼儲存在變數 (中,例如) $UserCredential = Get-Credential 。 然後,使用此參數的變數名稱 ($UserCredential) 。
Connect-IPPSSession 命令完成後,變數中的密碼金鑰會清空。
參數屬性
| 類型: | PSCredential |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DelegatedOrganization
適用:Exchange Online
DelegatedOrganization 參數會指定您要管理 (的客戶組織,例如 contosoelectronics.onmicrosoft.com) 。 只有在客戶組織已同意透過 CSP 程式委派管理時,此參數才有效。
成功驗證之後,此工作階段中的 Cmdlet 會對應至客戶組織,而且此工作階段中的所有作業都會在客戶組織上完成。
附註:
- 請使用委派組織的主要 .onmicrosoft.com 網域作為此參數的值。
- 您必須搭配此參數使用 AzureADAuthorizationEndpointUri 參數。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 2 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DisableWAM
適用:Exchange Online
附註: 此參數在模組版本 3.7.2-Preview1 或更新版本中可用。
DisableWAM 開關會停用 Web Account Manager (WAM) 。 您不需要使用此參數指定值。
如果您在登入期間遇到 WAM 相關問題,您可以使用此參數來停用 WAM。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-EnableErrorReporting
適用:Exchange Online
附註: 此參數在模組版本 3.8.1-Preview1 或更新版本中可用。
EnableErrorReporting 參數會指定是否要啟用錯誤報告。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-EnableSearchOnlySession
適用:Exchange Online
附註:此參數在模組版本 3.9.0-Preview1 或更新版本中可用。
EnableSearchOnlySession 參數會指定是否要啟用特定電子檔探索和相關 Cmdlet,以連線到其他 Microsoft 365 服務。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-FormatTypeName
適用:Exchange Online
FormatTypeName 參數會指定 Cmdlet 的輸出格式。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 6 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-LogDirectoryPath
適用:Exchange Online
附註: 此參數在模組版本 3.8.1-Preview1 或更新版本中可用。
LogDirectoryPath 參數會指定記錄檔的位置。 預設位置是 %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv。
如果您指定的自訂位置和檔案名稱包含空格,請將值括在引號中 (“) 。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-LogLevel
適用:Exchange Online
附註: 此參數在模組版本 3.8.1-Preview1 或更新版本中可用。
LogLevel 參數會指定記錄層級。 有效值為 Default 和 All。
參數屬性
| 類型: | LogLevel |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Organization
適用:Exchange Online
組織參數指定使用 CBA 連線時的組織。 您必須使用組織的主要 .onmicrosoft.com 網域來取得此參數的值。
如需 CBA 的詳細資訊,請參閱 Exchange Online PowerShell 模組中自動腳本的僅限應用程式驗證。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Prefix
適用:Exchange Online
Prefix 參數會指定文字值,以在連線時新增至安全性 & 合規性 PowerShell Cmdlet 的名稱。 例如,當您對此參數使用值 Contoso 時,Get-ComplianceCase 會變成 Get-ContosoComplianceCase。
- 前置詞值不能包含空格或特殊字元,例如底線或星號。
- 您無法使用前置詞值 EXO。 該值會保留給模組內建的九個獨佔 Get-EXO* Cmdlet。
- Prefix 參數只會影響匯入的安全性 & 合規性 Cmdlet 名稱。 它不會影響模組內建的 Cmdlet 名稱 (例如 Disconnect-ExchangeOnline) 。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 4 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PSSessionOption
適用:Exchange Online
注意:此參數不適用於 REST API 連線。
PSSessionOption 參數會指定要在連線至安全性 & 合規性 PowerShell 時使用的遠端 PowerShell 工作階段選項。 只有在您同時在同一命令中使用 UseRPSSession 參數時,此參數才有效。
將 New-PSSessionOption 命令的輸出儲存在變數 (中,例如 $PSOptions = New-PSSessionOption <Settings>) ,並使用變數名稱作為此參數的值 (例如 $PSOptions) 。
參數屬性
| 類型: | PSSessionOption |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 3 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ShowBanner
適用:Exchange Online
附註:此參數在模組版本3.2.0或更新版本中可用。
ShowBanner 參數會顯示或隱藏執行 Connect-IPPSSession 時顯示的橫幅訊息。 您不需要使用此參數指定值。
- 若要顯示橫幅,您不需要使用此開關 (預設會顯示橫幅) 。
- 若要隱藏橫幅,請使用以下確切語法:
-ShowBanner:$false。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | 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.2.0-Preview3 或更新版本中可用。
附註: 與安全性 & 合規性 PowerShell 的遠端 PowerShell 連線已被取代。 如需詳細資訊,請參閱 安全性與合規性 PowerShell 中的取代遠端 PowerShell。
UseRPSSession 參數可讓您使用傳統遠端 PowerShell 存取所有 Cmdlet 來連線到安全性 & 合規性 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。