CloudJob interface
An interface representing CloudJob.
Properties
common |
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. |
creation |
The creation time of the Job. |
display |
The display name for the Job. |
e |
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. |
execution |
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). |
job |
Details of a Job Manager Task to be launched when the Job is started. |
job |
The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. |
job |
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. |
last |
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. |
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. |
network |
The network configuration for the Job. |
on |
The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. Possible values include: 'noAction', 'terminateJob' |
on |
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 include: 'noAction', 'performExitOptionsJobAction' |
pool |
The Pool settings associated with the Job. |
previous |
The previous state of the Job. This property is not set if the Job is in its initial Active state. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting' |
previous |
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 include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting' |
state |
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 CloudJob 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. |
uses |
Whether Tasks in the Job can define dependencies on each other. The default is false. |
Property Details
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?: EnvironmentSetting[]
Property Value
constraints
creationTime
The creation time of the Job.
creationTime?: Date
Property Value
Date
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?: JobExecutionInformation
Property Value
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?: JobManagerTask
Property Value
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?: JobPreparationTask
Property Value
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?: JobReleaseTask
Property Value
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?: Date
Property Value
Date
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?: MetadataItem[]
Property Value
networkConfiguration
The network configuration for the Job.
networkConfiguration?: JobNetworkConfiguration
Property Value
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 include: 'noAction', 'terminateJob'
onAllTasksComplete?: OnAllTasksComplete
Property Value
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 include: 'noAction', 'performExitOptionsJobAction'
onTaskFailure?: OnTaskFailure
Property Value
poolInfo
The Pool settings associated with the Job.
poolInfo?: PoolInformation
Property Value
previousState
The previous state of the Job. This property is not set if the Job is in its initial Active state. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'
previousState?: JobState
Property Value
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?: Date
Property Value
Date
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 include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'
state?: JobState
Property Value
stateTransitionTime
The time at which the Job entered its current state.
stateTransitionTime?: Date
Property Value
Date
stats
Resource usage statistics for the entire lifetime of the Job. This property is populated only if the CloudJob 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?: JobStatistics
Property Value
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