BatchJobOutput 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.
commonEnvironmentSettings	The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.
constraints	The execution constraints for the Job.
creationTime	The creation time of the Job.
displayName	The display name for the Job.
eTag	The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.
executionInfo	The execution information for the Job.
id	A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).
jobManagerTask	Details of a Job Manager Task to be launched when the Job is started.
jobPreparationTask	The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job.
jobReleaseTask	The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job.
lastModified	The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.
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.
networkConfiguration	(This property is not available by default. Please contact support for more information) The network configuration for the Job.
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"
onTaskFailure	The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. Possible values: "noaction", "performexitoptionsjobaction"
poolInfo	The Pool settings associated with the Job.
previousState	The previous state of the Job. This property is not set if the Job is in its initial Active state. Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"
previousStateTransitionTime	The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state.
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.
state	The current state of the Job. Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"
stateTransitionTime	The time at which the Job entered its current state.
stats	Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
url	The URL of the Job.
usesTaskDependencies	Whether Tasks in the Job can define dependencies on each other. The default is false.

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

commonEnvironmentSettings

The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.

commonEnvironmentSettings?: EnvironmentSettingOutput[]

Property Value

EnvironmentSettingOutput[]

constraints

The execution constraints for the Job.

constraints?: BatchJobConstraintsOutput

Property Value

BatchJobConstraintsOutput

creationTime

The creation time of the Job.

creationTime: string

Property Value

string

displayName

The display name for the Job.

displayName?: string

Property Value

string

eTag

The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.

eTag: string

Property Value

string

executionInfo

The execution information for the Job.

executionInfo?: BatchJobExecutionInfoOutput

Property Value

BatchJobExecutionInfoOutput

id

A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).

id: string

Property Value

string

jobManagerTask

Details of a Job Manager Task to be launched when the Job is started.

jobManagerTask?: BatchJobManagerTaskOutput

Property Value

BatchJobManagerTaskOutput

jobPreparationTask

The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job.

jobPreparationTask?: BatchJobPreparationTaskOutput

Property Value

BatchJobPreparationTaskOutput

jobReleaseTask

The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job.

jobReleaseTask?: BatchJobReleaseTaskOutput

Property Value

BatchJobReleaseTaskOutput

lastModified

The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.

lastModified: string

Property Value

string

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?: BatchMetadataItemOutput[]

Property Value

BatchMetadataItemOutput[]

networkConfiguration

(This property is not available by default. Please contact support for more information) The network configuration for the Job.

networkConfiguration?: BatchJobNetworkConfigurationOutput

Property Value

BatchJobNetworkConfigurationOutput

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

onTaskFailure

The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.

Possible values: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Property Value

string

poolInfo

The Pool settings associated with the Job.

poolInfo: BatchPoolInfoOutput

Property Value

BatchPoolInfoOutput

previousState

The previous state of the Job. This property is not set if the Job is in its initial Active state.

Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"

previousState?: string

Property Value

string

previousStateTransitionTime

The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state.

previousStateTransitionTime?: string

Property Value

string

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

state

The current state of the Job.

Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"

state: string

Property Value

string

stateTransitionTime

The time at which the Job entered its current state.

stateTransitionTime: string

Property Value

string

stats

Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

stats?: BatchJobStatisticsOutput

Property Value

BatchJobStatisticsOutput

url

The URL of the Job.

url: string

Property Value

string

usesTaskDependencies

Whether Tasks in the Job can define dependencies on each other. The default is false.

usesTaskDependencies?: boolean

Property Value

boolean