BatchJob interface

套件:
@azure/batch

An Azure Batch Job.

屬性

allowTaskPreemption

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

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

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

作業的執行條件約束。
creationTime

作業的建立時間。
displayName

工作的顯示名稱。
eTag

作業的ETag。 這是不透明的字串。 您可以使用它來偵測作業是否已在要求之間變更。 特別是，您可以在更新作業時傳遞 ETag，以指定只有當其他人同時沒有修改作業時，您的變更才會生效。
executionInfo

作業的執行資訊。
id

可唯一識別帳戶內作業的字串。 標識符是區分大小寫和不區分大小寫的（也就是說，您可能不會在帳戶內有兩個標識符，只有大小寫不同）。
jobManagerTask

作業啟動時要啟動之作業管理員工作的詳細數據。
jobPreparationTask

作業準備工作。 作業準備工作是在作業的任何其他工作之前，在每個計算節點上執行的特殊工作。
jobReleaseTask

作業發行工作。 作業發行工作是工作在作業結束時執行的每個計算節點上執行的特殊工作，該節點已執行作業的任何其他工作。
jobStatistics

作業整個存留期的資源使用量統計數據。 只有在使用包含 『stats』 屬性的 expand 子句擷取 BatchJob 時，才會填入此屬性;否則為 null。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。
lastModified

作業的最後一次修改時間。 這是作業層級數據上次變更的時間，例如作業狀態或優先順序。 它不會考慮工作層級變更，例如新增工作或工作變更狀態。
maxParallelTasks

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

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

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

與作業相關聯的集區設定。
previousState

作業的先前狀態。 如果作業處於初始作用中狀態，則不會設定這個屬性。
previousStateTransitionTime

作業進入其先前狀態的時間。 如果作業處於初始作用中狀態，則不會設定這個屬性。
priority

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

作業的目前狀態。
stateTransitionTime

作業進入其目前狀態的時間。
taskFailureMode

當作業中的任何工作失敗時，Batch 服務應該採取的動作。 如果失敗Info，工作會被視為失敗。 如果 Task 在結束重試計數後以非零結束代碼完成，或啟動工作時發生錯誤，例如資源文件下載錯誤，則會設定 failureInfo。 預設值為 noaction。
url

作業的 URL。
usesTaskDependencies

作業中的工作是否可以定義彼此的相依性。 預設值為 false。

屬性詳細資料

allowTaskPreemption

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

allowTaskPreemption?: boolean

屬性值

boolean

allTasksCompleteMode

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

allTasksCompleteMode?: BatchAllTasksCompleteMode

屬性值

BatchAllTasksCompleteMode

commonEnvironmentSettings

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

commonEnvironmentSettings?: EnvironmentSetting[]

屬性值

EnvironmentSetting[]

constraints

作業的執行條件約束。

constraints?: BatchJobConstraints

屬性值

BatchJobConstraints

creationTime

作業的建立時間。

creationTime: Date

屬性值

Date

displayName

工作的顯示名稱。

displayName?: string

屬性值

string

eTag

作業的ETag。 這是不透明的字串。 您可以使用它來偵測作業是否已在要求之間變更。 特別是，您可以在更新作業時傳遞 ETag，以指定只有當其他人同時沒有修改作業時，您的變更才會生效。

eTag: string

屬性值

string

executionInfo

作業的執行資訊。

executionInfo?: BatchJobExecutionInfo

屬性值

BatchJobExecutionInfo

id

可唯一識別帳戶內作業的字串。 標識符是區分大小寫和不區分大小寫的（也就是說，您可能不會在帳戶內有兩個標識符，只有大小寫不同）。

id: string

屬性值

string

jobManagerTask

作業啟動時要啟動之作業管理員工作的詳細數據。

jobManagerTask?: BatchJobManagerTask

屬性值

BatchJobManagerTask

jobPreparationTask

作業準備工作。 作業準備工作是在作業的任何其他工作之前，在每個計算節點上執行的特殊工作。

jobPreparationTask?: BatchJobPreparationTask

屬性值

BatchJobPreparationTask

jobReleaseTask

作業發行工作。 作業發行工作是工作在作業結束時執行的每個計算節點上執行的特殊工作，該節點已執行作業的任何其他工作。

jobReleaseTask?: BatchJobReleaseTask

屬性值

BatchJobReleaseTask

jobStatistics

作業整個存留期的資源使用量統計數據。 只有在使用包含 『stats』 屬性的 expand 子句擷取 BatchJob 時，才會填入此屬性;否則為 null。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。

jobStatistics?: BatchJobStatistics

屬性值

BatchJobStatistics

lastModified

作業的最後一次修改時間。 這是作業層級數據上次變更的時間，例如作業狀態或優先順序。 它不會考慮工作層級變更，例如新增工作或工作變更狀態。

lastModified: Date

屬性值

Date

maxParallelTasks

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

maxParallelTasks?: number

屬性值

number

metadata

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

metadata?: BatchMetadataItem[]

屬性值

BatchMetadataItem[]

networkConfiguration

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

networkConfiguration?: BatchJobNetworkConfiguration

屬性值

BatchJobNetworkConfiguration

poolInfo

與作業相關聯的集區設定。

poolInfo: BatchPoolInfo

屬性值

BatchPoolInfo

previousState

作業的先前狀態。 如果作業處於初始作用中狀態，則不會設定這個屬性。

previousState?: BatchJobState

屬性值

BatchJobState

previousStateTransitionTime

作業進入其先前狀態的時間。 如果作業處於初始作用中狀態，則不會設定這個屬性。

previousStateTransitionTime?: Date

屬性值

Date

priority

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

priority?: number

屬性值

number

state

作業的目前狀態。

state: BatchJobState

屬性值

BatchJobState

stateTransitionTime

作業進入其目前狀態的時間。

stateTransitionTime: Date

屬性值

Date

taskFailureMode

當作業中的任何工作失敗時，Batch 服務應該採取的動作。 如果失敗Info，工作會被視為失敗。 如果 Task 在結束重試計數後以非零結束代碼完成，或啟動工作時發生錯誤，例如資源文件下載錯誤，則會設定 failureInfo。 預設值為 noaction。

taskFailureMode?: BatchTaskFailureMode

屬性值

BatchTaskFailureMode

url

作業的 URL。

url: string

屬性值

string

usesTaskDependencies

作業中的工作是否可以定義彼此的相依性。 預設值為 false。

usesTaskDependencies?: boolean

屬性值

boolean