Compute Node - Disable Scheduling

Disables Task scheduling on the specified Compute Node.
You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?api-version=2019-06-01.9.0
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?timeout={timeout}&api-version=2019-06-01.9.0

URI Parameters

Name In Required Type Description
batchUrl
path True
  • string

The base URL for all Azure Batch service requests.

poolId
path True
  • string

The ID of the Pool that contains the Compute Node.

nodeId
path True
  • string

The ID of the Compute Node on which you want to disable Task scheduling.

timeout
query
  • integer
int32

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-version
query True
  • string

Client API Version.

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.

Request Body

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

Name Type Description
nodeDisableSchedulingOption

What to do with currently running Tasks when disabling Task scheduling on the Compute Node.
The default value is requeue.

Responses

Name Type Description
200 OK

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

The error from the Batch service.

Security

azure_auth

Azure Active Directory OAuth2 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

Node disable scheduling

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/disablescheduling?api-version=2019-06-01.9.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "nodeDisableSchedulingOption": "terminate"
}

Sample Response

""

Definitions

BatchError

An error response received from the Azure Batch service.

BatchErrorDetail

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

DisableComputeNodeSchedulingOption

What to do with currently running Tasks when disabling Task scheduling on the Compute Node.

ErrorMessage

An error message received in an Azure Batch error response.

NodeDisableSchedulingParameter

Options for disabling scheduling on a Compute Node.

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

A message describing the error, intended to be suitable for display in a user interface.

values

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.

DisableComputeNodeSchedulingOption

What to do with currently running Tasks when disabling Task scheduling on the Compute Node.

Name Type Description
requeue
  • string

Terminate running Task processes and requeue the Tasks. The Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state as soon as Tasks have been terminated.

taskcompletion
  • string

Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed.

terminate
  • string

Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as Tasks have been terminated.

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.

NodeDisableSchedulingParameter

Options for disabling scheduling on a Compute Node.

Name Type Description
nodeDisableSchedulingOption

What to do with currently running Tasks when disabling Task scheduling on the Compute Node.
The default value is requeue.