Get-ServiceFabricApplicationType
指定されたフィルターに一致する 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 を一緒に指定することはできません。
型: | ApplicationTypeDefinitionKindFilter |
指定可能な値: | Default, ServiceFabricApplicationPackage, Compose, MeshApplicationDescription, All |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ApplicationTypeName
Service Fabric アプリケーションの種類の名前を指定します。 コマンドレットは、指定したアプリケーションの種類の名前のすべてのバージョンを取得します。
このパラメーターを指定しない場合、このコマンドレットはすべてのアプリケーションの種類を取得します。 このパラメーターは、プロビジョニング済みまたはプロビジョニング済みのすべてのアプリケーションの種類のアプリケーション マニフェストで定義されている、大文字と小文字が区別される正確なアプリケーションの種類名と一致します。 たとえば、値 "Test" が "TestApp" と一致しないのは、部分的な一致のみであるためです。 この値には、アプリケーションの種類のバージョンを含めず、同じアプリケーションの種類名のすべてのバージョンと一致する必要があります。
ApplicationTypeName と ApplicationTypeDefinitionKindFilter を一緒に指定することはできません。
型: | String |
配置: | 0 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ApplicationTypeVersion
Service Fabric アプリケーションの種類のバージョンを指定します。 コマンドレットは、指定されたアプリケーションの種類の名前とバージョンに一致するアプリケーションの種類を取得します。
ApplicationTypeName パラメーターも指定する場合にのみ、このパラメーターを指定します。 このパラメーターは、ApplicationTypeName フィルターの上にフィルターを実行します。 これは、プロビジョニングされたアプリケーションの種類またはプロビジョニング アプリケーションの種類のアプリケーション マニフェストで定義されている、大文字と小文字が区別される正確なアプリケーションの種類のバージョンと一致します。 たとえば、値 "Version" は部分一致のみであるため、"Version1" と一致しません。 この値には、アプリケーションの種類の名前を含めてはなりません。
型: | String |
配置: | 1 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ExcludeApplicationParameters
クエリ結果から既定のアプリケーション パラメーターを除外するかどうかを指定します。
設定した場合、既定のアプリケーション パラメーター フィールドは引き続き表示されますが、空です。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TimeoutSec
操作のタイムアウト期間を秒単位で指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-UsePaging
このクエリのページング バージョンを使用するかどうかを指定します。
このクエリのページが解除されている場合、返される結果の数は最大メッセージ サイズ構成によって制限されます。 指定されておらず、メッセージに収まらないアプリケーションの種類が多すぎる場合、クエリは失敗します。 結果はユーザーに返されません。 クエリがページングされている場合、結果はメッセージ サイズの制約のために削除されません。結果は、必要に応じてページに分割され、ループされるためです。 ページングはクエリによって内部的に実行され、追加の手順は必要ありません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
System.String
出力
System.Object