sfctl application
アプリケーションおよびアプリケーションの種類を作成、削除、および管理します。
コマンド
| command | 説明 |
|---|---|
| create | 指定された説明を使用して、Service Fabric アプリケーションを作成します。 |
| delete | 既存の Service Fabric アプリケーションを削除します。 |
| deployed | Service Fabric ノードにデプロイされたアプリケーションに関する情報を取得します。 |
| deployed-health | Service Fabric ノードにデプロイされたアプリケーションの正常性に関する情報を取得します。 |
| deployed-list | Service Fabric ノードにデプロイされたアプリケーションの一覧を取得します。 |
| health | Service Fabric アプリケーションの正常性を取得します。 |
| info | Service Fabric アプリケーションの情報を取得します。 |
| list | Service Fabric クラスター内に作成されているアプリケーションのうち、指定したフィルターに一致するものの一覧を取得します。 |
| load | Service Fabric アプリケーションの負荷情報を取得します。 |
| manifest | アプリケーションの種類を記述するマニフェストを取得します。 |
| provision | 外部ストアの ".sfpkg" パッケージまたはイメージ ストアのアプリケーション パッケージを使って、Service Fabric アプリケーションの種類をプロビジョニングするか、クラスターに登録します。 |
| report-health | Service Fabric アプリケーションの正常性レポートを送信します。 |
| type | 指定した名前と完全に一致する Service Fabric クラスター内のアプリケーションの種類の一覧を取得します。 |
| type-list | Service Fabric クラスター内のアプリケーションの種類の一覧を取得します。 |
| unprovision | Service Fabric アプリケーションの種類をクラスターから削除または登録解除します。 |
| upgrade | Service Fabric クラスターで、アプリケーションのアップグレードを開始します。 |
| upgrade-resume | Service Fabric クラスターで、アプリケーションのアップグレードを再開します。 |
| upgrade-rollback | Service Fabric クラスター内で現在進行中のアプリケーションのアップグレードのロールバックを開始します。 |
| upgrade-status | このアプリケーションで実行された最新のアップグレードの詳細を取得します。 |
| upload | Service Fabric アプリケーション パッケージをイメージ ストアにコピーします。 |
sfctl application create
指定された説明を使用して、Service Fabric アプリケーションを作成します。
引数
| Argument | 説明 |
|---|---|
| --app-name [必須] | 'fabric:' URI スキームを含むアプリケーションの名前。 |
| --app-type [必須] | アプリケーション マニフェストで検出されたアプリケーションの種類名。 |
| --app-version [必須] | アプリケーション マニフェストで定義されているアプリケーションの種類のバージョンです。 |
| --max-node-count | Service Fabric がこのアプリケーション用に容量を予約するノードの最大数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 |
| --metrics | アプリケーションの容量のメトリックの説明の JSON でエンコードされた一覧。 メトリックは名前として定義され、アプリケーションが存在する各ノードの一連の容量に関連付けられます。 |
| --min-node-count | Service Fabric がこのアプリケーション用に容量を予約するノードの最小数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 |
| --parameters | アプリケーションの作成時に適用される、アプリケーション パラメーター オーバーライドの JSON でエンコードされた一覧。 |
| --timeout -t | 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application delete
既存の Service Fabric アプリケーションを削除します。
アプリケーションを削除するには、その前にアプリケーションが作成されている必要があります。 アプリケーションを削除すると、そのアプリケーションの一部となっているすべてのサービスが削除されます。 既定では Service Fabric は、安全な方法でサービスのレプリカを閉じてからサービスを削除しようとします。 ただし、サービスにレプリカを正常に終了できない問題がある場合は、削除操作に時間がかかったり、スタックしたりする場合があります。 正常に閉じるシーケンスをスキップし、アプリケーションとそのすべてのサービスを強制的に削除するには、省略可能な ForceRemove フラグを使用します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --force-remove | 正常なシャットダウン シーケンスを経由せずに、Service Fabric アプリケーションまたはサービスを強制的に削除します。 このパラメーターを使用すると、レプリカの正常な終了を妨げるサービス コードの問題によって削除がタイムアウトしたアプリケーションまたはサービスを強制的に削除することができます。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application deployed
Service Fabric ノードにデプロイされたアプリケーションに関する情報を取得します。
指定されたアプリケーション ID がシステム アプリケーションのものである場合、このクエリはシステム アプリケーションの情報を返します。 結果には、アクティブ、アクティブ化中、およびダウンロード中の状態の展開済みアプリケーションが含まれます。 このクエリでは、ノード名がクラスター上のノードに対応している必要があります。 指定されたノード名がクラスター上のアクティブな Service Fabric ノードを示していない場合、クエリは失敗します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --node-name [必須] | ノード名。 |
| --include-health-state | エンティティの正常性の状態を含めます。 このパラメーターが false の場合、または指定されていない場合は、返される正常性状態は "Unknown" です。 true に設定すると、結果がマージされる前に、クエリはノードと正常性システム サービスに並列で渡されます。 その結果、クエリはコストが高くなり、長い時間がかかる場合があります。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application deployed-health
Service Fabric ノードにデプロイされたアプリケーションの正常性に関する情報を取得します。
Service Fabric ノードにデプロイされたアプリケーションの正常性に関する情報を取得します。 EventsHealthStateFilter を使用すると、必要に応じて、正常性の状態に基づき、デプロイされたアプリケーションで報告された HealthEvent オブジェクトのコレクションをフィルター処理できます。 正常性状態に基づいて DeployedServicePackageHealth の子で必要に応じてフィルター処理するには、DeployedServicePackagesHealthStateFilter を使用します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --node-name [必須] | ノード名。 |
| --deployed-service-packages-health-state-filter | 正常性の状態に基づくデプロイされたアプリケーションの正常性クエリの結果で返されるデプロイされたサービス パッケージの正常性の状態オブジェクトをフィルター処理できます。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するデプロイされたサービス パッケージのみが返されます。 すべてのデプロイされたサービス パッケージは、デプロイされたアプリケーションの集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 "OR" を使用して取得したこれらの値の組み合わせが可能です。 たとえば、指定した値が 6 の場合、HealthState の値が OK (2) と Warning (4) のサービス パッケージの正常性の状態が返されます。 - Default - 既定値。 任意の HealthState と一致します。 値は 0 です。 - None - どの HealthState 値とも一致しないフィルター。 状態の特定のコレクションの結果が返されないようにするために使用されます。 値は 1 です。 - Ok - HealthState 値が Ok の入力に一致するフィルター。 値は 2 です。 - Warning - HealthState 値が Warning の入力に一致するフィルター。 値は 4 です。 - Error - HealthState 値が Error の入力に一致するフィルター。 値は 8 です。 - All - 任意の HealthState 値の入力に一致するフィルター。 値は 65535 です。 |
| --events-health-state-filter | 正常性の状態に基づいて返された HealthEvent オブジェクトのコレクションをフィルター処理できます。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するイベントのみが返されます。 すべてのイベントが集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 'OR' を使用して取得したこれらの値の組み合わせが可能です。 たとえば、指定した値が 6 の場合、HealthState の値が OK (2) と Warning (4) のすべてのイベントが返されます。 - Default - 既定値。 任意の HealthState と一致します。 値は 0 です。 - None - どの HealthState 値とも一致しないフィルター。 状態の特定のコレクションの結果が返されないようにするために使用されます。 値は 1 です。 - Ok - HealthState 値が Ok の入力に一致するフィルター。 値は 2 です。 - Warning - HealthState 値が Warning の入力に一致するフィルター。 値は 4 です。 - Error - HealthState 値が Error の入力に一致するフィルター。 値は 8 です。 - All - 任意の HealthState 値の入力に一致するフィルター。 値は 65535 です。 |
| --exclude-health-statistics | 正常性の統計情報をクエリ結果の一部として返すかどうかを示します。 既定では false です。 統計情報は、正常性の状態が Ok、Warning、および Error の子エンティティの数を示します。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application deployed-list
Service Fabric ノードにデプロイされたアプリケーションの一覧を取得します。
Service Fabric ノードにデプロイされたアプリケーションの一覧を取得します。 ID で明示的に照会しない限り、結果には、デプロイされたシステム アプリケーションに関する情報は含まれません。 結果には、アクティブ、アクティブ化中、およびダウンロード中の状態の展開済みアプリケーションが含まれます。 このクエリでは、ノード名がクラスター上のノードに対応している必要があります。 指定されたノード名がクラスター上のアクティブな Service Fabric ノードを示していない場合、クエリは失敗します。
引数
| Argument | 説明 |
|---|---|
| --node-name [必須] | ノード名。 |
| --continuation-token | 継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。 |
| --include-health-state | エンティティの正常性の状態を含めます。 このパラメーターが false の場合、または指定されていない場合は、返される正常性状態は "Unknown" です。 true に設定すると、結果がマージされる前に、クエリはノードと正常性システム サービスに並列で渡されます。 その結果、クエリはコストが高くなり、長い時間がかかる場合があります。 |
| --max-results | ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application health
Service Fabric アプリケーションの正常性を取得します。
Service Fabric アプリケーションの正常性の状態を返します。 応答で、Ok、Error、Warning のいずれかの正常性の状態が報告されます。 正常性ストアにエンティティが見つからない場合は、Error が返されます。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --deployed-applications-health-state-filter | 正常性の状態に基づくアプリケーションの正常性クエリの結果で返されるデプロイされたアプリケーションの正常性の状態オブジェクトをフィルター処理できます。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するデプロイ済みアプリケーションのみが返されます。 すべてのデプロイ済みアプリケーションは、集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 'OR' を使用して取得したこれらの値の組み合わせが可能です。 たとえば、指定した値が 6 の場合、HealthState の値が OK (2) と Warning (4) のデプロイ済みアプリケーションの正常性の状態が返されます。 - Default - 既定値。 任意の HealthState と一致します。 値は 0 です。 - None - どの HealthState 値とも一致しないフィルター。 状態の特定のコレクションの結果が返されないようにするために使用されます。 値は 1 です。 - Ok - HealthState 値が Ok の入力に一致するフィルター。 値は 2 です。 - Warning - HealthState 値が Warning の入力に一致するフィルター。 値は 4 です。 - Error - HealthState 値が Error の入力に一致するフィルター。 値は 8 です。 - All - 任意の HealthState 値の入力に一致するフィルター。 値は 65535 です。 |
| --events-health-state-filter | 正常性の状態に基づいて返された HealthEvent オブジェクトのコレクションをフィルター処理できます。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するイベントのみが返されます。 すべてのイベントが集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 'OR' を使用して取得したこれらの値の組み合わせが可能です。 たとえば、指定した値が 6 の場合、HealthState の値が OK (2) と Warning (4) のすべてのイベントが返されます。 - Default - 既定値。 任意の HealthState と一致します。 値は 0 です。 - None - どの HealthState 値とも一致しないフィルター。 状態の特定のコレクションの結果が返されないようにするために使用されます。 値は 1 です。 - Ok - HealthState 値が Ok の入力に一致するフィルター。 値は 2 です。 - Warning - HealthState 値が Warning の入力に一致するフィルター。 値は 4 です。 - Error - HealthState 値が Error の入力に一致するフィルター。 値は 8 です。 - All - 任意の HealthState 値の入力に一致するフィルター。 値は 65535 です。 |
| --exclude-health-statistics | 正常性の統計情報をクエリ結果の一部として返すかどうかを示します。 既定では false です。 統計情報は、正常性の状態が Ok、Warning、および Error の子エンティティの数を示します。 |
| --services-health-state-filter | 正常性状態に基づくサービス正常性クエリの結果で返される、サービスの正常性状態のオブジェクトのフィルター処理ができます。 このパラメーターに指定できる値には、次の正常性の状態のいずれかの整数値が含まれます。 フィルターに一致するサービスのみが返されます。 すべてのサービスが集計された正常性の状態を評価するために使用されます。 指定しない場合、すべてのエントリが返されます。 状態値はフラグベースの列挙型であるため、値はビット演算子 'OR' を使用して取得したこれらの値の組み合わせが可能です。 たとえば、指定した値が 6 の場合、HealthState の値が OK (2) と Warning (4) のサービスの正常性の状態が返されます。 - Default - 既定値。 任意の HealthState と一致します。 値は 0 です。 - None - どの HealthState 値とも一致しないフィルター。 状態の特定のコレクションの結果が返されないようにするために使用されます。 値は 1 です。 - Ok - HealthState 値が Ok の入力に一致するフィルター。 値は 2 です。 - Warning - HealthState 値が Warning の入力に一致するフィルター。 値は 4 です。 - Error - HealthState 値が Error の入力に一致するフィルター。 値は 8 です。 - All - 任意の HealthState 値の入力に一致するフィルター。 値は 65535 です。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application info
Service Fabric アプリケーションの情報を取得します。
Service Fabric クラスターで作成された、または作成中の、パラメーターとして指定されているものと同じ名前のアプリケーションの情報を返します。 応答には、名前、種類、状態、パラメーター、およびアプリケーションに関するその他の詳細が含まれています。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --exclude-application-parameters | アプリケーションのパラメーターを結果から除外するかどうかを指定するフラグ。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application list
Service Fabric クラスター内に作成されているアプリケーションのうち、指定したフィルターに一致するものの一覧を取得します。
Service Fabric クラスターで作成済みまたは作成中のアプリケーションのうち、指定したフィルターと一致するものに関する情報を取得します。 応答には、名前、種類、状態、パラメーター、およびアプリケーションに関するその他の詳細が含まれています。 アプリケーションが 1 ページに収まらない場合、1 ページの結果と継続トークンが返されます。これは次のページを取得するために使用できます。 フィルター ApplicationTypeName と ApplicationDefinitionKindFilter を同時に指定することはできません。
引数
| Argument | 説明 |
|---|---|
| --application-definition-kind-filter | Service Fabric アプリケーションを定義するためのメカニズムである ApplicationDefinitionKind でのフィルターに使われます。 - Default - 既定値。"All" を選んだ場合と同じ機能を実行します。 値は 0 です。 - All - ApplicationDefinitionKind 値の入力と一致するフィルター。 値は 65535 です。 - ServiceFabricApplicationDescription - ApplicationDefinitionKind 値 ServiceFabricApplicationDescription の入力と一致するフィルター。 値は 1 です。 - Compose - ApplicationDefinitionKind 値 Compose の入力と一致するフィルター。 値は 2 です。 |
| --application-type-name | クエリを実行するアプリケーションをフィルター処理するために使用されるアプリケーションの種類名。 この値にアプリケーションの種類のバージョンを含めることはできません。 |
| --continuation-token | 継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。 |
| --exclude-application-parameters | アプリケーションのパラメーターを結果から除外するかどうかを指定するフラグ。 |
| --max-results | ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application load
Service Fabric アプリケーションの負荷情報を取得します。
Service Fabric クラスターで作成された、または作成中の、パラメーターとして指定されているものと同じ名前のアプリケーションの負荷情報を返します。 応答には、名前、最小ノード数、最大ノード数、アプリケーションが現在使用しているノードの数、およびアプリケーションの負荷メトリック情報が含まれます。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application manifest
アプリケーションの種類を記述するマニフェストを取得します。
応答には、アプリケーション マニフェスト XML が文字列として含まれています。
引数
| Argument | 説明 |
|---|---|
| --application-type-name [必須] | アプリケーションの種類名。 |
| --application-type-version [必須] | アプリケーションの種類のバージョン。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application provision
外部ストアの ".sfpkg" パッケージまたはイメージ ストアのアプリケーション パッケージを使って、Service Fabric アプリケーションの種類をプロビジョニングするか、クラスターに登録します。
Service Fabric アプリケーションの種類をクラスターにプロビジョニングします。 すべての新しいアプリケーションをインスタンス化するには、プロビジョニングが必要です。 プロビジョニング操作は、relativePathInImageStore で指定されているアプリケーション パッケージで、または外部 ".sfpkg" の URI を使って、実行することができます。 --external-provision を設定しないと、このコマンドはイメージ ストアのプロビジョニングを予期します。
引数
| Argument | 説明 |
|---|---|
| --application-package-download-uri | HTTP または HTTPS プロトコルを使ってアプリケーション パッケージをダウンロードできる ".sfpkg" アプリケーション パッケージのパスです。 プロビジョニングの種類が外部ストアの場合だけです。 アプリケーション パッケージは、ファイルをダウンロードするための GET 操作を提供する外部ストアに格納できます。 サポートされているプロトコルは HTTP と HTTPS であり、パスは READ アクセスを許可する必要があります。 |
| --application-type-build-path | プロビジョニングの種類のイメージ ストアの場合だけです。 以前のアップロード操作の間に指定されたイメージ ストアのアプリケーション パッケージに対する相対パスです。 |
| --application-type-name | プロビジョニングの種類が外部ストアの場合だけです。 アプリケーションの種類の名前は、アプリケーション マニフェストで検出されたアプリケーションの種類の名前を表します。 |
| --application-type-version | プロビジョニングの種類が外部ストアの場合だけです。 アプリケーションの種類のバージョンは、アプリケーション マニフェストで検出されたアプリケーションの種類のバージョンを表します。 |
| --external-provision | アプリケーション パッケージを登録またはプロビジョニングできる場所です。 以前に外部ストアにアップロードされたアプリケーション パッケージに対するプロビジョニングであることを示します。 アプリケーション パッケージの拡張子は *.sfpkg です。 |
| --no-wait | プロビジョニングを非同期に実行する必要があるかどうかを示します。 true に設定すると、システムによって要求が受け付けられるとプロビジョニング操作は戻り、タイムアウト制限なしに続行されます。 既定値は false です。 大規模なアプリケーション パッケージの場合、値を true に設定することをお勧めします。 |
| --timeout -t | 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application report-health
Service Fabric アプリケーションの正常性レポートを送信します。
指定された Service Fabric アプリケーションの正常性の状態をレポートします。 レポートには、正常性レポートのソースとレポートの対象となるプロパティに関する情報が含まれる必要があります。 レポートは Service Fabric ゲートウェイ アプリケーションに送信され、これにより正常性ストアに転送されます。 レポートは、ゲートウェイで受け入れられても、追加の検証後に正常性ストアによって拒否される可能性があります。 たとえば、正常性ストアは、古いシーケンス番号などの無効なパラメーターが原因でレポートを拒否する場合があります。 正常性ストアでレポートが適用されたかどうかを確認するには、アプリケーションの正常性を取得し、レポートが表示されることを確認します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は '~' 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --health-property [必須] | 正常性情報のプロパティ。 エンティティには、さまざまなプロパティの正常性レポートを含めることができます。 このプロパティは固定値列挙型ではなく文字列で、これにより、レポーターは、レポートをトリガーする状態の条件を柔軟に分類できます。 たとえば、SourceId が "LocalWatchdog" のレポーターは、ノード上で使用可能なディスクの状態を監視できるため、そのノードの "AvailableDisk" プロパティをレポートできます。 同じレポーターは、ノードの接続性を監視できるため、同じノードの "Connectivity" プロパティをレポートできます。 正常性ストアでは、これらのレポートは、指定されたノードの個々の正常性イベントとして扱われます。 このプロパティは SourceId と共に、正常性情報を一意に識別します。 |
| --health-state [必須] | 指定できる値: Invalid、Ok、Warning、Error、Unknown など。 |
| --source-id [必須] | 正常性に関する情報を生成したクライアント/ウォッチドッグ/システム コンポーネントを識別するソース名。 |
| --description | 正常性情報の説明。 レポートについて人間が判読できる情報を追加するために使用するフリー テキストを表します。 この説明の文字列の最大長は 4,096 文字です。 指定された文字列が長い場合は、自動的に切り捨てられます。 切り捨てられると、説明の末尾の文字には "[切り捨て]" というマーカーが含まれ、文字列の合計サイズが 4,096 文字になります。 このマーカーの存在は、切り捨てが発生したことをユーザーに示します。 切り捨てられた場合、説明に含まれるのは元の文字列のうち 4,096 文字未満であることに注意してください。 |
| --immediate | レポートをすぐに送信する必要があるかどうかを示すフラグ。 正常性レポートは Service Fabric ゲートウェイ アプリケーションに送信され、これにより正常性ストアに転送されます。 Immediate が true に設定された場合、HTTP ゲートウェイ アプリケーションで使用されているファブリック クライアント設定に関係なく、このレポートはすぐに HTTP ゲートウェイから正常性ストアに送信されます。 これは、できるだけ早く送信する必要がある重要なレポートに役立ちます。 タイミングやその他の条件に応じて、レポートの送信は依然として失敗する可能性があります。たとえば、HTTP ゲートウェイが閉じている場合やメッセージがゲートウェイに到達しない場合です。 Immediate が false に設定された場合、レポートは、正常性クライアントの設定に基づいて HTTP ゲートウェイから送信されます。 その結果、HealthReportSendInterval の構成に従ってバッチ処理されます。 この設定が推奨されているのは、正常性クライアントが正常性ストアへの正常性レポート メッセージに加えて正常性レポート処理を最適化できるようになるためです。 既定では、レポートはすぐに送信されません。 |
| --remove-when-expired | 有効期限が切れたときにレポートを正常性ストアから削除するかどうかを示す値。 true に設定した場合、レポートは、有効期限が切れると正常性ストアから削除されます。 false に設定した場合、レポートは、有効期限が切れるとエラーとして処理されます。 既定では、このプロパティの値は false です。 クライアントは、定期的にレポートする場合、RemoveWhenExpired を false (既定値) に設定する必要があります。 こうすることで、レポーターで問題 (デッドロックなど) が発生していてレポートできない場合に、正常性レポートの有効期限が切れると、エンティティはエラーと評価されます。 これにより、このエンティティの正常性はエラー状態と見なされます。 |
| --sequence-number | 数値文字列で表された、この正常性レポートのシーケンス番号。 レポートのシーケンス番号は、古いレポートを検出するために正常性ストアによって使用されます。 指定しない場合、シーケンス番号は、レポートが追加されたときに正常性クライアントによって自動的に生成されます。 |
| --timeout -t | 既定値は60 です。 |
| --ttl | この正常性レポートの有効期間。 このフィールドでは、この期間の指定に ISO8601 形式が使用されます。 クライアントは、定期的にレポートする場合、レポートの送信頻度を有効期間よりも高くする必要があります。 クライアントは、遷移時にレポートする場合、有効期間を無限に設定できます。 有効期間が期限切れになると、正常性に関する情報を含む正常性イベントは、正常性ストアから削除される (RemoveWhenExpired が true の場合) か、エラーと評価されます (RemoveWhenExpired が false の場合)。 指定しない場合、有効期間の既定値は無限になります。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application type
指定した名前と完全に一致する Service Fabric クラスター内のアプリケーションの種類の一覧を取得します。
Service Fabric クラスターでプロビジョニングされた、またはプロビジョニング中のアプリケーションの種類に関する情報を返します。 これらは、名前がパラメーターとして指定されたものと完全に一致し、指定されたクエリ パラメーターに適合するアプリケーションの種類の結果です。 アプリケーションの種類の名前に一致するアプリケーションの種類のすべてのバージョンが返されます。各バージョンは 1 つのアプリケーションの種類として返されます。 応答には、名前、バージョン、状態、およびアプリケーションの種類に関するその他の詳細が含まれています。 これがページング クエリです。つまり、すべてのアプリケーションの種類が 1 ページに収まらない場合、1 ページの結果と次のページを取得するために使用できる継続トークンが返されます。 たとえば、10 個のアプリケーションの種類があって、1 ページに最初の 3 つのアプリケーションの種類しか収まらない場合、または max results が 3 に設定されている場合は、3 が返されます。 残りの結果にアクセスするには、返された継続トークンを次のクエリで使用して、後続のページを取得します。 後続のページが存在しない場合は、空の継続トークンが返されます。
引数
| Argument | 説明 |
|---|---|
| --application-type-name [必須] | アプリケーションの種類名。 |
| --application-type-version | アプリケーションの種類のバージョン。 |
| --continuation-token | 継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。 |
| --exclude-application-parameters | アプリケーションのパラメーターを結果から除外するかどうかを指定するフラグ。 |
| --max-results | ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application type-list
Service Fabric クラスター内のアプリケーションの種類の一覧を取得します。
Service Fabric クラスターでプロビジョニングされた、またはプロビジョニング中のアプリケーションの種類に関する情報を返します。 アプリケーションの種類の各バージョンが、1 つのアプリケーションの種類として返されます。 応答には、名前、バージョン、状態、およびアプリケーションの種類に関するその他の詳細が含まれています。 これがページング クエリです。つまり、すべてのアプリケーションの種類が 1 ページに収まらない場合、1 ページの結果と次のページを取得するために使用できる継続トークンが返されます。 たとえば、10 個のアプリケーションの種類があって、1 ページに最初の 3 つのアプリケーションの種類しか収まらない場合、または max results が 3 に設定されている場合は、3 が返されます。 残りの結果にアクセスするには、返された継続トークンを次のクエリで使用して、後続のページを取得します。 後続のページが存在しない場合は、空の継続トークンが返されます。
引数
| Argument | 説明 |
|---|---|
| --application-type-definition-kind-filter | Service Fabric アプリケーションの種類を定義するためのメカニズムである ApplicationTypeDefinitionKind でのフィルターに使われます。 - Default - 既定値。"All" を選んだ場合と同じ機能を実行します。 値は 0 です。 - All - ApplicationTypeDefinitionKind 値の入力と一致するフィルター。 値は 65535 です。 - ServiceFabricApplicationPackage - ApplicationTypeDefinitionKind 値 ServiceFabricApplicationPackage の入力と一致するフィルター。 値は 1 です。 - Compose - ApplicationTypeDefinitionKind 値 Compose の入力と一致するフィルター。 値は 2 です。 |
| --continuation-token | 継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。 |
| --exclude-application-parameters | アプリケーションのパラメーターを結果から除外するかどうかを指定するフラグ。 |
| --max-results | ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application unprovision
Service Fabric アプリケーションの種類をクラスターから削除または登録解除します。
この操作は、アプリケーションの種類のすべてのアプリケーション インスタンスが削除されている場合にのみ実行できます。 アプリケーションの種類が登録解除されると、この特定のアプリケーションの種類に対して新しいアプリケーション インスタンスを作成できません。
引数
| Argument | 説明 |
|---|---|
| --application-type-name [必須] | アプリケーションの種類名。 |
| --application-type-version [必須] | アプリケーション マニフェストで定義されているアプリケーションの種類のバージョンです。 |
| --async-parameter | プロビジョニング解除を非同期に実行する必要があるかどうかを示すフラグです。 true に設定すると、システムによって要求が受け付けられるとプロビジョニング解除操作は戻り、タイムアウト制限なしに続行されます。 既定値は false です。 ただし、プロビジョニングされた大規模なアプリケーション パッケージの場合は、true に設定することをお勧めします。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application upgrade
Service Fabric クラスターで、アプリケーションのアップグレードを開始します。
指定されたアプリケーションのアップグレード パラメーターを検証し、パラメーターが有効であれば、アプリケーションのアップグレードを開始します。 アップグレードの説明により既存のアプリケーションの説明が置き換えられることに注意してください。 これは、パラメーターが指定されていない場合、アプリケーションの既存のパラメーターが空のパラメーター リストで上書きされることを意味します。 これにより、アプリケーションがアプリケーション マニフェストからのパラメーターの既定値を使用することになります。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --application-version [必須] | アプリケーションのアップグレードの対象となるアプリケーションの種類のバージョン (アプリケーション マニフェストで検出される)。 |
| --parameters [必須] | アプリケーションのアップグレード時に適用される、アプリケーション パラメーター オーバーライドの JSON でエンコードされた一覧。 |
| --default-service-health-policy | サービスの種類の正常性を評価するために既定で使用される正常性ポリシーの JSON でエンコードされた仕様。 |
| --failure-action | 監視対象のアップグレードで監視ポリシー違反または正常性ポリシー違反が発生した場合に実行するアクション。 |
| --force-restart | コードのバージョンが変更されていない場合でも、アップグレード時にプロセスを強制的に再起動します。 |
| --health-check-retry-timeout | アプリケーションまたはクラスターが正常ではない場合に正常性チェックを実行する間隔。 既定値はPT0H10M0S です。 |
| --health-check-stable-duration | アプリケーションまたはクラスターが正常な状態である必要がある時間。この時間を超えると、アップグレードが次のアップグレード ドメインに進みます。 既定値はPT0H2M0S です。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 |
| --health-check-wait-duration | アップグレード ドメインの完了後、正常性チェック プロセスを開始するまでの、待機時間の長さ。 既定値は0。 |
| --max-unhealthy-apps | 異常なデプロイ済みアプリケーションの割合の最大許容パーセンテージ。 0 ～ 100 の数値として表されます。 |
| --mode | ローリング アップグレード時に正常性を監視するために使用されるモード。 既定値は UnmonitoredAuto です。 |
| --replica-set-check-timeout | アップグレード ドメインの処理をブロックし、予期しない問題が発生したときに可用性の損失を防ぐための最長時間。 秒単位で測定されます。 |
| --service-health-policy | サービスの種類名ごとにサービスの種類の正常性ポリシーを持つ JSON でエンコードされたマップ。 このマップは、既定では空です。 |
| --timeout -t | 既定値は60 です。 |
| --upgrade-domain-timeout | 各ドメインがアップグレードを完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 既定値はP10675199DT02H48M05.4775807S です。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 |
| --upgrade-timeout | アップグレード全体を完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 既定値はP10675199DT02H48M05.4775807S です。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 |
| --warning-as-error | 警告がエラーと同じ重大度で処理されることを示します。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application upgrade-resume
Service Fabric クラスターで、アプリケーションのアップグレードを再開します。
Service Fabric アプリケーションの監視対象外の手動アップグレードを再開します。 Service Fabric は、一度に 1 つのアップグレード ドメインをアップグレードします。 監視対象外の手動アップグレードの場合、Service Fabric は、アップグレード ドメインを完了した後、ユーザーがこの API を呼び出すのを待ってから、次のアップグレード ドメインを続行します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --upgrade-domain-name [必須] | アップグレードを再開するアップグレード ドメインの名前。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application upgrade-rollback
Service Fabric クラスター内で現在進行中のアプリケーションのアップグレードのロールバックを開始します。
現在のアプリケーション アップグレードの以前のバージョンへのロールバックを開始します。 この API は、新しいバージョンにロールフォワードしている現在実行中のアップグレードのロールバックのみに使用できます。 アプリケーションが現在アップグレード中でない場合は、目的のバージョンにアップグレードするには (以前のバージョンへのロールバックも含みます) StartApplicationUpgrade API を使用します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application upgrade-status
このアプリケーションで実行された最新のアップグレードの詳細を取得します。
最新のアプリケーション アップグレードの状態、およびアプリケーションの正常性の問題のデバッグに役立つ詳細に関する情報を返します。
引数
| Argument | 説明 |
|---|---|
| --application-id [必須] | アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。 |
| --timeout -t | 操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値は60 です。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
sfctl application upload
Service Fabric アプリケーション パッケージをイメージ ストアにコピーします。
必要に応じて、パッケージ内の各ファイルのアップロードの進行状況を表示します。 アップロードの進行状況は stderr に送信されます。
引数
| Argument | 説明 |
|---|---|
| --path [必須] | ローカル アプリケーション パッケージへのパス。 |
| --compress | Service Fabric アプリケーション パッケージにのみ適用されます。 圧縮されたアプリケーション パッケージを含む新しいフォルダーを、既定の場所または圧縮場所パラメーターで指定された場所に作成し、新しく作成されたフォルダーをアップロードします。 sfctl によって生成された圧縮ファイルが既に存在する場合は、このフラグが設定されていると上書きされます。 ディレクトリがアプリケーション パッケージでない場合は、エラーが返されます。 既に圧縮されているアプリケーション パッケージの場合は、そのままフォルダーがコピーされます。 既定では、アップロードが成功すると、新しく作成された圧縮アプリケーション パッケージは削除されます。 アップロードに失敗した場合は、必要に応じて、圧縮されたパッケージを手動でクリーンアップしてください。 圧縮された場所のパラメーターが存在しないディレクトリを参照している場合は、削除しても、作成された空のディレクトリは削除されません。 |
| --compressed-location | 圧縮されたアプリケーション パッケージを配置する場所。 場所が指定されていない場合、圧縮されたパッケージは、パス引数で指定された親ディレクトリの下に sfctl_compressed_temp という名前の新しく作成されたフォルダーの下に配置されます。 たとえば、パスの引数に C:/FolderA/AppPkg を指定すると、 C:/FolderA/sfctl_compressed_temp/AppPkg に圧縮したパッケージを追加します。 |
| --imagestore-string | アプリケーション パッケージのアップロード先のイメージ ストア。 既定値: fabric:ImageStore。 ファイル保存先にアップロードするには、このパラメーターの先頭に “file:” を付けます。 それ以外の場合は、イメージ ストアの接続文字列 (既定値など) を値として指定してください。 |
| --keep-compressed | アップロードが正常に完了した場合に、生成された圧縮パッケージを保持するかどうかを指定します。 設定されない場合、正常に完了すると、圧縮されたアプリ パッケージは削除されます。 アップロードが成功しなかった場合、アプリケーション パッケージは、再アップロードのために常に出力ディレクトリに保持されます。 |
| --show-progress | 大きいパッケージのファイル アップロードの進行状況を表示します。 |
| --timeout -t | 合計タイムアウト (秒)。 アップロード タイムアウト時間が経過すると、アップロードが失敗してエラーが返されます。 このタイムアウトは、アプリケーション パッケージ全体に適用されます。個々のファイルのタイムアウトは、タイムアウトの残り時間と等しくなります。 タイムアウトには、アプリケーション パッケージを圧縮するのに必要な時間は含まれません。 既定値: 300。 |
グローバル引数
| 引数 | 説明 |
|---|---|
| --debug | すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。 |
| --help -h | このヘルプ メッセージを表示して終了します。 |
| --output -o | 出力形式。 使用できる値: json、jsonc、table、tsv。 既定値: json。 |
| --query | JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。 |
| --verbose | ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。 |
次のステップ
- Service Fabric CLI をセットアップします。
- サンプル スクリプトを使用して、Service Fabric CLI の使用方法を学習します。