Get-ConnectionInformation
このコマンドレットは、Exchange Online PowerShell モジュール バージョン 3.0.0 以降でのみ使用できます。 詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。
Get-ConnectionInformation コマンドレットを使用して、現在の PowerShell インスタンス内のすべての REST ベースの接続に関する情報を取得し、Exchange Onlineします。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Get-ConnectionInformation
[<CommonParameters>]
ConnectionId
Get-ConnectionInformation
-ConnectionId <String[]>
[<CommonParameters>]
ModulePrefix
Get-ConnectionInformation
-ModulePrefix <String[]>
[<CommonParameters>]
説明
Get-ConnectionInformation コマンドレットは、現在の PowerShell インスタンスでExchange Onlineを使用するすべてのアクティブな REST ベースの接続に関する情報を返します。 このコマンドレットは、リモート PowerShell セッションで使用される Get-PSSession コマンドレットと同じです。
コマンドレットの出力には、次のプロパティが含まれています。
- ConnectionId: 接続の一意の GUID 値。 たとえば、8b632b3a-a2e2-8ff3-adcd-6d119d07694b です。
- 状態: たとえば、接続済み。
- Id: PowerShell ウィンドウでセッションを識別する整数。 最初の接続は 1、2 つ目は 2 などです。
- 名前: PowerShell 環境と Id 値に基づく一意の名前。 たとえば、Exchange Online PowerShell の場合は ExchangeOnline_1、セキュリティ & コンプライアンス PowerShell の場合は ExchangeOnlineProtection_1。
- UserPrincipalName: 接続に使用されたアカウント。 たとえば、「
laura@contoso.onmicrosoft.com」のように入力します。 - ConnectionUri: 使用された接続エンドポイント。 たとえば、Exchange Online PowerShell の場合は
https://outlook.office365.com、セキュリティ & コンプライアンス PowerShell の場合はhttps://nam12b.ps.compliance.protection.outlook.com。 - AzureAdAuthorizationEndpointUri : 接続のMicrosoft Entra承認エンドポイント。 たとえば、Exchange Online PowerShell の場合は
https://login.microsoftonline.com/organizations、セキュリティ & コンプライアンス PowerShell の場合はhttps://login.microsoftonline.com/organizations。 - TokenExpiryTimeUTC: 接続トークンの有効期限が切れるとき。 たとえば、2023 年 9 月 30 日午後 6:42:24 +00:00 です。
- CertificateAuthentication: 接続に証明書ベースの認証 (CBA またはアプリ専用認証とも呼ばれます) が使用されたかどうか。 値は True または False です。
- ModuleName: セッションの一時データのファイル名とパス。 たとえば、C:\Users\laura\AppData\Local\Temp\tmpEXO_a54z135k.qgv
- ModulePrefix: Connect-ExchangeOnline または Connect-IPPSSession コマンドで Prefix パラメーターを使用して指定した値。
- 組織: CBA またはマネージド ID 接続の Connect-ExchangeOnline または Connect-IPPSSession コマンドで Organization パラメーターを使用して指定された値。
- DelegatedOrganization: Connect-ExchangeOnline または Connect-IPPSSession コマンドで DelegatedOrganization パラメーターを使用して指定した値。
- AppId: CBA 接続の Connect-ExchangeOnline または Connect-IPPSSession コマンドで AppId パラメーターを使用して指定された値。
- PageSize: 接続内のページあたりのエントリの既定の最大数。 既定値は 1000 です。または、Connect-ExchangeOnline コマンドの PageSize パラメーターを使用して、小さい数値を指定できます。 個々のコマンドレットには、PageSize パラメーターも含まれます。
- TenantID: テナント ID GUID 値。 たとえば、3750b40b-a68b-4632-9fb3-5b1aff664079 です。
- TokenStatus: たとえば、アクティブです。
- ConnectionUsedForInbuiltCmdlets
- 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 コマンドレットの出力の GUID 値です。 複数の ConnectionId 値をコンマで区切って指定できます。
ModulePrefix パラメーターでは、このパラメーターを使用しないでください。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ConnectionId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ModulePrefix
適用対象: Exchange Online
注: このパラメーターは、モジュール バージョン 3.2.0-Preview2 以降で使用できます。
ModulePrefix パラメーターは、ModulePrefix によって接続をフィルター処理します。 Connect-ExchangeOnline コマンドレットで Prefix パラメーターを使用すると、指定したテキストがすべてのExchange Onlineコマンドレットの名前に追加されます (たとえば、Get-InboundConnector は Get-ContosoInboundConnector になります)。 ModulePrefix 値は、Get-ConnectionInformation コマンドレットの出力に表示されます。 複数の ModulePrefix 値をコンマで区切って指定できます。
このパラメーターは、Prefix パラメーターを使用して作成された接続に対してのみ意味があります。
ConnectionId パラメーターでこのパラメーターを使用しないでください。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ModulePrefix
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。