Job - Disable

Service:

Batch Service

API Version:

2024-07-01.20.0

Disables the specified Job, preventing new Tasks from running.
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.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2024-07-01.20.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2024-07-01.20.0

URI Parameters

Name	In	Required	Type	Description
batchUrl	path	True	string	The base URL for all Azure Batch service requests.
jobId	path	True	string	The ID of the Job to disable.
api-version	query	True	string	Client API Version.
timeout	query		integer int32	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.

Request Header

Media Types: "application/json; odata=minimalmetadata"

Name	Required	Type	Description
client-request-id		string uuid	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-id		boolean	Whether the server should return the client-request-id in the response.
ocp-date		string date-time-rfc1123	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-Match		string	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-Match		string	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.
If-Modified-Since		string date-time-rfc1123	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-Since		string date-time-rfc1123	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.

Request Body

Media Types: "application/json; odata=minimalmetadata"

Name	Required	Type	Description
disableTasks	True	DisableJobOption	What to do with active Tasks associated with the Job.

Responses

Name	Type	Description
202 Accepted		The request to the Batch service was successful. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	The error from the Batch service.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

Job disable

Sample request

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2024-07-01.20.0



{
  "disableTasks": "terminate"
}

Sample response

Status code:

202

Definitions

Name	Description
BatchError	An error response received from the Azure Batch service.
BatchErrorDetail	An item of additional information included in an Azure Batch error response.
DisableJobOption	What to do with active Tasks associated with the Job.
ErrorMessage	An error message received in an Azure Batch error response.
JobDisableParameter	Options when disabling a Job.

BatchError

An error response received from the Azure Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	ErrorMessage	A message describing the error, intended to be suitable for display in a user interface.
values	BatchErrorDetail[]	A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

Name	Type	Description
key	string	An identifier specifying the meaning of the Value property.
value	string	The additional information included with the error response.

DisableJobOption

What to do with active Tasks associated with the Job.

Name	Type	Description
requeue	string	Terminate running Tasks and requeue them. The Tasks will run again when the Job is enabled.
terminate	string	Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again.
wait	string	Allow currently running Tasks to complete.

ErrorMessage

An error message received in an Azure Batch error response.

Name	Type	Description
lang	string	The language code of the error message
value	string	The text of the message.

JobDisableParameter

Options when disabling a Job.

Name	Type	Description
disableTasks	DisableJobOption	What to do with active Tasks associated with the Job.