Job class

Create a Job.

new Job(client: BatchServiceClientContext)

Parameters

The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

function add(job: JobAddParameter, options?: JobAddOptionalParams): Promise<JobAddResponse>

Parameters

Returns

Promise<Models.JobAddResponse>

function add(job: JobAddParameter, options: JobAddOptionalParams, callback: ServiceCallback<void>)

Parameters

function add(job: JobAddParameter, callback: ServiceCallback<void>)

Parameters

Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.

function deleteMethod(jobId: string, options?: JobDeleteMethodOptionalParams): Promise<JobDeleteResponse>

Parameters

Returns

Promise<Models.JobDeleteResponse>

function deleteMethod(jobId: string, options: JobDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Parameters

function deleteMethod(jobId: string, callback: ServiceCallback<void>)

Parameters

The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

function disable(jobId: string, disableTasks: DisableJobOption, options?: JobDisableOptionalParams): Promise<JobDisableResponse>

Parameters

Returns

Promise<Models.JobDisableResponse>

function disable(jobId: string, disableTasks: DisableJobOption, options: JobDisableOptionalParams, callback: ServiceCallback<void>)

Parameters

function disable(jobId: string, disableTasks: DisableJobOption, callback: ServiceCallback<void>)

Parameters

When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run.

function enable(jobId: string, options?: JobEnableOptionalParams): Promise<JobEnableResponse>

Parameters

Returns

Promise<Models.JobEnableResponse>

function enable(jobId: string, options: JobEnableOptionalParams, callback: ServiceCallback<void>)

Parameters

function enable(jobId: string, callback: ServiceCallback<void>)

Parameters

function get(jobId: string, options?: JobGetOptionalParams): Promise<JobGetResponse>

Parameters

Returns

Promise<Models.JobGetResponse>

function get(jobId: string, options: JobGetOptionalParams, callback: ServiceCallback<CloudJob>)

Parameters

function get(jobId: string, callback: ServiceCallback<CloudJob>)

Parameters

Statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

function getAllLifetimeStatistics(options?: JobGetAllLifetimeStatisticsOptionalParams): Promise<JobGetAllLifetimeStatisticsResponse>

Parameters

Returns

Promise<Models.JobGetAllLifetimeStatisticsResponse>

function getAllLifetimeStatistics(options: JobGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<JobStatistics>)

Parameters

function getAllLifetimeStatistics(callback: ServiceCallback<JobStatistics>)

Parameters

Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.

function getTaskCounts(jobId: string, options?: JobGetTaskCountsOptionalParams): Promise<JobGetTaskCountsResponse>

Parameters

Returns

Promise<Models.JobGetTaskCountsResponse>

function getTaskCounts(jobId: string, options: JobGetTaskCountsOptionalParams, callback: ServiceCallback<TaskCountsResult>)

Parameters

function getTaskCounts(jobId: string, callback: ServiceCallback<TaskCountsResult>)

Parameters

function list(options?: JobListOptionalParams): Promise<JobListResponse>

Parameters

Returns

Promise<Models.JobListResponse>

function list(options: JobListOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameters

function list(callback: ServiceCallback<CloudJobListResult>)

Parameters

function listFromJobSchedule(jobScheduleId: string, options?: JobListFromJobScheduleOptionalParams): Promise<JobListFromJobScheduleResponse>

Parameters

Returns

Promise<Models.JobListFromJobScheduleResponse>

function listFromJobSchedule(jobScheduleId: string, options: JobListFromJobScheduleOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameters

function listFromJobSchedule(jobScheduleId: string, callback: ServiceCallback<CloudJobListResult>)

Parameters

function listFromJobScheduleNext(nextPageLink: string, options?: JobListFromJobScheduleNextOptionalParams): Promise<JobListFromJobScheduleResponse>

Parameters

Returns

Promise<Models.JobListFromJobScheduleResponse>

function listFromJobScheduleNext(nextPageLink: string, options: JobListFromJobScheduleNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameters

function listFromJobScheduleNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)

Parameters

function listNext(nextPageLink: string, options?: JobListNextOptionalParams): Promise<JobListResponse>

Parameters

Returns

Promise<Models.JobListResponse>

function listNext(nextPageLink: string, options: JobListNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameters

function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)

Parameters

This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

function listPreparationAndReleaseTaskStatus(jobId: string, options?: JobListPreparationAndReleaseTaskStatusOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>

Parameters

Returns

Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>

function listPreparationAndReleaseTaskStatus(jobId: string, options: JobListPreparationAndReleaseTaskStatusOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameters

function listPreparationAndReleaseTaskStatus(jobId: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameters

This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options?: JobListPreparationAndReleaseTaskStatusNextOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>

Parameters

Returns

Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>

function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options: JobListPreparationAndReleaseTaskStatusNextOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameters

function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameters

This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.

function patch(jobId: string, jobPatchParameter: JobPatchParameter, options?: JobPatchOptionalParams): Promise<JobPatchResponse>

Parameters

Returns

Promise<Models.JobPatchResponse>

function patch(jobId: string, jobPatchParameter: JobPatchParameter, options: JobPatchOptionalParams, callback: ServiceCallback<void>)

Parameters

function patch(jobId: string, jobPatchParameter: JobPatchParameter, callback: ServiceCallback<void>)

Parameters

When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled.

function terminate(jobId: string, options?: JobTerminateOptionalParams): Promise<JobTerminateResponse>

Parameters

Returns

Promise<Models.JobTerminateResponse>

function terminate(jobId: string, options: JobTerminateOptionalParams, callback: ServiceCallback<void>)

Parameters

function terminate(jobId: string, callback: ServiceCallback<void>)

Parameters

This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options?: JobUpdateOptionalParams): Promise<JobUpdateResponse>

Parameters

Returns

Promise<Models.JobUpdateResponse>

function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options: JobUpdateOptionalParams, callback: ServiceCallback<void>)

Parameters

function update(jobId: string, jobUpdateParameter: JobUpdateParameter, callback: ServiceCallback<void>)

Parameters