BatchJob interface

Package:

@azure-rest/batch

An Azure Batch Job.

Properties

allowTaskPreemption	Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API.
constraints	The execution constraints for the Job.
maxParallelTasks	The maximum number of tasks that can be executed in parallel for the job. (This property is not available by default. Please contact support for more information) The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.
metadata	A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
onAllTasksComplete	The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. Possible values: "noaction", "terminatejob"
poolInfo	The Pool settings associated with the Job.
priority	The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.

Property Details

allowTaskPreemption

Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API.

allowTaskPreemption?: boolean

Property Value

boolean

constraints

The execution constraints for the Job.

constraints?: BatchJobConstraints

Property Value

BatchJobConstraints

maxParallelTasks

The maximum number of tasks that can be executed in parallel for the job. (This property is not available by default. Please contact support for more information) The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.

maxParallelTasks?: number

Property Value

number

metadata

A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

metadata?: BatchMetadataItem[]

Property Value

BatchMetadataItem[]

onAllTasksComplete

The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction.

Possible values: "noaction", "terminatejob"

onAllTasksComplete?: string

Property Value

string

poolInfo

The Pool settings associated with the Job.

poolInfo: BatchPoolInfo

Property Value

BatchPoolInfo

priority

The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.

priority?: number

Property Value

number