Get-ServiceFabricApplication

モジュール:

ServiceFabric

Service Fabric クラスター上のアプリケーションを取得します。

構文

Get-ServiceFabricApplication
   [[-ApplicationName] <Uri>]
   [-ApplicationTypeName <String>]
   [-ExcludeApplicationParameters]
   [-ContinuationToken <String>]
   [-ApplicationDefinitionKindFilter <ApplicationDefinitionKindFilter>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Get-ServiceFabricApplication
   [[-ApplicationName] <Uri>]
   [-ApplicationTypeName <String>]
   [-ExcludeApplicationParameters]
   [-GetSinglePage]
   [-ContinuationToken <String>]
   [-MaxResults <Int64>]
   [-ApplicationDefinitionKindFilter <ApplicationDefinitionKindFilter>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

説明

Get-ServiceFabricApplication コマンドレットは、Service Fabric クラスター上のアプリケーションを取得します。 既定では、メッセージ サイズの最大構成に関係なく、このクエリで返すことができるクエリ結果の数に制限はありません。これはページクエリですが、REST または C# の同等の呼び出しとは異なり、このクエリの既定の動作は、返されたすべてのページを透過的にループすることです。 GetSinglePage オプションは、1 つのページを返すようにこのクエリを構成します。

Service Fabric クラスターで操作を実行する前に、 Connect-ServiceFabricCluster コマンドレットを使用してクラスターへの接続を確立します。

例

例 1: すべてのアプリケーションを取得する

PS C:\> Get-ServiceFabricApplication

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

ApplicationName           : fabric:/samples/CalculatorAppWithAppParameters
ApplicationTypeName       : CalculatorApp
ApplicationTypeVersion    : 2.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : { "ServiceInstanceCount" = "4" }

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

ApplicationName           : fabric:/VQueueApp1
ApplicationTypeName       : Compose_0
ApplicationTypeVersion    : v0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters     : {}

このコマンドは、クラスター内のすべてのアプリケーションを取得します。

例 2: 名前でアプリケーションを取得する

PS C:\> Get-ServiceFabricApplication -ApplicationName fabric:/samples/PQueueApp1

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

このコマンドは、fabric:/samples/PQueueApp1 という名前の特定のアプリケーションを取得します。

例 3: 型名でアプリケーションを取得する

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

このコマンドは、型名が PersistentQueueApp である Service Fabric アプリケーションを取得します。

例 4: 定義の種類でアプリケーションを取得する

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

ApplicationName           : fabric:/VQueueApp1
ApplicationTypeName       : Compose_0
ApplicationTypeVersion    : v0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters     : {}

このコマンドは、Service Fabric アプリケーションの説明で定義されている Service Fabric アプリケーションを取得します。

例 5: 最大結果でアプリケーションを取得する

PS C:\>Get-ServiceFabricApplication -MaxResults 2 -GetSinglePage -Verbose

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

ApplicationName           : fabric:/samples/CalculatorAppWithAppParameters
ApplicationTypeName       : CalculatorApp
ApplicationTypeVersion    : 2.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : "ServiceInstanceCount" = "4"
                            

VERBOSE: Continuation Token: fabric:/samples/CalculatorAppWithAppParameters

このコマンドは、ページに収まるクラスター内のすべての Service Fabric アプリケーションを取得します。 クラスターにはさらに多くのアプリケーションがありますが、MaxResults パラメーターによって構成された結果は 2 つだけ返されます。 ページに収まらない結果があるため、後続のページの存在を示す継続トークン値が返されます。

例 6: 継続トークンを使用してアプリケーションを取得する

PS C:\>Get-ServiceFabricApplication -ContinuationToken fabric:/samples/CalculatorAppWithAppParameters -GetSinglePage -Verbose

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

ApplicationName           : fabric:/VQueueApp1
ApplicationTypeName       : Compose_0
ApplicationTypeVersion    : v0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters     : {}

VERBOSE: Continuation Token:

このコマンドは、指定された継続トークンを 1 つのページに収める Service Fabric アプリケーションを取得します。 このクエリに提供される継続トークンは、上記の例から返されたものと同じです。 "Verbose" オプションは継続トークンを表示せず、使用可能なページがこれ以上ないことを示します。

例 7: アプリケーション パラメーターを除外するときに名前でアプリケーションを取得する

PS C:\>Get-ServiceFabricApplication -ApplicationName fabric:/samples/CalculatorAppWithAppParameters -ExcludeApplicationParameters

ApplicationName           : fabric:/samples/CalculatorAppWithAppParameters
ApplicationTypeName       : CalculatorApp
ApplicationTypeVersion    : 2.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

このコマンドは、指定されたアプリケーション名と一致する Service Fabric アプリケーションを取得します。 例 5 からわかるように、このアプリケーションにはアプリケーション パラメーターがありますが、"ExcludeApplicationParameters" フラグが原因で、返される結果から除外されます

パラメーター

-ApplicationDefinitionKindFilter

アプリケーションの定義方法に基づいて ApplicationDefinitionKindFilter のフィルターを指定します。 値は、 ApplicationDefinitionKindFilter のメンバーに対するメンバーまたはビットごとの操作から取得できます。 フィルターに一致するアプリケーションのみが返されます。 ApplicationName、ApplicationTypeName、または ApplicationDefinitionKindFilter の最大 1 つを指定できます。 フィルターが指定されていない場合は、すべてのアプリケーションが返されます。

Type:	ApplicationDefinitionKindFilter
Accepted values:	Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ApplicationName

Service Fabric アプリケーションの Uniform Resource Identifier (URI) を指定します。 コマンドレットは、指定された URI を持つアプリケーションを取得します。 ApplicationName、ApplicationTypeName、または ApplicationDefinitionKindFilter の最大 1 つを指定できます。 フィルターが指定されていない場合は、すべてのアプリケーションが返されます。

Type:	Uri
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ApplicationTypeName

クエリ対象のアプリケーションをフィルター処理するために使用するアプリケーションの種類名を指定します。 ApplicationName、ApplicationTypeName、または ApplicationDefinitionKindFilter の最大 1 つを指定できます。 フィルターが指定されていない場合は、すべてのアプリケーションが返されます。

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

-ContinuationToken

クエリ結果の次のページを取得するために使用できる継続トークンを指定します。

指定されたフィルターを考慮する結果が多すぎると、1 つのメッセージに収まらない可能性があります。 ページングは、返された結果のコレクションを別のページに分割することによって、これを考慮するために使用されます。 継続トークンは、前のページがどこに残っているかを知るために使用され、クエリ自体にのみ意味があります。 この値は、このクエリの実行から生成する必要があり、後続のページを取得するために次のクエリ要求に渡すことができます。 null 以外の継続トークン値は、後続のページがある場合にのみ、結果の一部として返されます。 この値が -GetSinglePage オプションなしで指定されている場合、クエリは継続トークン値から始まるすべてのページを返します。

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

-ExcludeApplicationParameters

アプリケーション パラメーターを結果から除外するかどうかを指定します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GetSinglePage

クエリが継続トークン値を持つクエリ結果の 1 ページを返すか、すべてのページを 1 つの結果リストに結合するかを指定します。 このオプションが選択されている場合は、クエリの呼び出し元が後続のページを確認する必要があります。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxResults

ページごとに返すことができる結果項目の最大数を指定します。 これにより、返される結果の数の上限が定義され、最小値は定義されません。 たとえば、構成で定義されている最大メッセージ サイズ制限に従ってページが返される項目が最大 1,000 個に収まり、MaxResults の値が 2000 に設定されている場合、2000 個の結果項目がクエリの説明と一致する場合でも、1,000 件の結果のみが返されます。 この値には、GetSinglePage フラグを選択する必要があります。それ以外の場合は無視されます。

Type:	Int64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeoutSec

操作のタイムアウト期間を秒単位で指定します。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

System.Uri

System.String

出力

System.Object

関連リンク

• Connect-ServiceFabricCluster
• Get-ServiceFabricClusterConnection
• New-ServiceFabricApplication
• Remove-ServiceFabricApplication