Get-ServiceFabricApplicationType

  • リファレンス
モジュール:
ServiceFabric

指定されたフィルターに一致する Service Fabric クラスターに登録されている Service Fabric アプリケーションの種類を取得します。

構文

Get-ServiceFabricApplicationType
   [[-ApplicationTypeName] <String>]
   [[-ApplicationTypeVersion] <String>]
   [-ApplicationTypeDefinitionKindFilter <ApplicationTypeDefinitionKindFilter>]
   [-ExcludeApplicationParameters]
   [-UsePaging]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]
Get-ServiceFabricApplicationType
   [[-ApplicationTypeName] <String>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

説明

Get-ServiceFabricApplicationType コマンドレットは、指定されたフィルターに一致する Service Fabric クラスターに登録または登録されている Service Fabric アプリケーションの種類を取得します。 アプリケーションの種類の各バージョンは、結果配列の個々の結果として返されます。 指定されたパラメーターと一致するアプリケーションの種類が見つからない場合、このクエリは何も返しません。

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

例

例 1: 登録または登録されているすべてのアプリケーションの種類を取得する

PS C:\> Get-ServiceFabricApplicationType

このコマンドは、登録されているすべてのアプリケーションの種類を取得します。

例 2: 指定した型名でアプリケーションの種類を登録または登録する

PS C:\> # Scenario: multiple application types are provisioned in the cluster, including TestApp versions 1 and 2, as well as TestApp2 version 1.
PS C:\> Get-ServiceFabricApplicationType -ApplicationTypeName "TestApp"

このコマンドは、アプリケーションの種類 "TestApp" のすべてのバージョンを取得します。 アプリケーションの種類名が完全に一致しないため、アプリケーションの種類 "TestApp2" は取得されません。

例 3: 既定のアプリケーション パラメーターを使用せずに、登録または登録されているすべてのアプリケーションの種類を取得する

PS C:\>Get-ServiceFabricApplicationType -ExcludeApplicationParameters

このコマンドは、登録されているすべてのアプリケーションの種類を取得します。 返される System.Fabric.Query.ApplicationType オブジェクトには、アプリケーションの種類に既定のアプリケーション パラメーターがあるかどうかに関係なく、未設定の DefaultParameters プロパティがあります。

例 4: すべての登録済みまたは登録済みのアプリケーションの種類をページングで取得し、その後パイプ処理を行う

PS C:\> Get-ServiceFabricApplicationType -UsePaging | Get-ServiceFabricApplicationManifest

このコマンドは、ページングを使用して、登録または登録されているすべてのアプリケーションの種類を取得します。 つまり、メッセージが 1 つのメッセージに収まらない場合、メッセージはドロップされません。このメッセージのサイズは、最大メッセージサイズ構成によって決まります。 ページングは、クエリによってバックグラウンドで実行されます。 配管やその他の機能は変更されません。

パラメーター

-ApplicationTypeDefinitionKindFilter

アプリケーションの種類の定義方法に基づいて ApplicationTypeDefinitionKindFilter のフィルターを指定します。 値は、 ApplicationTypeDefinitionKindFilter のメンバーに対するメンバーまたはビットごとの操作から取得できます。 フィルターに一致するアプリケーションの種類のみが返されます。 ApplicationTypeName と ApplicationTypeDefinitionKindFilter を一緒に指定することはできません。

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

-ApplicationTypeName

Service Fabric アプリケーションの種類の名前を指定します。 コマンドレットは、指定したアプリケーションの種類名のすべてのバージョンを取得します。

このパラメーターを指定しない場合、このコマンドレットはすべてのアプリケーションの種類を取得します。 このパラメーターは、すべてのプロビジョニング済みアプリケーションまたはプロビジョニング アプリケーションの種類のアプリケーション マニフェストで定義されている、大文字と小文字が区別される正確なアプリケーションの種類名と一致します。 たとえば、"Test" という値は部分一致であるため、"TestApp" と一致しません。 この値には、アプリケーションの種類のバージョンを含めず、同じアプリケーションの種類名のすべてのバージョンと一致します。

ApplicationTypeName と ApplicationTypeDefinitionKindFilter を一緒に指定することはできません。

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

-ApplicationTypeVersion

Service Fabric アプリケーションの種類のバージョンを指定します。 コマンドレットは、指定したアプリケーションの種類の名前とバージョンに一致するアプリケーションの種類を取得します。

ApplicationTypeName パラメーターも指定する場合にのみ、このパラメーターを指定します。 このパラメーターは、ApplicationTypeName フィルターの上にフィルターを実行します。 これは、プロビジョニング済みアプリケーションまたはプロビジョニング アプリケーションの種類のアプリケーション マニフェストで定義されている、大文字と小文字が区別される正確なアプリケーションの種類のバージョンと一致します。 たとえば、値 "Version" は部分的に一致するだけなので、"Version1" と一致しません。 この値には、アプリケーションの種類の名前を含めてはなりません。

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

-ExcludeApplicationParameters

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

設定した場合、既定のアプリケーション パラメーター フィールドは引き続き表示されますが、空です。

Type:SwitchParameter
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

-UsePaging

このクエリのページバージョンを使用するかどうかを指定します。

このクエリのページが解除されている場合、返される結果の数は最大メッセージ サイズ構成によって制限されます。 指定されておらず、メッセージに収まらないアプリケーションの種類が多すぎる場合、クエリは失敗します。 結果はユーザーに返されません。 クエリがページングされている場合、結果はメッセージ サイズの違反により削除されません。結果は必要に応じてページに分割され、ループ処理されるためです。 ページングはクエリによって内部的に実行され、追加の手順は必要ありません。

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

入力

System.String

出力

System.Object