Compute Node - Deallocate

Reference

Service:: Batch Service

API Version:: 2024-07-01.20.0

Deallocates the specified Compute Node.
You can deallocate a Compute Node only if it is in an idle or running state.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/deallocate?api-version=2024-07-01.20.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/deallocate?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.
nodeId	path	True	string	The ID of the Compute Node that you want to deallocate.
poolId	path	True	string	The ID of the Pool that contains the Compute Node.
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	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
nodeDeallocateOption	ComputeNodeDeallocateOption	When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue.

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.

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

Node reboot

Sample request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/deallocate?api-version=2024-07-01.20.0



{
  "nodeDeallocateOption": "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.
ComputeNodeDeallocateOption	When to deallocate the Compute Node and what to do with currently running Tasks.
ErrorMessage	An error message received in an Azure Batch error response.
NodeDeallocateParameter	Options for deallocating 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	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.