Job class
代表作業的類別。
建構函式
| Job(Batch |
建立作業。 |
方法
建構函式詳細資料
Job(BatchServiceClientContext)
方法詳細資料
add(JobAddParameter, JobAddOptionalParams)
Batch 服務支援兩種方式來控制在作業中完成的工作。 在第一種方法中，使用者指定作業管理員工作。 Batch 服務會在準備好啟動作業時啟動此工作。 作業管理員工作會使用工作 API 控制在此作業下執行的其他所有工作。 在第二種方法中，使用者會使用工作 API，直接控制使用中作業下的工作執行。 另請注意：命名作業時，請避免包含敏感性資訊，例如用戶名稱或秘密項目名稱。 此資訊可能會出現在可供Microsoft支持工程師存取的遙測記錄中。
function add(job: JobAddParameter, options?: JobAddOptionalParams): Promise<JobAddResponse>參數
- job
- JobAddParameter
要加入的作業。
- options
- JobAddOptionalParams
選擇性參數
傳回
Promise<JobAddResponse>
承諾<Models.JobAddResponse>
add(JobAddParameter, JobAddOptionalParams, ServiceCallback<void>)
function add(job: JobAddParameter, options: JobAddOptionalParams, callback: ServiceCallback<void>)參數
- job
- JobAddParameter
要加入的作業。
- options
- JobAddOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
add(JobAddParameter, ServiceCallback<void>)
function add(job: JobAddParameter, callback: ServiceCallback<void>)參數
- job
- JobAddParameter
要加入的作業。
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, JobDeleteMethodOptionalParams)
刪除作業也會刪除屬於該作業的所有工作，以及所有作業統計數據。 這也會覆寫工作數據的保留期間;也就是說，如果作業包含仍在計算節點上保留的工作，Batch 服務會刪除這些工作的工作目錄及其所有內容。 收到刪除作業要求時，Batch 服務會將作業設定為刪除狀態。 處於刪除狀態之作業的所有更新作業都會失敗，狀態代碼為 409 （衝突），並顯示正在刪除作業的其他資訊。
function deleteMethod(jobId: string, options?: JobDeleteMethodOptionalParams): Promise<JobDeleteResponse>參數
- jobId
-
string
要刪除之作業的識別碼。
- options
- JobDeleteMethodOptionalParams
選擇性參數
傳回
Promise<JobDeleteResponse>
承諾<Models.JobDeleteResponse>
deleteMethod(string, JobDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, options: JobDeleteMethodOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
要刪除之作業的識別碼。
- options
- JobDeleteMethodOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(jobId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
要刪除之作業的識別碼。
- callback
-
ServiceCallback<void>
回呼
disable(string, DisableJobOption, JobDisableOptionalParams)
Batch 服務會立即將作業移至停用狀態。 Batch 接著會使用 disableTasks 參數來判斷作業目前執行中工作要執行的動作。 作業會保持停用狀態，直到停用作業完成，且所有工作都已根據 disableTasks 選項處理;作業接著會移至停用狀態。 在 [作業] 下不會啟動任何新工作，直到它回到使用中狀態為止。 如果您嘗試停用非使用中、停用或停用狀態的作業，要求會失敗，狀態代碼為 409。
function disable(jobId: string, disableTasks: DisableJobOption, options?: JobDisableOptionalParams): Promise<JobDisableResponse>參數
- jobId
-
string
要停用之作業的標識碼。
- disableTasks
- DisableJobOption
與作業相關聯的使用中工作該怎麼辦。 可能的值包括：'requeue'、'terminate'、'wait'
- options
- JobDisableOptionalParams
選擇性參數
傳回
Promise<JobDisableResponse>
承諾<Models.JobDisableResponse>
disable(string, DisableJobOption, JobDisableOptionalParams, ServiceCallback<void>)
function disable(jobId: string, disableTasks: DisableJobOption, options: JobDisableOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
要停用之作業的標識碼。
- disableTasks
- DisableJobOption
與作業相關聯的使用中工作該怎麼辦。 可能的值包括：'requeue'、'terminate'、'wait'
- options
- JobDisableOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
disable(string, DisableJobOption, ServiceCallback<void>)
function disable(jobId: string, disableTasks: DisableJobOption, callback: ServiceCallback<void>)參數
- jobId
-
string
要停用之作業的標識碼。
- disableTasks
- DisableJobOption
與作業相關聯的使用中工作該怎麼辦。 可能的值包括：'requeue'、'terminate'、'wait'
- callback
-
ServiceCallback<void>
回呼
enable(string, JobEnableOptionalParams)
當您呼叫此 API 時，Batch 服務會將停用的作業設定為啟用狀態。 完成此作業之後，作業會移至使用中狀態，並在作業繼續下排程新的工作。 Batch 服務不允許工作保持作用中狀態超過 180 天。 因此，如果您啟用作業，其中包含超過180天前新增的作用中工作，這些工作將不會執行。
function enable(jobId: string, options?: JobEnableOptionalParams): Promise<JobEnableResponse>參數
- jobId
-
string
要啟用之作業的標識碼。
- options
- JobEnableOptionalParams
選擇性參數
傳回
Promise<JobEnableResponse>
承諾<Models.JobEnableResponse>
enable(string, JobEnableOptionalParams, ServiceCallback<void>)
function enable(jobId: string, options: JobEnableOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
要啟用之作業的標識碼。
- options
- JobEnableOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
enable(string, ServiceCallback<void>)
function enable(jobId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
要啟用之作業的標識碼。
- callback
-
ServiceCallback<void>
回呼
get(string, JobGetOptionalParams)
function get(jobId: string, options?: JobGetOptionalParams): Promise<JobGetResponse>參數
- jobId
-
string
作業的標識碼。
- options
- JobGetOptionalParams
選擇性參數
傳回
Promise<JobGetResponse>
承諾<Models.JobGetResponse>
get(string, JobGetOptionalParams, ServiceCallback<CloudJob>)
function get(jobId: string, options: JobGetOptionalParams, callback: ServiceCallback<CloudJob>)參數
- jobId
-
string
作業的標識碼。
- options
- JobGetOptionalParams
選擇性參數
- callback
回呼
get(string, ServiceCallback<CloudJob>)
function get(jobId: string, callback: ServiceCallback<CloudJob>)參數
- jobId
-
string
作業的標識碼。
- callback
回呼
getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptionalParams)
統計數據會匯總到帳戶中所有已存在的作業，從帳戶建立到統計數據的上次更新時間。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。
function getAllLifetimeStatistics(options?: JobGetAllLifetimeStatisticsOptionalParams): Promise<JobGetAllLifetimeStatisticsResponse>參數
選擇性參數
傳回
Promise<JobGetAllLifetimeStatisticsResponse>
Promise<Models.JobGetAllLifetimeStatisticsResponse>
getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptionalParams, ServiceCallback<JobStatistics>)
function getAllLifetimeStatistics(options: JobGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<JobStatistics>)參數
選擇性參數
- callback
回呼
getAllLifetimeStatistics(ServiceCallback<JobStatistics>)
function getAllLifetimeStatistics(callback: ServiceCallback<JobStatistics>)參數
- callback
回呼
getTaskCounts(string, JobGetTaskCountsOptionalParams)
工作計數會依作用中、執行中或已完成的工作狀態，以及成功或失敗的工作計數來提供工作計數。 準備狀態中的工作會計算為執行中。 請注意，傳回的數位不一定是最新的。 如果您需要確切的工作計數，請使用清單查詢。
function getTaskCounts(jobId: string, options?: JobGetTaskCountsOptionalParams): Promise<JobGetTaskCountsResponse>參數
- jobId
-
string
作業的標識碼。
- options
- JobGetTaskCountsOptionalParams
選擇性參數
傳回
Promise<JobGetTaskCountsResponse>
承諾<Models.JobGetTaskCountsResponse>
getTaskCounts(string, JobGetTaskCountsOptionalParams, ServiceCallback<TaskCountsResult>)
function getTaskCounts(jobId: string, options: JobGetTaskCountsOptionalParams, callback: ServiceCallback<TaskCountsResult>)參數
- jobId
-
string
作業的標識碼。
- options
- JobGetTaskCountsOptionalParams
選擇性參數
- callback
回呼
getTaskCounts(string, ServiceCallback<TaskCountsResult>)
function getTaskCounts(jobId: string, callback: ServiceCallback<TaskCountsResult>)參數
- jobId
-
string
作業的標識碼。
- callback
回呼
list(JobListOptionalParams)
function list(options?: JobListOptionalParams): Promise<JobListResponse>參數
- options
- JobListOptionalParams
選擇性參數
傳回
Promise<JobListResponse>
承諾<Models.JobListResponse>
list(JobListOptionalParams, ServiceCallback<CloudJobListResult>)
function list(options: JobListOptionalParams, callback: ServiceCallback<CloudJobListResult>)參數
- options
- JobListOptionalParams
選擇性參數
- callback
回呼
list(ServiceCallback<CloudJobListResult>)
function list(callback: ServiceCallback<CloudJobListResult>)參數
- callback
回呼
listFromJobSchedule(string, JobListFromJobScheduleOptionalParams)
function listFromJobSchedule(jobScheduleId: string, options?: JobListFromJobScheduleOptionalParams): Promise<JobListFromJobScheduleResponse>參數
- jobScheduleId
-
string
您要從中取得作業清單之作業排程的識別碼。
選擇性參數
傳回
Promise<JobListFromJobScheduleResponse>
承諾<Models.JobListFromJobScheduleResponse>
listFromJobSchedule(string, JobListFromJobScheduleOptionalParams, ServiceCallback<CloudJobListResult>)
function listFromJobSchedule(jobScheduleId: string, options: JobListFromJobScheduleOptionalParams, callback: ServiceCallback<CloudJobListResult>)參數
- jobScheduleId
-
string
您要從中取得作業清單之作業排程的識別碼。
選擇性參數
- callback
回呼
listFromJobSchedule(string, ServiceCallback<CloudJobListResult>)
function listFromJobSchedule(jobScheduleId: string, callback: ServiceCallback<CloudJobListResult>)參數
- jobScheduleId
-
string
您要從中取得作業清單之作業排程的識別碼。
- callback
回呼
listFromJobScheduleNext(string, JobListFromJobScheduleNextOptionalParams)
function listFromJobScheduleNext(nextPageLink: string, options?: JobListFromJobScheduleNextOptionalParams): Promise<JobListFromJobScheduleResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
傳回
Promise<JobListFromJobScheduleResponse>
承諾<Models.JobListFromJobScheduleResponse>
listFromJobScheduleNext(string, JobListFromJobScheduleNextOptionalParams, ServiceCallback<CloudJobListResult>)
function listFromJobScheduleNext(nextPageLink: string, options: JobListFromJobScheduleNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
- callback
回呼
listFromJobScheduleNext(string, ServiceCallback<CloudJobListResult>)
function listFromJobScheduleNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- callback
回呼
listNext(string, JobListNextOptionalParams)
function listNext(nextPageLink: string, options?: JobListNextOptionalParams): Promise<JobListResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- options
- JobListNextOptionalParams
選擇性參數
傳回
Promise<JobListResponse>
承諾<Models.JobListResponse>
listNext(string, JobListNextOptionalParams, ServiceCallback<CloudJobListResult>)
function listNext(nextPageLink: string, options: JobListNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- options
- JobListNextOptionalParams
選擇性參數
- callback
回呼
listNext(string, ServiceCallback<CloudJobListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
- callback
回呼
listPreparationAndReleaseTaskStatus(string, JobListPreparationAndReleaseTaskStatusOptionalParams)
此 API 會傳回已執行作業準備或作業釋放工作之所有計算節點上的工作準備和作業發行工作狀態。 這包括自那以後已從集區中移除的計算節點。 如果在沒有作業準備或作業釋放工作的作業上叫用此 API，Batch 服務會傳回 HTTP 狀態代碼 409 （衝突），並傳回 JobPreparationTaskNotSpecified 的錯誤碼。
function listPreparationAndReleaseTaskStatus(jobId: string, options?: JobListPreparationAndReleaseTaskStatusOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>參數
- jobId
-
string
作業的標識碼。
選擇性參數
傳回
承諾<模型.JobListPreparationAndReleaseTaskStatusResponse>
listPreparationAndReleaseTaskStatus(string, JobListPreparationAndReleaseTaskStatusOptionalParams, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatus(jobId: string, options: JobListPreparationAndReleaseTaskStatusOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)參數
- jobId
-
string
作業的標識碼。
選擇性參數
listPreparationAndReleaseTaskStatus(string, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatus(jobId: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)參數
- jobId
-
string
作業的標識碼。
listPreparationAndReleaseTaskStatusNext(string, JobListPreparationAndReleaseTaskStatusNextOptionalParams)
此 API 會傳回已執行作業準備或作業釋放工作之所有計算節點上的工作準備和作業發行工作狀態。 這包括自那以後已從集區中移除的計算節點。 如果在沒有作業準備或作業釋放工作的作業上叫用此 API，Batch 服務會傳回 HTTP 狀態代碼 409 （衝突），並傳回 JobPreparationTaskNotSpecified 的錯誤碼。
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options?: JobListPreparationAndReleaseTaskStatusNextOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
傳回
承諾<模型.JobListPreparationAndReleaseTaskStatusResponse>
listPreparationAndReleaseTaskStatusNext(string, JobListPreparationAndReleaseTaskStatusNextOptionalParams, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options: JobListPreparationAndReleaseTaskStatusNextOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
選擇性參數
listPreparationAndReleaseTaskStatusNext(string, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)參數
- nextPageLink
-
string
上一次成功呼叫 List 作業的 NextLink。
patch(string, JobPatchParameter, JobPatchOptionalParams)
這隻會取代要求中指定的 Job 屬性。 例如，如果 Job 有條件約束，且要求未指定條件約束專案，則 Job 會保留現有的條件約束。
function patch(jobId: string, jobPatchParameter: JobPatchParameter, options?: JobPatchOptionalParams): Promise<JobPatchResponse>參數
- jobId
-
string
您要更新其屬性的作業識別碼。
- jobPatchParameter
- JobPatchParameter
要求的參數。
- options
- JobPatchOptionalParams
選擇性參數
傳回
Promise<JobPatchResponse>
承諾<Models.JobPatchResponse>
patch(string, JobPatchParameter, JobPatchOptionalParams, ServiceCallback<void>)
function patch(jobId: string, jobPatchParameter: JobPatchParameter, options: JobPatchOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
您要更新其屬性的作業識別碼。
- jobPatchParameter
- JobPatchParameter
要求的參數。
- options
- JobPatchOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
patch(string, JobPatchParameter, ServiceCallback<void>)
function patch(jobId: string, jobPatchParameter: JobPatchParameter, callback: ServiceCallback<void>)參數
- jobId
-
string
您要更新其屬性的作業識別碼。
- jobPatchParameter
- JobPatchParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼
terminate(string, JobTerminateOptionalParams)
收到終止作業要求時，Batch 服務會將作業設定為終止狀態。 Batch 服務接著會終止與作業相關聯的任何執行中工作，並執行任何必要的作業發行工作。 然後作業會進入已完成的狀態。 如果作業有任何工作處於作用中狀態，它們會維持在作用中狀態。 一旦工作終止，就無法新增新的工作，也不會排程任何剩餘的作用中工作。
function terminate(jobId: string, options?: JobTerminateOptionalParams): Promise<JobTerminateResponse>參數
- jobId
-
string
要終止之作業的標識碼。
- options
- JobTerminateOptionalParams
選擇性參數
傳回
Promise<JobTerminateResponse>
承諾<Models.JobTerminateResponse>
terminate(string, JobTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, options: JobTerminateOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
要終止之作業的標識碼。
- options
- JobTerminateOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
terminate(string, ServiceCallback<void>)
function terminate(jobId: string, callback: ServiceCallback<void>)參數
- jobId
-
string
要終止之作業的標識碼。
- callback
-
ServiceCallback<void>
回呼
update(string, JobUpdateParameter, JobUpdateOptionalParams)
這會完全取代作業的所有可更新屬性。 例如，如果 Job 有與其相關聯的條件約束，且未使用此要求指定條件約束，則 Batch 服務將會移除現有的條件約束。
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options?: JobUpdateOptionalParams): Promise<JobUpdateResponse>參數
- jobId
-
string
您要更新其屬性的作業識別碼。
- jobUpdateParameter
- JobUpdateParameter
要求的參數。
- options
- JobUpdateOptionalParams
選擇性參數
傳回
Promise<JobUpdateResponse>
承諾<模型.JobUpdate回應>
update(string, JobUpdateParameter, JobUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options: JobUpdateOptionalParams, callback: ServiceCallback<void>)參數
- jobId
-
string
您要更新其屬性的作業識別碼。
- jobUpdateParameter
- JobUpdateParameter
要求的參數。
- options
- JobUpdateOptionalParams
選擇性參數
- callback
-
ServiceCallback<void>
回呼
update(string, JobUpdateParameter, ServiceCallback<void>)
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, callback: ServiceCallback<void>)參數
- jobId
-
string
您要更新其屬性的作業識別碼。
- jobUpdateParameter
- JobUpdateParameter
要求的參數。
- callback
-
ServiceCallback<void>
回呼