Get-ServiceFabricDeployedApplication

モジュール:

ServiceFabric

指定したノード上の Service Fabric アプリケーションを取得します。

構文

Get-ServiceFabricDeployedApplication
   [-NodeName] <String>
   [[-ApplicationName] <Uri>]
   [-UsePaging]
   [-GetSinglePage]
   [-IncludeHealthState]
   [-MaxResults <Int64>]
   [-ContinuationToken <String>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Get-ServiceFabricDeployedApplication
   [-NodeName] <String>
   [[-ApplicationName] <Uri>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

説明

Get-ServiceFabricDeployedApplication コマンドレットは、指定されたノードにデプロイされた Service Fabric アプリケーションを取得します。

Service Fabric は、デプロイされた各アプリケーションのノードに作業、ログ、および一時ディレクトリを作成します。 ディレクトリ名にはアプリケーション ID が含まれているため、ディレクトリ名を推測することはできません。 DeployedApplicationStatus がアクティブな場合、Get-ServiceFabricDeployedApplication は WorkDirectory、LogDirectory、TempDirectory の戻り値のディレクトリ名を返します。 DeployedApplicationStatus がダウンロード中の場合、WorkDirectory、LogDirectory、TempDirectory の値は null になります。

デプロイされたアプリケーション サービスは、保存されたデータを WorkDirectory に格納します。 デバッグまたは診断の目的で、別のアプリケーションまたはプロセスで WorkDirectory の場所を知る必要がある場合があります。

デプロイされたアプリケーション サービスは、Service Fabric によって作成された LogDirectory にログを格納する必要があります。 ログ ファイルのカスタム アップローダーは、場所を知る必要がある場合があります。 LogDirectory の場所は、特定のノード上のアプリケーションが期待どおりに動作していない場合にも、診断目的で必要になる場合があります。

既定では、このクエリでは、メッセージ サイズの最大構成に制限された結果が多数返されます。 SDK およびクラスター バージョン 6.1 以降では、この制限を削除するページング機能がサポートされています。新しい動作では、最大メッセージ サイズ構成に関係なく結果が返されます。このクエリは、返されたすべてのページを透過的にループするためです。 ページングやその他の新機能を使用するには、パラメーター セット "UsePagedAPI" を参照してください。 新しいフィルターを選択すると、内部でページングを使用するようにクエリに通知されます。 それ以外の場合は、[UsePaging] を選択して、ページングされたクエリをオプトインします。

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

例

例 1: アプリケーション "fabric:/samples/CalcApp2" を取得する

PS C:\> Get-ServiceFabricDeployedApplication -NodeName "VIPULM4-RK01-BD01" -ApplicationName fabric:/samples/CalcApp2

ApplicationName           : fabric:/samples/CalcApp2
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\work
LogDirectory              : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\log
TempDirectory             : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\temp
HealthState               : Unknown

このコマンドは、デプロイされたアプリケーションを返します。 この例では、 DeployedApplicationStatus がアクティブであるため、 Get-ServiceFabricDeployedApplication は WorkDirectory、 LogDirectory、 TempDirectory の戻り値のディレクトリ名を返します。

例 2: アプリケーション "fabric:/samples/VQueueApp2" を取得する

PS C:\> Get-ServiceFabricDeployedApplication -NodeName VIPULM4-RK01-BD01 fabric:/samples/VQueueApp2

ApplicationName           : fabric:/samples/VQueueApp2
ApplicationTypeName       : VolatileQueueApp
DeployedApplicationStatus : Downloading
HealthState               : Unknown

このコマンドは、デプロイされたアプリケーションを返します。 この例では、 DeployedApplicationStatus がダウンロード中であるため、 コマンドは WorkDirectory、 LogDirectory、 TempDirectory に null の値を返します。

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

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -MaxResults 2 -GetSinglePage -Verbose

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\temp
HealthState               : Unknown

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\temp
HealthState               : Unknown

VERBOSE: Continuation Token: fabric:/samples/PQueueApp1

このコマンドは、ページに収まるクラスター内の指定されたノードにデプロイされたすべての Service Fabric アプリケーションを取得します。 ページのサイズは、MaxResults パラメーターによって構成された 2 つの項目にさらに制限されます。 "GetSinglePage" オプションを選択したため、このクエリは 1 ページの結果のみを返します。 MaxResults は、このオプションなしでは使用できません。 "Verbose" を選択すると、返された継続トークン値が出力されます。 この値は、後続のクエリで結果の次のページを取得するために使用できます。 返された結果を保存し、"ContinuationToken" プロパティにアクセスすることで、返された継続トークンにアクセスすることもできます。 "ContinuationToken" プロパティが null の場合、継続トークンが返されません。

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

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -ContinuationToken fabric:/samples/PQueueApp1 -UsePaging

ApplicationName           : fabric:/samples/VQueueApp1
ApplicationTypeName       : VolatileQueueApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\temp
HealthState               : Unknown

このコマンドは、指定された継続トークンを 1 つのページに収める Service Fabric アプリケーションを取得します。 このクエリに提供される継続トークンは、上記の例から返されたものと同じです。 このクラスターの例では、継続トークンを考慮する項目は 1 つだけです。 ノードで指定された継続トークンを考慮して結果の 1 ページに収まらないアプリケーションが多すぎる場合、このクエリ構成は返されたすべてのページのコンパイルを返し、それらを透過的にループします。その後、クエリはすべての結果のベクトルを返します。 結果のページを 1 ページだけ取得するには、[GetSinglePage] オプションを選択します。

例 5: 正常性状態のアプリケーションを取得する

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -ApplicationName fabric:/samples/CalculatorApp -IncludeHealthState

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\temp
HealthState               : Ok

このコマンドは、指定されたアプリケーション名と一致し、その正常性状態を含む Service Fabric アプリケーションを取得します。

パラメーター

-ApplicationName

Service Fabric アプリケーションの Uniform Resource Identifier (URI) を指定します。 コマンドレットは、指定したアプリケーション名と一致するデプロイ済みアプリケーションを取得します。 このクエリは完全に一致します。 たとえば、URI fabric:/App は fabric:/App1 と一致しません。 アプリケーション名が指定されている場合は、最大で 1 つの結果が返されます。 指定されたアプリケーション名がノード上のアプリケーションと一致しない場合、クエリは null を返します。

Type:	Uri
Position:	1
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

-GetSinglePage

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

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

-IncludeHealthState

クエリがデプロイされたアプリケーションの正常性状態を返すかどうかを指定します。このパラメーターを指定しない場合、返される正常性状態は "Unknown" になります。 選択すると、結果がマージされる前に、クエリはノードと正常性システム サービスと並行して実行されます。 その結果、クエリはコストが高くなり、長い時間がかかる場合があります。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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

-NodeName

Service Fabric ノードの名前を指定します。 コマンドレットは、指定したノードにデプロイされたアプリケーションを取得します。

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

-TimeoutSec

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

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

-UsePaging

クエリをページングするかどうかを指定します。 選択されていない場合、最大メッセージ サイズ構成で定義されているように、1 つのページに収まらない結果が多すぎる場合、このクエリは機能しません。 このオプションを選択すると、メッセージ サイズの最大構成に関係なく、すべての結果を返すようにこのクエリが構成されます。 これを行うには、ページングされた結果を取得し、呼び出し元の代わりにすべてのページを透過的にループします。

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

入力

System.String

System.Uri

出力

System.Object

関連リンク

• Connect-ServiceFabricCluster
• Get-ServiceFabricClusterConnection
• Get-ServiceFabricApplication