Get-ConnectionInformation
此 Cmdlet 僅適用於 Exchange Online PowerShell 模組 3.0.0 版或更新版本。 如需詳細資訊,請參閱 關於 Exchange Online PowerShell 模組。
使用 Get-ConnectionInformation Cmdlet 來取得目前 PowerShell 執行個體中所有 REST 型連線的相關資訊,並搭配 Exchange Online。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
Default (預設值)
Get-ConnectionInformation
[<CommonParameters>]
ConnectionId
Get-ConnectionInformation
-ConnectionId <String[]>
[<CommonParameters>]
ModulePrefix
Get-ConnectionInformation
-ModulePrefix <String[]>
[<CommonParameters>]
Description
Get-ConnectionInformation Cmdlet 會傳回目前 PowerShell 執行個體中所有作用中 REST 型連線Exchange Online相關資訊。 此 Cmdlet 相當於與遠端 PowerShell 工作階段搭配使用的 Get-PSSession Cmdlet。
Cmdlet 的輸出包含下列屬性:
- ConnectionId:連線的唯一 GUID 值。 例如,8b632b3a-a2e2-8ff3-adcd-6d119d07694b。
- 狀態:例如,已連線。
- 標識符:在 PowerShell 視窗中識別工作階段的整數。 第一個連接是 1,第二個連接是 2,依此類推。
- 名稱:以 PowerShell 環境和標識符值為基礎的唯一名稱。 例如,Exchange Online PowerShell 的ExchangeOnline_1或安全性 & 合規性 PowerShell 的ExchangeOnlineProtection_1。
- UserPrincipalName:用來連線的帳戶。 例如,
laura@contoso.onmicrosoft.com。 - ConnectionUri:使用的連線端點。 例如,
https://outlook.office365.com針對 Exchange Online PowerShell 或https://nam12b.ps.compliance.protection.outlook.com安全性 & 合規性 PowerShell。 - AzureAdAuthorizationEndpointUri :連線的 Microsoft Entra 授權端點。 例如,
https://login.microsoftonline.com/organizations針對 Exchange Online PowerShell 或https://login.microsoftonline.com/organizations安全性 & 合規性 PowerShell。 - TokenExpiryTimeUTC:連線權杖到期時。 例如,9/30/2023 6:42:24 PM +00:00。
- CertificateAuthentication:憑證型驗證 (也稱為 CBA 或僅限應用程式驗證) 是否用於連線。 值為 True 或 False。
- ModuleName:工作階段暫存資料的檔案名稱和路徑。 例如,C:\Users\laura\AppData\Local\Temp\tmpEXO_a54z135k.qgv
- ModulePrefix:在 Connect-ExchangeOnline 或 Connect-IPPSSession 指令中使用Prefix參數指定的值。
- 組織:使用 CBA 或受控識別連線的 Connect-ExchangeOnline 或 Connect-IPPSSession 命令中的 Organization 參數指定的值。
- DelegatedOrganization:在 Connect-ExchangeOnline 或 Connect-IPPSSession 命令中使用 DelegatedOrganization 參數指定的值。
- AppId:在 CBA 連線的 Connect-ExchangeOnline 或 Connect-IPPSSession 命令中使用 AppId 參數指定的值。
- PageSize:連線中每頁的預設項目數上限。 預設值為 1000,或者您可以使用 Connect-ExchangeOnline 命令中的 PageSize 參數來指定較低的數字。 個別 Cmdlet 也可能有 PageSize 參數。
- TenantID:租用戶識別碼 GUID 值。 例如,3750b40b-a68b-4632-9fb3-5b1aff664079。
- TokenStatus:例如,作用中。
- ConnectionUsedForInbuiltCmdlet
- IsEopSession:針對 Exchange Online PowerShell 連線,值為 False。 針對安全性 & 合規性 PowerShell 連線,值為 True。
範例
範例 1
Get-ConnectionInformation
此範例會傳回目前 PowerShell 執行個體中與 Exchange Online 的所有作用中 REST 型連線清單。
範例 2
Get-ConnectionInformation -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85
此範例會傳回具有指定 ConnectionId 值的作用中 REST 型連線。
範例 3
Get-ConnectionInformation -ModulePrefix Contoso,Fabrikam
此範例會傳回使用指定前置詞值的作用中 REST 型連線清單。
參數
-ConnectionId
適用:Exchange Online
附註:此參數在模組版本 3.2.0-Preview2 或更新版本中可用。
ConnectionId 參數會依 ConnectionId 篩選連線。 ConnectionId 是 Get-ConnectionInformation Cmdlet 輸出中的 GUID 值,可唯一識別連線,即使您已開啟多個連線也一樣。 您可以指定多個以逗點分隔的 ConnectionId 值。
請勿將此參數與 ModulePrefix 參數搭配使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ConnectionId
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ModulePrefix
適用:Exchange Online
附註:此參數在模組版本 3.2.0-Preview2 或更新版本中可用。
ModulePrefix 參數會依 ModulePrefix 篩選連線。 當您搭配 Connect-ExchangeOnline Cmdlet 使用 Prefix 參數時,指定的文字會新增至所有 Exchange Online Cmdlet 的名稱 (例如,Get-InboundConnector 會變成 Get-ContosoInboundConnector) 。 ModulePrefix 值會顯示在 Get-ConnectionInformation Cmdlet 的輸出中。 您可以指定多個以逗點分隔的 ModulePrefix 值。
此參數僅對使用 Prefix 參數建立的連線有意義。
請勿將此參數與 ConnectionId 參數搭配使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ModulePrefix
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。