Get-ConnectionInformation

モジュール:
Exchange PowerShell

このコマンドレットは、Exchange Online PowerShell モジュール バージョン 3.0.0 以降でのみ使用できます。 詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。

Get-ConnectionInformation コマンドレットを使用して、Exchange Online で現在の PowerShell インスタンスのすべての REST ベースの接続に関する情報を取得します。

以下の構文セクションのパラメーター セットの詳細については、「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 や、Security & Compliance PowerShell の ExchangeOnlineProtection_1 などです。
  • UserPrincipalName: 接続に使用されたアカウント。 たとえば、「 laura@contoso.onmicrosoft.com 」のように入力します。
  • ConnectionUri: 使用された接続エンドポイント。 たとえば、Exchange Online PowerShell の https://outlook.office365.com や Security & Compliance PowerShell のhttps://nam12b.ps.compliance.protection.outlook.comなどです。
  • AzureAdAuthorizationEndpointUri: 接続の Microsoft Entra 承認エンドポイント。 たとえば、Exchange Online PowerShell の https://login.microsoftonline.com/organizations や Security & Compliance 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 コマンドレットでプレフィックス パラメーターを使用すると、指定されたテキストがすべての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」を参照してください。