共用方式為

sfctl application

  • 發行項

建立、刪除和管理應用程式和應用程式類型。

命令

命令 描述
create 使用指定的描述建立 Service Fabric 應用程式。
delete 刪除現有的 Service Fabric 應用程式。
部署 取得在 Service Fabric 節點上部署之應用程式的相關信息。
deployed-health 取得在 Service Fabric 節點上部署之應用程式健康情況的相關信息。
deployed-list 取得在 Service Fabric 節點上部署的應用程式清單。
health 取得 Service Fabric 應用程式的健康情況。
資訊 取得 Service Fabric 應用程式的相關信息。
清單 取得 Service Fabric 叢集中建立的應用程式清單，這些應用程式符合指定的篩選條件。
負載 取得 Service Fabric 應用程式的載入資訊。
資訊清單 取得描述應用程式類型的指令清單。
佈建 使用外部存放區中的 '.sfpkg' 套件，或使用映射存放區中的應用程式套件，向叢集布建或註冊 Service Fabric 應用程式類型。
report-health 在 Service Fabric 應用程式上傳送健康情況報告。
type 取得 Service Fabric 叢集中與指定名稱完全相符的應用程式類型清單。
type-list 取得 Service Fabric 叢集中的應用程式類型清單。
取消布建 從叢集移除或取消註冊 Service Fabric 應用程式類型。
升級 開始升級 Service Fabric 叢集中的應用程式。
upgrade-resume 繼續升級 Service Fabric 叢集中的應用程式。
upgrade-rollback 開始復原 Service Fabric 叢集中應用程式目前進行中的升級。
upgrade-status 取得在此應用程式上執行的最新升級詳細數據。
上傳 將 Service Fabric 應用程式套件複製到映像存放區。

sfctl application create

使用指定的描述建立 Service Fabric 應用程式。

引數

Argument 描述
--app-name [必要] 應用程式的名稱，包括 'fabric：' URI 配置。
--app-type [必要] 應用程式指令清單中找到的應用程式類型名稱。
--app-version [必要] 應用程式指令清單中所定義的應用程式類型版本。
--max-node-count Service Fabric 會為此應用程式保留容量的節點數目上限。 請注意，這並不表示此應用程式的服務會放在所有這些節點上。
--指標 應用程式容量計量描述的 JSON 編碼清單。 計量定義為名稱，與應用程式所在之每個節點的一組容量相關聯。
--min-node-count Service Fabric 將為此應用程式保留容量的節點數目下限。 請注意，這並不表示此應用程式的服務會放在所有這些節點上。
--參數 建立應用程式時要套用的應用程式參數覆寫 JSON 編碼清單。
--timeout -t 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application delete

刪除現有的 Service Fabric 應用程式。

必須先建立應用程式，才能刪除應用程式。 刪除應用程式將會刪除屬於該應用程式的所有服務。 根據預設，Service Fabric 會嘗試以正常方式關閉服務複本，然後刪除服務。 不過，如果服務在正常關閉複本時遇到問題，刪除作業可能需要很長的時間或停滯。 使用選擇性 ForceRemove 旗標來略過正常關閉順序，並強制刪除應用程式及其所有服務。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--force-remove 在不經過正常關機順序的情況下，強制移除 Service Fabric 應用程式或服務。 此參數可用來強制刪除因服務程式代碼中導致無法正常關閉複本之服務程式代碼的問題而逾時刪除的應用程式或服務。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

已部署 sfctl 應用程式

取得在 Service Fabric 節點上部署之應用程式的相關信息。

如果所提供的應用程式識別碼是針對系統應用程式，此查詢會傳回系統應用程式資訊。 結果包含作用中、啟動和下載狀態的已部署應用程式。 此查詢需要節點名稱對應至叢集上的節點。 如果提供的節點名稱未指向叢集上任何作用中的 Service Fabric 節點，查詢就會失敗。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--node-name [必要] 節點的名稱。
--include-health-state 包含實體的健康情況狀態。 如果此參數為 false 或未指定，則傳回的健康情況狀態為 「未知」。 當設定為 true 時，查詢會平行處理至節點和健全狀況系統服務，然後再合併結果。 因此，查詢成本更高，而且可能需要較長的時間。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application deployed-health

取得在 Service Fabric 節點上部署之應用程式健康情況的相關信息。

取得在 Service Fabric 節點上部署之應用程式健康情況的相關信息。 使用 EventsHealthStateFilter 選擇性地篩選已部署應用程式上所報告之 HealthEvent 物件的集合，根據健康情況狀態。 使用 DeployedServicePackagesHealthStateFilter，根據健康情況狀態選擇性地篩選 DeployedServicePackageHealth 子系。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--node-name [必要] 節點的名稱。
--deployed-service-packages-health-state-filter 允許根據所部署應用程式健康情況查詢結果傳回的已部署服務套件健康情況狀態對象進行篩選。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選條件的已部署服務套件。 所有已部署的服務套件都會用來評估已部署應用程式的匯總健全狀況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的服務套件健康情況狀態。
- 預設值 - 預設值。 符合任何 HealthState。 值為零。
- 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。
- 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。
- 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。
- 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。
- 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。
--events-health-state-filter 允許根據健康情況狀態篩選傳回的HealthEvent物件集合。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選的事件。 所有事件都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的所有事件。
- 預設值 - 預設值。 符合任何 HealthState。 值為零。
- 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。
- 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。
- 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。
- 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。
- 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。
--exclude-health-statistics 指出健康情況統計數據是否應該當做查詢結果的一部分傳回。 False 預設為 False。 統計數據顯示健全狀況狀態為Ok、Warning和Error的子實體數目。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application deployed-list

取得在 Service Fabric 節點上部署的應用程式清單。

取得在 Service Fabric 節點上部署的應用程式清單。 除非依標識符明確查詢已部署的系統應用程式，否則結果不會包含已部署系統應用程式的相關信息。 結果包含作用中、啟動和下載狀態的已部署應用程式。 此查詢需要節點名稱對應至叢集上的節點。 如果提供的節點名稱未指向叢集上任何作用中的 Service Fabric 節點，查詢就會失敗。

引數

Argument 描述
--node-name [必要] 節點的名稱。
--continuation-token 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。
--include-health-state 包含實體的健康情況狀態。 如果此參數為 false 或未指定，則傳回的健康情況狀態為 「未知」。 當設定為 true 時，查詢會平行處理至節點和健全狀況系統服務，然後再合併結果。 因此，查詢成本更高，而且可能需要較長的時間。
--max-results 在分頁查詢中傳回的結果數目上限。 此參數會定義所傳回結果數目的上限。 如果傳回的結果不符合組態中所定義的訊息大小上限限制，則傳回的結果可能會小於指定的最大結果。 如果此參數為零或未指定，則分頁查詢會包含盡可能符合傳回訊息的結果。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl 應用程式健康情況

取得 Service Fabric 應用程式的健康情況。

傳回 Service Fabric 應用程式的熱身狀態。 回應會報告 [確定]、[錯誤] 或 [警告] 健康狀態。 如果在健康狀態存放區中找不到實體，則會傳回 Error。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--deployed-applications-health-state-filter 允許根據應用程式健康情況狀態查詢結果傳回的已部署應用程式健康情況狀態對象進行篩選。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選條件的已部署應用程式。 所有已部署的應用程式都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的已部署應用程式健康情況狀態。
- 預設值 - 預設值。 符合任何 HealthState。 值為零。
- 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。
- 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。
- 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。
- 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。
- 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。
--events-health-state-filter 允許根據健康情況狀態篩選傳回的HealthEvent物件集合。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選的事件。 所有事件都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的所有事件。
- 預設值 - 預設值。 符合任何 HealthState。 值為零。
- 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。
- 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。
- 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。
- 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。
- 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。
--exclude-health-statistics 指出健康情況統計數據是否應該當做查詢結果的一部分傳回。 False 預設為 False。 統計數據顯示健全狀況狀態為Ok、Warning和Error的子實體數目。
--services-health-state-filter 允許根據服務健康情況狀態查詢結果傳回的服務健康情況狀態對象進行篩選。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選條件的服務。 所有服務都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的服務健康情況狀態。
- 預設值 - 預設值。 符合任何 HealthState。 值為零。
- 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。
- 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。
- 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。
- 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。
- 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl 應用程式資訊

取得 Service Fabric 應用程式的相關信息。

傳回在 Service Fabric 叢集中建立或正在建立的應用程式相關信息，且其名稱符合指定為 參數的應用程式。 回應包含應用程式的名稱、類型、狀態、參數和其他詳細數據。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--exclude-application-parameters 旗標，指定是否將應用程式參數從結果中排除。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl 應用程式清單

取得 Service Fabric 叢集中建立的應用程式清單，這些應用程式符合指定的篩選條件。

取得在 Service Fabric 叢集中建立的應用程式相關信息，或是在 Service Fabric 叢集中建立的應用程式，並符合指定的篩選條件。 回應包含應用程式的名稱、類型、狀態、參數和其他詳細數據。 如果應用程式不符合頁面，則會傳回一頁的結果，以及接續令牌，可用來取得下一頁。 無法同時指定 Filters ApplicationTypeName 和 ApplicationDefinitionKindFilter。

引數

Argument 描述
--application-definition-kind-filter 用來篩選 ApplicationDefinitionKind，這是用來定義 Service Fabric 應用程式的機制。
- 預設值 - 預設值，其會執行與選取 [全部] 相同的函式。 值為 0。
- All - 符合輸入與任何 ApplicationDefinitionKind 值的篩選。 值為 65535。
- ServiceFabricApplicationDescription - 符合輸入與 ApplicationDefinitionKind 值 ServiceFabricApplicationDescription 的篩選條件。 值為 1。
- Compose - 符合輸入與 ApplicationDefinitionKind 值 Compose 的篩選條件。 值為 2。
--application-type-name 用來篩選要查詢之應用程式的應用程式類型名稱。 此值不應包含應用程式類型版本。
--continuation-token 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。
--exclude-application-parameters 旗標，指定是否將應用程式參數從結果中排除。
--max-results 在分頁查詢中傳回的結果數目上限。 此參數會定義所傳回結果數目的上限。 如果傳回的結果不符合組態中所定義的訊息大小上限限制，則傳回的結果可能會小於指定的最大結果。 如果此參數為零或未指定，則分頁查詢會包含盡可能符合傳回訊息的結果。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application load

取得 Service Fabric 應用程式的載入資訊。

傳回在 Service Fabric 叢集中建立或正在建立的應用程式相關載入資訊，其名稱符合指定為 參數的應用程式。 回應包含名稱、最小節點、最大節點、應用程式目前佔用的節點數目，以及應用程式負載計量資訊。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl 應用程式指令清單

取得描述應用程式類型的指令清單。

回應包含應用程式指令清單 XML 做為字串。

引數

Argument 描述
--application-type-name [必要] 應用程式類型的名稱。
--application-type-version [必要] 應用程式類型的版本。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 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，且路徑必須允許讀取存取。
--application-type-build-path 僅適用於布建種類映像存放區。 在先前上傳作業期間指定的映像存放區中，應用程式封裝的相對路徑。
--application-type-name 僅適用於布建種類外部存放區。 應用程式類型名稱代表應用程式指令清單中找到的應用程式類型名稱。
--application-type-version 僅適用於布建種類外部存放區。 應用程式類型版本代表應用程式指令清單中找到的應用程式類型版本。
--external-provision 可從中註冊或布建應用程式套件的位置。 表示布建適用於先前上傳至外部存放區的應用程式套件。 應用程式套件以擴展名 *.sfpkg 結尾。
--no-wait 指出是否應該以異步方式進行布建。

當設定為 true 時，布建作業會在系統接受要求時傳回，而且布建作業會繼續執行，而不會有任何逾時限制。 預設值為 false。 針對大型應用程式套件，建議將值設定為 true。
--timeout -t 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application report-health

在 Service Fabric 應用程式上傳送健康情況報告。

報告指定 Service Fabric 應用程式的健全狀態。 報表必須包含其報告之健康情況報告來源和屬性的相關信息。 報表會傳送至 Service Fabric 閘道應用程式，此應用程式會轉送至健康狀態存放區。 網關可以接受報告，但在額外的驗證之後，健康狀態存放區會拒絕。 例如，健康狀態存放區可能會因為無效的參數而拒絕報告，例如過時的序號。 若要查看報表是否已在健康狀態存放區中套用，請取得應用程式健康情況，並檢查報表是否出現。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。

這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層的名稱會以 '~' 字元分隔。 例如，如果應用程式名稱是 'fabric:/myapp/app1'，則應用程式識別在 6.0+ 中會是 'myapp~app1'，而在舊版中會是 'myapp/app1'。
--health-property [必要] 健康情況信息的屬性。

實體可以有不同屬性的健康情況報告。 屬性是字串，而不是固定列舉，可讓記者彈性地分類觸發報表的狀態條件。 例如，具有SourceId「LocalWatchdog」 的記者可以監視節點上可用磁碟的狀態，以便報告該節點上的 「AvailableDisk」 屬性。 相同的記者可以監視節點連線能力，因此它可以報告相同節點上的屬性「連線能力」。 在健康狀態存放區中，這些報告會被視為指定節點的個別健康情況事件。 屬性與SourceId一起，可唯一識別健康情況資訊。
--health-state [必要] 可能的值包括：『Invalid』、『Ok』、『Warning』、『Error』、『Unknown』。
--source-id [必要] 識別產生健康情況資訊之用戶端/監視程式/系統元件的來源名稱。
--描述 健康情況資訊的描述。

它代表用來新增人類可讀報表資訊的自由文字。 描述的最大字串長度為4096個字元。 如果提供的字串較長，則會自動截斷。 截斷時，描述的最後一個字元包含標記 “[Truncated]”，而字串大小總計為 4096 個字元。 標記的存在表示發生截斷的使用者。 請注意，截斷時，描述的原始字串少於 4096 個字元。
--立即的 指出是否應立即傳送報表的旗標。

健康情況報告會傳送至 Service Fabric 閘道應用程式，此應用程式會轉送至健康狀態存放區。 如果 Immediate 設定為 true，則不論 HTTP 閘道應用程式所使用的網狀架構客戶端設定為何，報表都會立即從 HTTP 閘道傳送至健康狀態存放區。 這對於應儘快傳送的重要報告很有用。 根據計時和其他條件，傳送報告可能仍然失敗，例如，如果 HTTP 閘道已關閉或訊息未連線到閘道。 如果 [即時運算] 設定為 false，則會根據 HTTP 閘道的健康情況客戶端設定來傳送報告。 因此，它會根據 HealthReportSendInterval 組態進行批處理。 這是建議的設定，因為它可讓健康情況用戶端將健康情況報告訊息優化到健康狀態存放區，以及健康情況報告處理。 根據預設，報表不會立即傳送。
--remove-when-expired 值，指出報表在到期時是否從健康狀態存放區中移除。

如果設定為 true，報表會在到期後從健康狀態存放區中移除。 如果設定為 false，報表會在過期時被視為錯誤。 此屬性的值預設為 false。 當用戶端定期報告時，應該設定 RemoveWhenExpired false （預設值）。 如此一來，記者有問題（例如死結）且無法報告，實體會在健康情況報告到期時評估為錯誤。 這會將實體標示為處於錯誤健康狀態。
--sequence-number 此健康情況報告的序號為數值字串。

健康狀態存放區會使用報表序號來偵測過時的報告。 如果未指定，當加入報表時，健康情況用戶端會自動產生序號。
--timeout -t 預設值：60。
--ttl 此健康情況報告有效的持續時間。 此欄位會使用ISO8601格式來指定持續時間。

當用戶端定期報告時，他們應該傳送頻率高於存留時間的報告。 如果客戶端回報轉換，他們可以將存留時間設定為無限。 存留時間到期時，如果 RemoveWhenExpired 為 true，則會從健康狀態存放區移除包含健康情況資訊的健全狀況事件，如果 RemoveWhenExpired false，則會在錯誤時進行評估。 如果未指定，存留時間預設為無限值。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl 應用程式類型

取得 Service Fabric 叢集中與指定名稱完全相符的應用程式類型清單。

傳回在 Service Fabric 叢集中佈建或正在布建的應用程式類型相關信息。 這些結果是應用程式類型，其名稱完全符合指定為 參數的應用程式類型，且符合指定的查詢參數。 會傳回符合應用程式類型名稱的所有應用程式類型版本，每個版本都會傳回為一個應用程式類型。 回應包含應用程式類型的名稱、版本、狀態和其他詳細數據。 這是分頁查詢，這表示如果並非所有應用程式類型都符合頁面，則會傳回一頁的結果，以及接續令牌，可用來取得下一頁。 例如，如果有 10 個應用程式類型，但頁面只符合前三個應用程式類型，或如果最大值結果設定為 3，則會傳回三個。 若要存取其餘的結果，請使用下一個查詢中傳回的接續令牌來擷取後續頁面。 如果沒有後續的頁面，則會傳回空的接續令牌。

引數

Argument 描述
--application-type-name [必要] 應用程式類型的名稱。
--application-type-version 應用程式類型的版本。
--continuation-token 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。
--exclude-application-parameters 旗標，指定是否將應用程式參數從結果中排除。
--max-results 在分頁查詢中傳回的結果數目上限。 此參數會定義所傳回結果數目的上限。 如果傳回的結果不符合組態中所定義的訊息大小上限限制，則傳回的結果可能會小於指定的最大結果。 如果此參數為零或未指定，則分頁查詢會包含盡可能符合傳回訊息的結果。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application type-list

取得 Service Fabric 叢集中的應用程式類型清單。

傳回在 Service Fabric 叢集中佈建或正在布建的應用程式類型相關信息。 每個應用程式類型版本都會以一個應用程式類型傳回。 回應包含應用程式類型的名稱、版本、狀態和其他詳細數據。 這是分頁查詢，這表示如果並非所有應用程式類型都符合頁面，則會傳回一頁的結果，以及接續令牌，可用來取得下一頁。 例如，如果有 10 個應用程式類型，但頁面只符合前三個應用程式類型，或如果最大值結果設定為 3，則會傳回三個。 若要存取其餘的結果，請使用下一個查詢中傳回的接續令牌來擷取後續頁面。 如果沒有後續的頁面，則會傳回空的接續令牌。

引數

Argument 描述
--application-type-definition-kind-filter 用來篩選 ApplicationTypeDefinitionKind，這是用來定義 Service Fabric 應用程式類型的機制。
- 預設值 - 預設值，其會執行與選取 [全部] 相同的函式。 值為 0。
- All - 符合輸入與任何 ApplicationTypeDefinitionKind 值的篩選。 值為 65535。
- ServiceFabricApplicationPackage - 符合 ApplicationTypeDefinitionKind 值 ServiceFabricApplicationPackage 之輸入的篩選條件。 值為 1。
- Compose - 符合輸入與 ApplicationTypeDefinitionKind 值 Compose 的篩選條件。 值為 2。
--continuation-token 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。
--exclude-application-parameters 旗標，指定是否將應用程式參數從結果中排除。
--max-results 在分頁查詢中傳回的結果數目上限。 此參數會定義所傳回結果數目的上限。 如果傳回的結果不符合組態中所定義的訊息大小上限限制，則傳回的結果可能會小於指定的最大結果。 如果此參數為零或未指定，則分頁查詢會包含盡可能符合傳回訊息的結果。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 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。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application upgrade

開始升級 Service Fabric 叢集中的應用程式。

驗證提供的應用程式升級參數，並在參數有效時開始升級應用程式。 請注意，升級描述會取代現有的應用程式描述。 這表示如果未指定參數，應用程式上的現有參數將會以空的參數清單覆寫。 這會導致應用程式使用應用程式指令清單中參數的預設值。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。

這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「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 之間的數字來表示。
--模式 在滾動升級期間用來監視健康情況的模式。 默認值：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 指出是否以與錯誤相同的嚴重性來處理警告。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application upgrade-resume

繼續升級 Service Fabric 叢集中的應用程式。

繼續未受監視的手動 Service Fabric 應用程式升級。 Service Fabric 一次升級一個升級網域。 針對未受監視的手動升級，在 Service Fabric 完成升級網域之後，它會等候您呼叫此 API，再繼續進行下一個升級網域。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--upgrade-domain-name [必要] 要繼續升級的升級網域名稱。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application upgrade-rollback

開始復原 Service Fabric 叢集中應用程式目前進行中的升級。

開始復原目前的應用程式升級至舊版。 此 API 只能用來復原正在向前復原至新版本的目前進行中升級。 如果應用程式目前未升級，請使用 StartApplicationUpgrade API 將它升級至所需的版本，包括回復至舊版。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application upgrade-status

取得在此應用程式上執行的最新升級詳細數據。

傳回最新應用程式升級狀態的相關信息，以及協助偵錯應用程式健康情況問題的詳細數據。

引數

Argument 描述
--application-id [必要] 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。
--timeout -t 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

sfctl application upload

將 Service Fabric 應用程式套件複製到映像存放區。

選擇性地顯示封裝中每個檔案的上傳進度。 上傳進度會傳送至 stderr。

引數

Argument 描述
--path [必要] 本機應用程式封裝的路徑。
--壓縮 僅適用於 Service Fabric 應用程式套件。 建立新的資料夾，其中包含壓縮的應用程式封裝至預設位置，或壓縮位置參數所指定的位置，然後上傳新建立的資料夾。

如果 sfctl 已經產生壓縮檔案，則會在此旗標設定時覆寫它。 如果目錄不是應用程式封裝，則會傳回錯誤。 如果它已經是壓縮的應用程式封裝，資料夾將會依目前的形式複製。 根據預設，新建立的壓縮應用程式套件會在成功上傳之後刪除。 如果上傳未成功，請視需要手動清除壓縮套件。 如果壓縮位置參數參考不存在的目錄，刪除並不會移除任何可能已建立的空白 dirs。
--compressed-location 放置壓縮應用程式封裝的位置。

如果未提供任何位置，壓縮套件將會放在名為 sfctl_compressed_temp 的新建立資料夾下，位於path自變數中指定的父目錄下。 例如，如果path自變數的值 C：/FolderA/AppPkg，則會將壓縮套件新增至 C：/FolderA/sfctl_compressed_temp/AppPkg。
--imagestore-string 要上傳應用程式套件的目標映像存放區。 默認值：fabric：ImageStore。

若要上傳至檔案位置，請使用 『file：』 啟動此參數。 否則，此值應該是映像存放區 連接字串，例如預設值。
--keep-compressed 是否要在上傳順利完成時保留產生的壓縮套件。

如果未設定，則成功完成時，將會刪除壓縮的應用程式套件。 如果上傳未成功，則應用程式套件一律會保留在輸出目錄中以便重新上傳。
--show-progress 顯示大型套件的檔案上傳進度。
--timeout -t 以秒為單位的總逾時。 上傳將會失敗，並在上傳逾時持續時間過後傳回錯誤。 此逾時會套用至整個應用程式套件，而個別檔案逾時會等於剩餘的逾時持續時間。 逾時不包含壓縮應用程式封裝所需的時間。 默認值：300。

全域引數

Argument 描述
--debug 增加記錄詳細資訊，以顯示所有偵錯記錄。
--help -h 顯示此說明訊息並結束。
--output -o 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。
--查詢 JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
--verbose 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

下一步

  • 設定 Service Fabric CLI。
  • 瞭解如何使用範例腳本來使用 Service Fabric CLI。