BatchJobCreateOptions interface

建立 Azure Batch Job 的參數。

屬性

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

allowTaskPreemption

此作業中的工作是否可以由其他高優先順序工作先佔。（此屬性預設無法使用。請聯絡支援人員以取得相關資訊）如果將值設為 True，則提交給系統的其他高優先順序工作將優先處理，並且能夠從此工作重新排入任務佇列。您可以使用更新作業 API 建立作業之後，更新作業的allowTaskPreemption。

allowTaskPreemption?: boolean

屬性值

boolean

allTasksCompleteMode

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

allTasksCompleteMode?: BatchAllTasksCompleteMode

屬性值

BatchAllTasksCompleteMode

commonEnvironmentSettings

一般環境變數設定的清單。這些環境變數是針對作業中的所有工作設定的（包括作業管理員、作業準備和作業發行工作）。個別工作可以藉由使用不同的值來指定相同的設定名稱，來覆寫此處指定的環境設定。

commonEnvironmentSettings?: EnvironmentSetting[]

屬性值

EnvironmentSetting[]

constraints

作業的執行條件約束。

constraints?: BatchJobConstraints

屬性值

BatchJobConstraints

displayName

工作的顯示名稱。顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。

displayName?: string

屬性值

string

id

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

id: string

屬性值

string

jobManagerTask

作業啟動時要啟動之作業管理員工作的詳細數據。如果作業未指定作業管理員工作，用戶必須明確地將工作新增至作業。如果作業確實指定作業管理員工作，Batch 服務會在建立作業時建立作業管理員工作，並且會嘗試排程作業管理員工作，再排程作業中的其他工作。作業管理員工作的典型用途是控制及/或監視作業執行，例如，決定要執行哪些額外的工作、判斷工作何時完成等等。（不過，作業管理員工作不限於這些活動 -- 這是系統中的完整工作，並執行作業所需的任何動作。例如，作業管理員工作可能會下載指定為參數的檔案、分析該檔案的內容，並根據這些內容提交其他工作。

jobManagerTask?: BatchJobManagerTask

屬性值

BatchJobManagerTask

jobPreparationTask

作業準備工作。如果作業有作業準備工作，Batch 服務會在節點上執行作業準備工作，然後再在該計算節點上啟動該作業的任何工作。

jobPreparationTask?: BatchJobPreparationTask

屬性值

BatchJobPreparationTask

jobReleaseTask

作業發行工作。若未同時指定作業的作業準備工作，就無法指定作業發行工作。 Batch 服務會在已執行作業準備工作的節點上執行作業發行工作。作業發行工作的主要目的是復原作業準備工作對計算節點所做的變更。範例活動包括刪除本機檔案，或關閉在作業準備時啟動的服務。

jobReleaseTask?: BatchJobReleaseTask

屬性值

BatchJobReleaseTask

maxParallelTasks

工作可以平行執行的工作數目上限。（此屬性預設無法使用。如需詳細資訊，請聯絡支援人員）maxParallelTasks 的值必須為 -1 或大於 0（如果指定）。如果未指定，預設值為 -1，這表示可以一次執行的工作數目沒有限制。您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。

maxParallelTasks?: number

屬性值

number

metadata

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

metadata?: BatchMetadataItem[]

屬性值

BatchMetadataItem[]

networkConfiguration

（此屬性預設無法使用。請聯絡支援人員以取得更多資訊）任務的網路設定。

networkConfiguration?: BatchJobNetworkConfiguration

屬性值

BatchJobNetworkConfiguration

poolInfo

Batch 服務執行作業工作的集區。

poolInfo: BatchPoolInfo

屬性值

BatchPoolInfo

priority

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

priority?: number

屬性值