sfctl property
Service Fabric の名前でプロパティを格納およびクエリします。
コマンド
| command | 説明 |
|---|---|
| delete | 指定した Service Fabric プロパティを削除します。 |
| get | 指定した Service Fabric プロパティを取得します。 |
| list | 指定した名前の下にあるすべての Service Fabric プロパティに関する情報を取得します。 |
| put | Service Fabric プロパティを作成または更新します。 |
sfctl property delete
指定した Service Fabric プロパティを削除します。
指定した名前の下にある指定した Service Fabric プロパティを削除します。 プロパティを削除するには、その前にプロパティが作成されている必要があります。
引数
| Argument | 説明 |
|---|---|
| --name-id [必須] | "fabric:" URI スキームを除いた Service Fabric の名前。 |
| --property-name [必須] | 取得するプロパティの名前を指定します。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl property get
指定した Service Fabric プロパティを取得します。
指定した名前の下にある指定した Service Fabric プロパティを取得します。 メタデータと値の両方が常に返ります。
引数
| Argument | 説明 |
|---|---|
| --name-id [必須] | "fabric:" URI スキームを除いた Service Fabric の名前。 |
| --property-name [必須] | 取得するプロパティの名前を指定します。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl property list
指定した名前の下にあるすべての Service Fabric プロパティに関する情報を取得します。
Service Fabric 名には、カスタム情報を格納している 1 つまたは複数の名前付きプロパティを指定できます。 この操作は、これらのプロパティに関する情報をページ単位の一覧で取得します。 情報には、各プロパティに関する名前、値、メタデータが含まれます。
引数
| Argument | 説明 |
|---|---|
| --name-id [必須] | "fabric:" URI スキームを除いた Service Fabric の名前。 |
| --continuation-token | 継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。 |
| --include-values | 返されるプロパティの値を含めるかどうかを指定できます。 メタデータと共に値を返す場合は true、プロパティのメタデータのみを返す場合は false。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl property put
Service Fabric プロパティを作成または更新します。
指定した名前の下にある指定した Service Fabric プロパティを作成または更新します。
引数
| Argument | 説明 |
|---|---|
| --name-id [必須] | "fabric:" URI スキームを除いた Service Fabric の名前。 |
| --property-name [必須] | Service Fabric プロパティの名前。 |
| --value [必須] | Service Fabric プロパティの値を記述します。 これは、JSON 文字列です。 JSON 文字列には、データの "Kind" と、データの "Data" として入力される値の 2 つのフィールドがあります。 "Kind" の値は、JSON 文字列に出現する最初の項目でなければならず、指定できる値は "Binary"、"Int64"、"Double"、"String"、"Guid" です。 値は、特定の型にシリアル化可能である必要があります。 "Kind" と "Data" の値はどちらも、文字列として指定する必要があります。 |
| --custom-id-type | プロパティのカスタム型 ID。 このプロパティを使用して、ユーザーはプロパティの値の型にタグを付けることができます。 |
| --timeout -t | 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
次のステップ
- Service Fabric CLI をセットアップします。
- サンプル スクリプトを使用して、Service Fabric CLI の使用方法を学習します。