共用方式為

az batch job-schedule

  • 參考

管理 Batch 作業排程。

命令

名稱 Description 類型 狀態
az batch job-schedule create

將 Batch 作業排程新增至帳戶。

 核心 GA
az batch job-schedule delete

從指定的帳戶刪除作業排程。

 核心 GA
az batch job-schedule disable

停用作業排程。

 核心 GA
az batch job-schedule enable

啟用作業排程。

 核心 GA
az batch job-schedule list

列出指定帳戶中的所有作業排程。

 核心 GA
az batch job-schedule reset

重設作業排程的屬性。 更新的作業規格僅適用於新作業。

 核心 GA
az batch job-schedule set

更新作業排程的屬性。

 核心 GA
az batch job-schedule show

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

 核心 GA
az batch job-schedule stop

終止作業排程。

 核心 GA

az batch job-schedule create

編輯

將 Batch 作業排程新增至帳戶。

az batch job-schedule create [--account-endpoint]
                             [--account-key]
                             [--account-name]
                             [--allow-task-preemption]
                             [--do-not-run-after]
                             [--do-not-run-until]
                             [--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]
                             [--job-metadata]
                             [--json-file]
                             [--max-parallel-tasks]
                             [--metadata]
                             [--on-all-tasks-complete]
                             [--pool-id]
                             [--priority]
                             [--recurrence-interval]
                             [--required-slots]
                             [--start-window]
                             [--uses-task-dependencies]

範例

建立具有 1 天間隔的新作業排程。

az batch job-schedule create --id jobschedule1 --pool-id pool1 --recurrence-interval P1D

選擇性參數

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

--do-not-run-after

在此作業排程下不會建立任何作業的時間。 排程會在最後期限過後立即移至已完成狀態，且此作業排程下沒有作用中的作業。 如果您未指定 doNotRunAfter 時間，而且您正在建立週期性工作排程，則工作排程會保持作用中，直到您明確終止為止。 預期的格式是 ISO-8601 時間戳。

--do-not-run-until

最早可在此作業排程下建立任何作業的時間。 如果您未指定 doNotRunUntil 時間，排程就會立即準備好建立作業。 預期的格式是 ISO-8601 時間戳。

--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://learn.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 持續時間。

--job-metadata

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

--json-file

包含 JSON 中作業排程規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有「作業排程自變數」。

--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。 此優先順序會作為 [作業排程] 下所有作業的預設值。 您可以使用更新作業 API 來建立作業之後，更新作業的優先順序。

--recurrence-interval

作業排程下兩個連續作業的開始時間之間的時間間隔。 作業排程在任何指定時間最多可以有一個作用中的作業。 因為作業排程在任何指定時間最多可以有一個作用中的作業，所以如果是時候在作業排程下建立新的作業，但上一個作業仍在執行中，Batch 服務將不會建立新的作業，直到上一個作業完成為止。 如果上一個作業未在新的 recurrenceInterval 的 startWindow 期間內完成，則不會排程該間隔的新作業。 針對週期性作業，您通常應該在 jobSpecification 中指定 jobManagerTask。 如果您未使用jobManagerTask，則需要外部進程來監視建立作業的時間、將工作新增至作業，並終止作業準備進行下一次迴圈。 默認值是排程不會遞歸：一個作業會在 doNotRunUntil 時間之後於 startWindow 內建立，而且排程會在該作業完成時立即完成。 最小值為1分鐘。 如果您指定較低的值，Batch 服務會拒絕排程併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--required-slots

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

--start-window

時間間隔，從排程指出應該建立作業的時間開始，必須在其中建立作業。 如果未在 startWindow 間隔內建立作業，則會遺失「機會」;在排程的下一次週期之前，將不會建立任何作業。 如果排程是週期性，而 startWindow 的時間超過周期間隔，則這相當於無限 startWindow，因為一個 recurrenceInterval 中「到期」的作業不會轉送至下一個周期間隔。 預設值為無限。 最小值為1分鐘。 如果您指定較低的值，Batch 服務會拒絕排程併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--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-schedule delete

編輯

從指定的帳戶刪除作業排程。

當您刪除作業排程時，這也會刪除該排程下的所有作業和工作。 刪除 [工作] 時，也會刪除計算節點上其工作目錄中的所有檔案（會忽略保留期間）。 一旦刪除作業排程，作業排程統計數據仍計入帳戶存留期統計數據，就無法再存取作業排程統計數據。

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

必要參數

--job-schedule-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-schedule disable

編輯

停用作業排程。

在再次啟用作業排程之前，將不會建立任何新的作業。

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

必要參數

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

編輯

啟用作業排程。

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

必要參數

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

編輯

列出指定帳戶中的所有作業排程。

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

選擇性參數

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

--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-schedule reset

編輯

重設作業排程的屬性。 更新的作業規格僅適用於新作業。

az batch job-schedule reset --job-schedule-id
                            [--account-endpoint]
                            [--account-key]
                            [--account-name]
                            [--allow-task-preemption]
                            [--do-not-run-after]
                            [--do-not-run-until]
                            [--if-match]
                            [--if-modified-since]
                            [--if-none-match]
                            [--if-unmodified-since]
                            [--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]
                            [--job-metadata]
                            [--json-file]
                            [--max-parallel-tasks]
                            [--metadata]
                            [--on-all-tasks-complete]
                            [--pool-id]
                            [--priority]
                            [--recurrence-interval]
                            [--required-slots]
                            [--start-window]
                            [--uses-task-dependencies]

必要參數

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

--do-not-run-after

在此作業排程下不會建立任何作業的時間。 排程會在最後期限過後立即移至已完成狀態，且此作業排程下沒有作用中的作業。 如果您未指定 doNotRunAfter 時間，而且您正在建立週期性工作排程，則工作排程會保持作用中，直到您明確終止為止。 預期的格式是 ISO-8601 時間戳。

--do-not-run-until

最早可在此作業排程下建立任何作業的時間。 如果您未指定 doNotRunUntil 時間，排程就會立即準備好建立作業。 預期的格式是 ISO-8601 時間戳。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--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://learn.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 持續時間。

--job-metadata

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

--json-file

包含 JSON 中作業排程規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有「作業排程自變數」。

--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。 此優先順序會作為 [作業排程] 下所有作業的預設值。 您可以使用更新作業 API 來建立作業之後，更新作業的優先順序。

--recurrence-interval

作業排程下兩個連續作業的開始時間之間的時間間隔。 作業排程在任何指定時間最多可以有一個作用中的作業。 因為作業排程在任何指定時間最多可以有一個作用中的作業，所以如果是時候在作業排程下建立新的作業，但上一個作業仍在執行中，Batch 服務將不會建立新的作業，直到上一個作業完成為止。 如果上一個作業未在新的 recurrenceInterval 的 startWindow 期間內完成，則不會排程該間隔的新作業。 針對週期性作業，您通常應該在 jobSpecification 中指定 jobManagerTask。 如果您未使用jobManagerTask，則需要外部進程來監視建立作業的時間、將工作新增至作業，並終止作業準備進行下一次迴圈。 默認值是排程不會遞歸：一個作業會在 doNotRunUntil 時間之後於 startWindow 內建立，而且排程會在該作業完成時立即完成。 最小值為1分鐘。 如果您指定較低的值，Batch 服務會拒絕排程併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--required-slots

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

--start-window

時間間隔，從排程指出應該建立作業的時間開始，必須在其中建立作業。 如果未在 startWindow 間隔內建立作業，則會遺失「機會」;在排程的下一次週期之前，將不會建立任何作業。 如果排程是週期性，而 startWindow 的時間超過周期間隔，則這相當於無限 startWindow，因為一個 recurrenceInterval 中「到期」的作業不會轉送至下一個周期間隔。 預設值為無限。 最小值為1分鐘。 如果您指定較低的值，Batch 服務會拒絕排程併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--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-schedule set

編輯

更新作業排程的屬性。

您可以獨立更新排程和作業規格，但這些實體的任何變更都會重設該實體中的所有屬性。

az batch job-schedule set --job-schedule-id
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--allow-task-preemption]
                          [--do-not-run-after]
                          [--do-not-run-until]
                          [--if-match]
                          [--if-modified-since]
                          [--if-none-match]
                          [--if-unmodified-since]
                          [--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]
                          [--job-metadata]
                          [--json-file]
                          [--max-parallel-tasks]
                          [--metadata]
                          [--on-all-tasks-complete]
                          [--pool-id]
                          [--priority]
                          [--recurrence-interval]
                          [--required-slots]
                          [--start-window]
                          [--uses-task-dependencies]

必要參數

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

--do-not-run-after

在此作業排程下不會建立任何作業的時間。 排程會在最後期限過後立即移至已完成狀態，且此作業排程下沒有作用中的作業。 如果您未指定 doNotRunAfter 時間，而且您正在建立週期性工作排程，則工作排程會保持作用中，直到您明確終止為止。 預期的格式是 ISO-8601 時間戳。

--do-not-run-until

最早可在此作業排程下建立任何作業的時間。 如果您未指定 doNotRunUntil 時間，排程就會立即準備好建立作業。 預期的格式是 ISO-8601 時間戳。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--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://learn.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 持續時間。

--job-metadata

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

--json-file

包含 JSON 中作業排程規格的檔案（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有「作業排程自變數」。

--max-parallel-tasks

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

--metadata

與作業排程相關聯的名稱/值組清單做為元數據。 如果您未指定這個項目，現有的元數據會保持不變。 以 『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。 此優先順序會作為 [作業排程] 下所有作業的預設值。 您可以使用更新作業 API 來建立作業之後，更新作業的優先順序。

--recurrence-interval

作業排程下兩個連續作業的開始時間之間的時間間隔。 作業排程在任何指定時間最多可以有一個作用中的作業。 因為作業排程在任何指定時間最多可以有一個作用中的作業，所以如果是時候在作業排程下建立新的作業，但上一個作業仍在執行中，Batch 服務將不會建立新的作業，直到上一個作業完成為止。 如果上一個作業未在新的 recurrenceInterval 的 startWindow 期間內完成，則不會排程該間隔的新作業。 針對週期性作業，您通常應該在 jobSpecification 中指定 jobManagerTask。 如果您未使用jobManagerTask，則需要外部進程來監視建立作業的時間、將工作新增至作業，並終止作業準備進行下一次迴圈。 默認值是排程不會遞歸：一個作業會在 doNotRunUntil 時間之後於 startWindow 內建立，而且排程會在該作業完成時立即完成。 最小值為1分鐘。 如果您指定較低的值，Batch 服務會拒絕排程併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--required-slots

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

--start-window

時間間隔，從排程指出應該建立作業的時間開始，必須在其中建立作業。 如果未在 startWindow 間隔內建立作業，則會遺失「機會」;在排程的下一次週期之前，將不會建立任何作業。 如果排程是週期性，而 startWindow 的時間超過周期間隔，則這相當於無限 startWindow，因為一個 recurrenceInterval 中「到期」的作業不會轉送至下一個周期間隔。 預設值為無限。 最小值為1分鐘。 如果您指定較低的值，Batch 服務會拒絕排程併發生錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--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-schedule show

編輯

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

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

必要參數

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

編輯

終止作業排程。

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

必要參數

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