Get-ConnectionInformation

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Online

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

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

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Get-ConnectionInformation []
Get-ConnectionInformation
   -ConnectionId <String[]>
   [<CommonParameters>]
Get-ConnectionInformation
   -ModulePrefix <String[]>
   [<CommonParameters>]

説明

Get-ConnectionInformation コマンドレットは、現在の PowerShell インスタンスでExchange Onlineを使用するすべてのアクティブな REST ベースの接続に関する情報を返します。 このコマンドレットは、リモート PowerShell セッションで使用されるGet-PSSession コマンドレットと同じです。

例

例 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

注: このパラメーターは、モジュールのバージョン 3.2.0 以降で使用できます。

ConnectionId パラメーターは、ConnectionId によって接続をフィルター処理します。 ConnectionId は、複数の接続を開いている場合でも、接続を一意に識別するGet-ConnectionInformation コマンドレットの出力の GUID 値です。 複数の ConnectionId 値をコンマで区切って指定できます。

ModulePrefix パラメーターでは、このパラメーターを使用しないでください。

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ModulePrefix

注: このパラメーターは、モジュールのバージョン 3.2.0 以降で使用できます。

ModulePrefix パラメーターは、ModulePrefix によって接続をフィルター処理します。 Connect-ExchangeOnline コマンドレットで Prefix パラメーターを使用すると、指定したテキストがすべてのExchange Onlineコマンドレットの名前に追加されます (たとえば、Get-InboundConnectorは Get-ContosoInboundConnector になります)。 ModulePrefix 値は、Get-ConnectionInformation コマンドレットの出力に表示されます。 複数の ModulePrefix 値をコンマで区切って指定できます。

このパラメーターは、Prefix パラメーターを使用して作成された接続に対してのみ意味があります。

ConnectionId パラメーターでこのパラメーターを使用しないでください。

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False