az spring job

注意

此參考是 Azure CLI 的 Spring 延伸模組的一部分（2.56.0 版或更高版本）。 擴充功能會在您第一次執行 az spring job 命令時自動安裝。 深入了解擴充功能。

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

（僅限企業層）管理 Azure Spring Apps 服務作業的命令。

命令

名稱	Description	類型	狀態
az spring job create	在 Azure Spring Apps 服務中建立新的作業。	副檔名	預覽​​
az spring job delete	刪除 Azure Spring Apps 中的作業。	副檔名	預覽​​
az spring job deploy	將成品部署至作業並更新相關的組態。	副檔名	預覽​​
az spring job execution	（僅限企業層）管理 Azure Spring Apps 服務作業執行的命令。	副檔名	預覽​​
az spring job execution cancel	取消作業執行。	副檔名	預覽​​
az spring job execution instance	（僅限企業層）管理 Azure Spring Apps 服務作業執行實例的命令。	副檔名	預覽​​
az spring job execution instance list	列出作業執行的所有實例。	副檔名	預覽​​
az spring job execution list	列出作業的所有執行。	副檔名	預覽​​
az spring job execution show	顯示作業執行的狀態和結果。	副檔名	預覽​​
az spring job list	列出 Azure Spring Apps 中的所有作業。	副檔名	預覽​​
az spring job logs	顯示作業執行實例的記錄。 設定 '-f/--follow' 時，將會串流記錄。	副檔名	預覽​​
az spring job show	在 Azure Spring Apps 中顯示作業的詳細數據。	副檔名	預覽​​
az spring job start	開始執行作業。	副檔名	預覽​​
az spring job update	更新作業的組態。	副檔名	預覽​​

az spring job create

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

在 Azure Spring Apps 服務中建立新的作業。

az spring job create --name
                     --resource-group
                     --service
                     [--args]
                     [--bind-config-server]
                     [--bind-service-registry]
                     [--cpu]
                     [--envs]
                     [--memory]
                     [--parallelism]
                     [--retry-limit]
                     [--secret-envs]
                     [--timeout]

範例

使用預設組態建立作業。

az spring job create -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup

必要參數

--name -n

在指定的 Azure Spring Apps 實例中執行的工作名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--args

作業執行的自變數。

--bind-config-server --bind-cs

自動將作業系結至預設的 Config Server。

--bind-service-registry --bind-sr

自動將作業系結至預設的服務登錄。

--cpu

CPU 資源數量。 應該是 500m 或 CPU 核心數目。

預設值: 1

--envs

環境變數的非敏感性屬性。 格式化 “key[=value]” ，並以空格分隔。

--memory

記憶體資源數量。 應該是 512Mi 或 #Gi，例如 1Gi、3Gi。

預設值: 2Gi

--parallelism

每個執行所要執行的複本數目上限。

--retry-limit

失敗作業之前重試次數上限。

--secret-envs

環境變數的敏感性屬性。 一旦放置之後，它就會加密且不會傳回。格式化 “key[=value]” ，並以空格分隔。

--timeout

允許執行的最大秒數。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job delete

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除 Azure Spring Apps 中的作業。

az spring job delete --name
                     --resource-group
                     --service

範例

刪除作業

az spring job delete -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup

必要參數

--name -n

在指定的 Azure Spring Apps 實例中執行的工作名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job deploy

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將成品部署至作業並更新相關的組態。

az spring job deploy --name
                     --resource-group
                     --service
                     [--args]
                     [--artifact-path]
                     [--build-cpu]
                     [--build-env]
                     [--build-memory]
                     [--builder]
                     [--cpu]
                     [--disable-validation {false, true}]
                     [--envs]
                     [--memory]
                     [--no-wait]
                     [--parallelism]
                     [--retry-limit]
                     [--secret-envs]
                     [--source-path]
                     [--timeout]
                     [--version]

範例

將預先建置的 jar 部署到具有環境變數的作業。

az spring job deploy -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup --artifact-path app.jar --env foo=bar

將預先建置的 jar 部署至具有組建 env 的作業。

az spring job deploy -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup --artifact-path app.jar --build-env BP_JVM_VERSION=11.*

必要參數

--name -n

在指定的 Azure Spring Apps 實例中執行的工作名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--args

作業執行的自變數。

--artifact-path

部署指定的預先建置成品 （jar 或 netcore zip）。

--build-cpu

CPU 資源數量。 應該是 500m 或 CPU 核心數目。

預設值: 1

--build-env

以 'key[=value]' 格式分隔的空間分隔環境變數。

--build-memory

記憶體資源數量。 應該是 512Mi 或 #Gi，例如 1Gi、3Gi。

預設值: 2Gi

--builder

（僅限企業層）建置用來建置可執行檔的服務產生器。

預設值: default

--cpu

CPU 資源數量。 應該是 500m 或 CPU 核心數目。

--disable-validation

如果為 true，請停用 jar 驗證。

接受的值: false, true

--envs

環境變數的非敏感性屬性。 格式化 “key[=value]” ，並以空格分隔。

--memory

記憶體資源數量。 應該是 512Mi 或 #Gi，例如 1Gi、3Gi。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--parallelism

每個執行所要執行的複本數目上限。

--retry-limit

失敗作業之前重試次數上限。

--secret-envs

環境變數的敏感性屬性。 一旦放置之後，它就會加密且不會傳回。格式化 “key[=value]” ，並以空格分隔。

--source-path

部署指定的源數據夾。 資料夾會封裝成 tar、上傳，並使用 kpack 建置。 如果未提供任何值，則預設為目前資料夾。

--timeout

允許執行的最大秒數。 您可以使用 -1 來重設逾時。

--version

部署版本，如果未設定，請維持不變。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job list

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出 Azure Spring Apps 中的所有作業。

az spring job list --resource-group
                   --service

範例

列出作業

az spring job list -s MyAzureSpringAppsInstance -g MyResourceGroup

必要參數

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job logs

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

顯示作業執行實例的記錄。 設定 '-f/--follow' 時，將會串流記錄。

az spring job logs --execution
                   --name
                   --resource-group
                   --service
                   [--all-instances]
                   [--follow]
                   [--instance]
                   [--limit]
                   [--lines]
                   [--max-log-requests]
                   [--since]

範例

顯示作業執行之所有實例的記錄。

az spring job logs --name job-name --execution job-execution-nam --all-instances -s MyService -g MyResourceGroup

顯示作業執行特定實例的記錄。

az spring job logs --name job-name --execution job-execution-nam --instance job-execution-instance -s MyService -g MyResourceGroup

串流和監看作業執行的所有實例記錄。

az spring job logs --name job-name --execution job-execution-nam --all-instances --follow -s MyService -g MyResourceGroup

串流和監看作業執行特定實例的記錄。

az spring job logs --name job-name --execution job-execution-nam --instance MyJobExecutionInstance --follow -s MyService -g MyResourceGroup

必要參數

--execution

作業執行的名稱。

--name -n

在指定的 Azure Spring Apps 實例中執行的作業名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--all-instances

指出作業執行之所有實例之取得記錄的旗標。

--follow -f

要指出記錄的旗標應該進行串流處理。

--instance -i

作業執行之現有實例的名稱。 從命令 az spring job execution instance list尋找實例名稱。

--limit

要傳回的記錄最大 kibibyte。 上限號碼為 2048。

預設值: 2048

--lines

要顯示的行數。 最大值為 10000。

預設值: 100

--max-log-requests

指定依所有實例取得記錄時所要遵循的並行記錄數目上限。

預設值: 5

--since

只傳回比相對持續時間還新的記錄，例如 5s、2m 或 1h。 最大值為1小時。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job show

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

在 Azure Spring Apps 中顯示作業的詳細數據。

az spring job show --name
                   --resource-group
                   --service

必要參數

--name -n

在指定的 Azure Spring Apps 實例中執行的工作名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job start

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

開始執行作業。

az spring job start --name
                    --resource-group
                    --service
                    [--args]
                    [--cpu]
                    [--envs]
                    [--memory]
                    [--secret-envs]
                    [--wait-until-finished {false, true}]

範例

開始執行作業

az spring job start -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup

必要參數

--name -n

在指定的 Azure Spring Apps 實例中執行的工作名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--args

作業執行的自變數。

--cpu

CPU 資源數量。 應該是 500m 或 CPU 核心數目。

--envs

環境變數的非敏感性屬性。 格式化 “key[=value]” ，並以空格分隔。

--memory

記憶體資源數量。 應該是 512Mi 或 #Gi，例如 1Gi、3Gi。

--secret-envs

環境變數的敏感性屬性。 一旦放置之後，它就會加密且不會傳回。格式化 “key[=value]” ，並以空格分隔。

--wait-until-finished

如果為 true，請等到作業執行完成為止。

接受的值: false, true

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az spring job update

預覽

命令群組 'spring job' 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新作業的組態。

az spring job update --name
                     --resource-group
                     --service
                     [--args]
                     [--cpu]
                     [--envs]
                     [--memory]
                     [--parallelism]
                     [--retry-limit]
                     [--secret-envs]
                     [--timeout]

範例

為作業新增純文本環境變數。

az spring job update -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup --envs foo=bar

拿掉所有純文字環境變數，並保留作業的所有存在秘密。

az spring job update -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup --envs

拿掉所有秘密，並保留作業的所有純文本環境變數。

az spring job update -n job-name -s MyAzureSpringAppsInstance -g MyResourceGroup --secret-envs

必要參數

--name -n

在指定的 Azure Spring Apps 實例中執行的工作名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--args

作業執行的自變數。

--cpu

CPU 資源數量。 應該是 500m 或 CPU 核心數目。

--envs

環境變數的非敏感性屬性。 格式化 “key[=value]” ，並以空格分隔。

--memory

記憶體資源數量。 應該是 512Mi 或 #Gi，例如 1Gi、3Gi。

--parallelism

每個執行所要執行的複本數目上限。

--retry-limit

失敗作業之前重試次數上限。

--secret-envs

環境變數的敏感性屬性。 一旦放置之後，它就會加密且不會傳回。格式化 “key[=value]” ，並以空格分隔。

--timeout

允許執行的最大秒數。 您可以使用 -1 來重設逾時。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。