az batch job

管理 Batch 作業。

命令

名稱	Description	類型	狀態
az batch job create	將作業新增至 Batch 帳戶。	核心	加語
az batch job delete	從 Batch 帳戶刪除作業。	核心	加語
az batch job disable	停用 Batch 作業。	核心	加語
az batch job enable	啟用 Batch 作業。	核心	加語
az batch job list	列出 Batch 帳戶中的所有作業或作業排程。	核心	加語
az batch job prep-release-status	檢視 Batch 作業準備和發行工作的狀態。	核心	加語
az batch job prep-release-status list	列出作業執行所在之計算節點中指定作業的作業準備和作業發行工作執行狀態。	核心	加語
az batch job reset	更新 Batch 作業的屬性。 可以更新的未指定屬性會重設為預設值。	核心	加語
az batch job set	更新 Batch 作業的屬性。 更新子群組中的屬性將會重設該群組的未指定屬性。	核心	加語
az batch job show	取得指定之 Batch 作業的相關信息。	核心	加語
az batch job stop	停止執行中的 Batch 作業。	核心	加語
az batch job task-counts	檢視 Batch 作業中的工作和位置數目及其狀態。	核心	加語
az batch job task-counts show	取得指定之作業的工作計數。	核心	加語

az batch job create

將作業新增至 Batch 帳戶。

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-application-package-references]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--job-manager-task-id]
                    [--job-manager-task-resource-files]
                    [--job-max-task-retry-count]
                    [--job-max-wall-clock-time]
                    [--json-file]
                    [--max-parallel-tasks]
                    [--metadata]
                    [--on-all-tasks-complete]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--uses-task-dependencies]

範例

建立與現有集區相關聯的新作業。

az batch job create --id job1 --pool-id pool1

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--allow-task-preemption

此作業中的工作是否可以由其他高優先順序工作先佔。 如果值設定為 True，則送出至系統的其他高優先順序工作將優先，而且能夠從此作業重新排入工作佇列。 您可以使用更新作業 API 建立作業之後，更新作業的allowTaskPreemption。 如果旗標存在，則為 True。

--id

可唯一識別帳戶內作業的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符是區分大小寫和不區分大小寫的（也就是說，您可能不會在帳戶內有兩個標識符，只有大小寫不同）。 必填。

--job-manager-task-application-package-references

在執行命令行之前，Batch 服務會部署至計算節點的應用程式套件清單。應用程式套件會下載並部署至共享目錄，而不是工作工作目錄。 因此，如果參考的應用程式套件已在計算節點上，且為最新狀態，則不會重新下載;會使用計算節點上的現有複本。 如果無法安裝參考的應用程式套件，例如因為套件已刪除或下載失敗，工作就會失敗。 以 'id[#version]' 格式的選擇性版本分隔應用程式識別碼。

--job-manager-task-command-line

作業管理員工作的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand”，或在 Linux 中使用 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對路徑（相對於Task工作目錄），或使用 Batch 提供的環境變數 （https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables）。 必填。

--job-manager-task-environment-settings

作業管理員工作的環境變數設定清單。 以 『key=value』 格式分隔的空間值。

--job-manager-task-id

字串，可唯一識別作業內的作業管理員工作。 標識元可以包含英數位元的任何組合，包括連字元和底線，不能包含超過64個字元。 必填。

--job-manager-task-resource-files

Batch 服務在執行命令行之前，會先下載至計算節點的檔案清單。 此元素底下列出的檔案位於工作的工作目錄中。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。 filename=httpurl 格式的空間分隔資源參考。

--job-max-task-retry-count

每個工作可重試的次數上限。 如果 Batch 服務結束代碼為非零，則會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試每個工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。 如果重試計數上限為0，Batch服務就不會重試工作。 如果重試計數上限為 -1，Batch 服務會不限制地重試工作。 預設值為 0（沒有重試）。

--job-max-wall-clock-time

作業可能執行的最大經過時間，從建立作業的時間計算。 如果作業未在時間限制內完成，Batch 服務就會終止它，以及仍在執行的任何工作。 在此情況下，終止原因會是 MaxWallClockTimeExpiry。 如果未指定這個屬性，則作業執行的時間長度沒有限制。 預期格式為 ISO-8601 持續時間。

--json-file

包含 JSON 中作業規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有 『Job Arguments』。

--max-parallel-tasks

工作可以平行執行的工作數目上限。 maxParallelTasks 的值必須 -1 或大於 0，如果指定的話。 如果未指定，預設值為 -1，這表示可以一次執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。

--metadata

與作業做為元數據相關聯的名稱/值組清單。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。 以 『key=value』 格式分隔的空間值。

--on-all-tasks-complete

當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 請注意，如果作業不包含任何工作，則所有工作都會被視為完成。 因此，此選項最常與作業管理員工作搭配使用;如果您想要在沒有作業管理員的情況下使用自動作業終止，您應該一開始將 onAllTasksComplete 設定為 noaction，並更新 Job 屬性以在完成新增工作之後，將 OnAllTasksComplete 設定為 terminatejob。 預設值為 noaction。 已知值為：「noaction」 和 「terminatejob」。

--pool-id

現有集區的標識碼。 作業的所有工作都會在指定的集區上執行。 您必須確定這個屬性所參考的集區存在。 如果 Batch 服務嘗試排程作業時不存在集區，則在您建立具有該標識碼的集區之前，不會執行作業的工作。請注意，Batch 服務不會拒絕作業要求;在集區存在之前，它只會執行工作。 您必須指定集區標識碼或自動集區規格，但不能同時指定這兩者。

--priority

作業的優先順序。 優先順序值的範圍可以從 -1000 到 1000，-1000 是最低優先順序，1000 是最高優先順序。 預設值為 0。

--required-slots

工作需要執行的排程位置數目。 預設值為 1。 如果節點有足夠的可用排程位置，工作只能排程在計算節點上執行。 對於多重實例工作，不支援此屬性，而且不得指定。

--uses-task-dependencies

作業中的工作是否可以定義彼此的相依性。 默認值為 false。 如果旗標存在，則為 True。

全域參數

--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 batch job delete

從 Batch 帳戶刪除作業。

az batch job delete --job-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--if-match]
                    [--if-modified-since]
                    [--if-none-match]
                    [--if-unmodified-since]
                    [--yes]

範例

使用作業識別碼刪除作業，而不提示確認。

az batch job delete --job-id job1 --yes

必要參數

--job-id

要刪除之作業的識別碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--yes -y

請勿提示確認。

預設值: 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 batch job disable

停用 Batch 作業。

az batch job disable --job-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--disable-tasks]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--json-file]

範例

停用作業並重新排程任何執行中的工作。

az batch job disable --job-id job1 --disable-tasks requeue

必要參數

--job-id

要停用之作業的標識碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--disable-tasks

與作業相關聯的使用中工作該怎麼辦。 必填。 已知值為：“requeue”、“terminate” 和 “wait”。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--json-file

包含 JSON 內容規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有 『Content Arguments』。

全域參數

--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 batch job enable

啟用 Batch 作業。

az batch job enable --job-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--if-match]
                    [--if-modified-since]
                    [--if-none-match]
                    [--if-unmodified-since]

範例

啟用作業。

az batch job enable --job-id job1

必要參數

--job-id

要啟用之作業的標識碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

全域參數

--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 batch job list

列出 Batch 帳戶中的所有作業或作業排程。

az batch job list [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--expand]
                  [--filter]
                  [--job-schedule-id]
                  [--select]

範例

列出 Batch 帳戶中的所有作業

az batch job list

列出 Batch 帳戶中的所有作業排程

az batch job list --job-schedule-id jobschedule1

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 只需要環境變數設定：AZURE_BATCH_ACCOUNT。

--expand

OData $expand 子句。

--filter

OData $filter 子句。 如需建構此篩選的詳細資訊，請參閱 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch。

--job-schedule-id

您要從中取得作業清單之作業排程的識別碼。 如果省略，請列出帳戶中的所有作業。

--select

OData $select 子句。

全域參數

--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 batch job reset

更新 Batch 作業的屬性。 可以更新的未指定屬性會重設為預設值。

az batch job reset --job-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--allow-task-preemption]
                   [--if-match]
                   [--if-modified-since]
                   [--if-none-match]
                   [--if-unmodified-since]
                   [--job-max-task-retry-count]
                   [--job-max-wall-clock-time]
                   [--json-file]
                   [--max-parallel-tasks]
                   [--metadata]
                   [--on-all-tasks-complete]
                   [--pool-id]
                   [--priority]

範例

重設優先順序以外的所有作業屬性。

az batch job reset --job-id job1 --priority 100

必要參數

--job-id

您要更新其屬性的作業識別碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--allow-task-preemption

此作業中的工作是否可以由其他高優先順序工作先佔。 如果值設定為 True，則送出至系統的其他高優先順序工作將優先，而且能夠從此作業重新排入工作佇列。 您可以使用更新作業 API 建立作業之後，更新作業的allowTaskPreemption。 如果旗標存在，則為 True。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--job-max-task-retry-count

每個工作可重試的次數上限。 如果 Batch 服務結束代碼為非零，則會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試每個工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。 如果重試計數上限為0，Batch服務就不會重試工作。 如果重試計數上限為 -1，Batch 服務會不限制地重試工作。 預設值為 0（沒有重試）。

--job-max-wall-clock-time

作業可能執行的最大經過時間，從建立作業的時間計算。 如果作業未在時間限制內完成，Batch 服務就會終止它，以及仍在執行的任何工作。 在此情況下，終止原因會是 MaxWallClockTimeExpiry。 如果未指定這個屬性，則作業執行的時間長度沒有限制。 預期格式為 ISO-8601 持續時間。

--json-file

包含 JSON 中作業規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有 『Job Arguments』。

--max-parallel-tasks

工作可以平行執行的工作數目上限。 maxParallelTasks 的值必須 -1 或大於 0，如果指定的話。 如果未指定，預設值為 -1，這表示可以一次執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。

--metadata

與作業做為元數據相關聯的名稱/值組清單。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。 以 『key=value』 格式分隔的空間值。

--on-all-tasks-complete

當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 預設值為 noaction。 已知值為：「noaction」 和 「terminatejob」。

--pool-id

現有集區的標識碼。 作業的所有工作都會在指定的集區上執行。 您必須確定這個屬性所參考的集區存在。 如果 Batch 服務嘗試排程作業時不存在集區，則在您建立具有該標識碼的集區之前，不會執行作業的工作。請注意，Batch 服務不會拒絕作業要求;在集區存在之前，它只會執行工作。 您必須指定集區標識碼或自動集區規格，但不能同時指定這兩者。

--priority

作業的優先順序。 優先順序值的範圍可以從 -1000 到 1000，-1000 是最低優先順序，1000 是最高優先順序。 預設值為 0。

全域參數

--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 batch job set

更新 Batch 作業的屬性。 更新子群組中的屬性將會重設該群組的未指定屬性。

az batch job set --job-id
                 [--account-endpoint]
                 [--account-key]
                 [--account-name]
                 [--allow-task-preemption]
                 [--if-match]
                 [--if-modified-since]
                 [--if-none-match]
                 [--if-unmodified-since]
                 [--job-max-task-retry-count]
                 [--job-max-wall-clock-time]
                 [--json-file]
                 [--max-parallel-tasks]
                 [--metadata]
                 [--on-all-tasks-complete]
                 [--pool-id]
                 [--priority]

範例

更新作業優先順序。

az batch job set --job-id job1 --priority 100

必要參數

--job-id

您要更新其屬性的作業識別碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--allow-task-preemption

此作業中的工作是否可以由其他高優先順序工作先佔。 如果值設定為 True，則送出至系統的其他高優先順序工作將優先，而且能夠從此作業重新排入工作佇列。 您可以使用更新作業 API 建立作業之後，更新作業的allowTaskPreemption。 如果旗標存在，則為 True。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--job-max-task-retry-count

每個工作可重試的次數上限。 如果 Batch 服務結束代碼為非零，則會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試每個工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。 如果重試計數上限為0，Batch服務就不會重試工作。 如果重試計數上限為 -1，Batch 服務會不限制地重試工作。 預設值為 0（沒有重試）。

--job-max-wall-clock-time

作業可能執行的最大經過時間，從建立作業的時間計算。 如果作業未在時間限制內完成，Batch 服務就會終止它，以及仍在執行的任何工作。 在此情況下，終止原因會是 MaxWallClockTimeExpiry。 如果未指定這個屬性，則作業執行的時間長度沒有限制。 預期格式為 ISO-8601 持續時間。

--json-file

包含 JSON 中作業規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有 『Job Arguments』。

--max-parallel-tasks

工作可以平行執行的工作數目上限。 maxParallelTasks 的值必須 -1 或大於 0，如果指定的話。 如果未指定，預設值為 -1，這表示可以一次執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。

--metadata

與作業做為元數據相關聯的名稱/值組清單。 如果省略，現有的作業元數據會保持不變。 以 『key=value』 格式分隔的空間值。

--on-all-tasks-complete

當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 如果省略，則完成行為會保持不變。 您可能不會將值從 terminatejob 變更為 noaction-也就是說，一旦您訂用自動工作終止，就無法再將其關閉。 如果您嘗試這樣做，要求會失敗，並出現「無效的屬性值」錯誤回應;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 已知值為：「noaction」 和 「terminatejob」。

--pool-id

現有集區的標識碼。 作業的所有工作都會在指定的集區上執行。 您必須確定這個屬性所參考的集區存在。 如果 Batch 服務嘗試排程作業時不存在集區，則在您建立具有該標識碼的集區之前，不會執行作業的工作。請注意，Batch 服務不會拒絕作業要求;在集區存在之前，它只會執行工作。 您必須指定集區標識碼或自動集區規格，但不能同時指定這兩者。

--priority

作業的優先順序。 優先順序值的範圍可以從 -1000 到 1000，-1000 是最低優先順序，1000 是最高優先順序。 如果省略，作業的優先順序會保持不變。

全域參數

--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 batch job show

取得指定之 Batch 作業的相關信息。

az batch job show --job-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--expand]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--select]

範例

顯示作業的相關信息詳細數據。

az batch job show --job-id job1

必要參數

--job-id

作業的標識碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--expand

OData $expand 子句。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--select

OData $select 子句。

全域參數

--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 batch job stop

停止執行中的 Batch 作業。

終止指定的作業，將它標示為已完成。 收到終止作業要求時，Batch 服務會將作業設定為終止狀態。 Batch 服務接著會終止與作業相關聯的任何執行中工作，並執行任何必要的作業發行工作。 然後作業會進入已完成狀態。 如果工作中有任何工作處於作用中狀態，它們會維持在作用中狀態。 一旦工作終止，就無法新增新工作，而且不會排程任何剩餘的作用中工作。

az batch job stop --job-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--terminate-reason]

範例

停止作業並提供終止原因

az batch job stop --job-id job1 --terminate-reason "Completed workflow"

必要參數

--job-id

要終止之作業的標識碼。 必填。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--terminate-reason

終止原因。

您想要顯示為作業的 TerminateReason 的文字。 默認值為 『UserTerminate』。

全域參數

--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。