BatchJobSpecification interface
指定要依排程建立之作業的詳細數據。
屬性
| allow |
此作業中的工作是否可以由其他高優先順序工作先佔。 （此屬性預設無法使用。請聯絡支援人員以取得相關資訊）如果將值設為 True，則提交給系統的其他高優先順序工作將優先處理，並且能夠從此工作重新排入任務佇列。 您可以使用更新作業 API 建立作業之後，更新作業的allowTaskPreemption。 |
| all |
當此排程下建立之作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 請注意，如果作業不包含任何工作，則所有工作都會被視為完成。 因此，此選項最常與作業管理員工作搭配使用;如果您想要在沒有作業管理員的情況下使用自動作業終止，您應該一開始將 onAllTasksComplete 設定為 noaction，並更新 Job 屬性以在完成新增工作之後，將 OnAllTasksComplete 設定為 terminatejob。 預設值為 noaction。 |
| common |
一般環境變數設定的清單。 這些環境變數會針對在此排程下建立的所有工作設定（包括作業管理員、作業準備和作業發行工作）。 個別工作可以藉由使用不同的值來指定相同的設定名稱，來覆寫此處指定的環境設定。 |
| constraints | 在此排程下建立之作業的執行條件約束。 |
| display |
在此排程下建立之作業的顯示名稱。 名稱不一定是唯一的，而且可以包含最大長度為1024的任何Unicode字元。 |
| job |
此排程下啟動作業時要啟動之作業管理員工作的詳細數據。 如果作業未指定作業管理員工作，用戶必須使用工作 API 明確地將工作新增至作業。 如果作業確實指定作業管理員工作，Batch 服務會在建立作業時建立作業管理員工作，並且會嘗試排程作業管理員工作，再排程作業中的其他工作。 |
| job |
在此排程下建立之作業的作業準備工作。 如果作業有作業準備工作，Batch 服務會在節點上執行作業準備工作，然後再在該計算節點上啟動該作業的任何工作。 |
| job |
在此排程下建立之作業的作業發行工作。 作業發行工作的主要目的是復原作業準備工作所做的節點變更。 範例活動包括刪除本機檔案，或關閉在作業準備時啟動的服務。 若未同時指定作業的作業準備工作，就無法指定作業發行工作。 Batch 服務會在已執行作業準備工作的計算節點上執行作業發行工作。 |
| max |
工作可以平行執行的工作數目上限。 （此屬性預設無法使用。如需詳細資訊，請聯絡支援人員）maxParallelTasks 的值必須為 -1 或大於 0（如果指定）。 如果未指定，預設值為 -1，這表示可以一次執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。 |
| metadata | 與此排程下建立的每個作業相關聯的名稱/值組清單，做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。 |
| network |
（此屬性預設無法使用。請聯絡支援人員以取得更多資訊）任務的網路設定。 |
| pool |
Batch 服務在此排程下建立的作業工作執行所在的集區。 |
| priority | 在此排程下建立之作業的優先順序。 優先順序值的範圍可以從 -1000 到 1000，-1000 是最低優先順序，1000 是最高優先順序。 預設值為 0。 此優先順序會作為 [作業排程] 下所有作業的預設值。 您可以使用更新作業 API 來建立作業之後，更新作業的優先順序。 |
| task |
當此排程下建立之作業中的任何工作失敗時，Batch 服務應該採取的動作。 如果失敗Info，工作就會被視為失敗。 如果 Task 在結束重試計數後以非零結束代碼完成，或啟動工作時發生錯誤，例如資源文件下載錯誤，則會設定 failureInfo。 預設值為 noaction。 |
| uses |
作業中的工作是否可以定義彼此的相依性。 預設值為 false。 |
屬性詳細資料
allowTaskPreemption
此作業中的工作是否可以由其他高優先順序工作先佔。 （此屬性預設無法使用。請聯絡支援人員以取得相關資訊）如果將值設為 True，則提交給系統的其他高優先順序工作將優先處理，並且能夠從此工作重新排入任務佇列。 您可以使用更新作業 API 建立作業之後，更新作業的allowTaskPreemption。
allowTaskPreemption?: boolean屬性值
boolean
allTasksCompleteMode
當此排程下建立之作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 請注意，如果作業不包含任何工作，則所有工作都會被視為完成。 因此，此選項最常與作業管理員工作搭配使用;如果您想要在沒有作業管理員的情況下使用自動作業終止，您應該一開始將 onAllTasksComplete 設定為 noaction，並更新 Job 屬性以在完成新增工作之後，將 OnAllTasksComplete 設定為 terminatejob。 預設值為 noaction。
allTasksCompleteMode?: BatchAllTasksCompleteMode屬性值
commonEnvironmentSettings
一般環境變數設定的清單。 這些環境變數會針對在此排程下建立的所有工作設定（包括作業管理員、作業準備和作業發行工作）。 個別工作可以藉由使用不同的值來指定相同的設定名稱，來覆寫此處指定的環境設定。
commonEnvironmentSettings?: EnvironmentSetting[]屬性值
constraints
displayName
在此排程下建立之作業的顯示名稱。 名稱不一定是唯一的，而且可以包含最大長度為1024的任何Unicode字元。
displayName?: string屬性值
string
jobManagerTask
此排程下啟動作業時要啟動之作業管理員工作的詳細數據。 如果作業未指定作業管理員工作，用戶必須使用工作 API 明確地將工作新增至作業。 如果作業確實指定作業管理員工作，Batch 服務會在建立作業時建立作業管理員工作，並且會嘗試排程作業管理員工作，再排程作業中的其他工作。
jobManagerTask?: BatchJobManagerTask屬性值
jobPreparationTask
在此排程下建立之作業的作業準備工作。 如果作業有作業準備工作，Batch 服務會在節點上執行作業準備工作，然後再在該計算節點上啟動該作業的任何工作。
jobPreparationTask?: BatchJobPreparationTask屬性值
jobReleaseTask
在此排程下建立之作業的作業發行工作。 作業發行工作的主要目的是復原作業準備工作所做的節點變更。 範例活動包括刪除本機檔案，或關閉在作業準備時啟動的服務。 若未同時指定作業的作業準備工作，就無法指定作業發行工作。 Batch 服務會在已執行作業準備工作的計算節點上執行作業發行工作。
jobReleaseTask?: BatchJobReleaseTask屬性值
maxParallelTasks
工作可以平行執行的工作數目上限。 （此屬性預設無法使用。如需詳細資訊，請聯絡支援人員）maxParallelTasks 的值必須為 -1 或大於 0（如果指定）。 如果未指定，預設值為 -1，這表示可以一次執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。
maxParallelTasks?: number屬性值
number
metadata
與此排程下建立的每個作業相關聯的名稱/值組清單，做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
metadata?: BatchMetadataItem[]屬性值
networkConfiguration
（此屬性預設無法使用。請聯絡支援人員以取得更多資訊）任務的網路設定。
networkConfiguration?: BatchJobNetworkConfiguration屬性值
poolInfo
priority
在此排程下建立之作業的優先順序。 優先順序值的範圍可以從 -1000 到 1000，-1000 是最低優先順序，1000 是最高優先順序。 預設值為 0。 此優先順序會作為 [作業排程] 下所有作業的預設值。 您可以使用更新作業 API 來建立作業之後，更新作業的優先順序。
priority?: number屬性值
number
taskFailureMode
當此排程下建立之作業中的任何工作失敗時，Batch 服務應該採取的動作。 如果失敗Info，工作就會被視為失敗。 如果 Task 在結束重試計數後以非零結束代碼完成，或啟動工作時發生錯誤，例如資源文件下載錯誤，則會設定 failureInfo。 預設值為 noaction。
taskFailureMode?: BatchTaskFailureMode屬性值
usesTaskDependencies
作業中的工作是否可以定義彼此的相依性。 預設值為 false。
usesTaskDependencies?: boolean屬性值
boolean