Nodes

Deallocates the specified Compute Node.

Changed on

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

post/pools/{poolId}/nodes/{nodeId}/deallocate

Request

  • Base URL
    {endpoint}
  • Auth
    OAuth 2
    Implicithttps://login.microsoftonline.com/common/oauth2/v2.0/authorize
    Scopeshttps://batch.core.windows.net//.default

Path parameters

poolIdstring required

The ID of the Pool that contains the Compute Node.

nodeIdstring required

The ID of the Compute Node that you want to restart.

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

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.

Request body

nodeDeallocateOption'requeue' | 'terminate' | 'taskcompletion' | 'retaineddata'

BatchNodeDeallocateOption enums

Response

The request has been accepted for processing, but processing has not yet completed.

Changes

    • warning

      deleted the query request parameter timeout

    • info

      api operation id ComputeNode_Deallocate removed and replaced with Nodes_DeallocateNode

    • info

      api tag Nodes added

    2 more changes in this revision