v22

latestSwagger 2.02026-07-1372236814.0 KB
Jobs

Gets information about the specified Job.

Gets information about the specified Job.

get/jobs/{jobId}

Path parameters

jobIdstring required

The ID of the Job.

Query parameters

api-versionstring required

The API version to use for this operation.

timeOutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

$selectstring[]

An OData $select clause.

$expandstring[]

An OData $expand clause.

Headers

client-request-idstring

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc7231

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

If-Modified-Sincestring date-time-rfc7231

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

If-Unmodified-Sincestring date-time-rfc7231

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

If-Matchstring

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

If-None-Matchstring

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Response

The request has succeeded.

idstring required

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).

displayNamestring

The display name for the Job.

usesTaskDependenciesboolean

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

urlstring uri required

The URL of the Job.

eTagstring required

The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.

It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".

lastModifiedstring date-time required

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.

creationTimestring date-time required

The creation time of the Job.

state'active' | 'disabling' | 'disabled' | 'enabling' | 'terminating' | 'completed' | 'deleting' required

BatchJobState enums

stateTransitionTimestring date-time required

The time at which the Job entered its current state.

previousState'active' | 'disabling' | 'disabled' | 'enabling' | 'terminating' | 'completed' | 'deleting'

BatchJobState enums

previousStateTransitionTimestring date-time

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

priorityinteger

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.

allowTaskPreemptionboolean

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.

maxParallelTasksinteger

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.

onAllTasksComplete'noaction' | 'terminatejob'

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

onTaskFailure'noaction' | 'performexitoptionsjobaction'

TaskFailure enums