Sign in
ComputeNodes

Gets information about the specified compute node.

get/pools/{poolId}/nodes/{nodeId}

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 get information about.

Query parameters

$selectstring

An OData $select clause.

timeoutinteger

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

api-versionstring required

Client API Version.

Headers

client-request-idstring 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-idboolean

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

ocp-datestring 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.

Response

A response containing the compute node.

idstring

Every node that is added to a pool is assigned a unique ID. Whenever a node is removed from a pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new nodes.

urlstring
state'idle' | 'rebooting' | 'reimaging' | 'running' | 'unusable' | 'creating' | 'starting' | 'waitingForStartTask' | 'startTaskFailed' | 'unknown' | 'leavingPool' | 'offline' | 'preempted'

Values are:

idle - The node is not currently running a task. rebooting - The node is rebooting. reimaging - The node is reimaging. running - The node is running one or more tasks (other than a start task). unusable - The node cannot be used for task execution due to errors. creating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool. starting - the Batch service is starting on the underlying virtual machine. waitingforstarttask - The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed. starttaskfailed - The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks. unknown - The Batch service has lost contact with the node, and does not know its true state. leavingpool - The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down. offline - The node is not currently running a task, and scheduling of new tasks to the node is disabled. preempted - The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available.

schedulingState'enabled' | 'disabled'

Values are:

enabled - Tasks can be scheduled on the node. disabled - No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled.

stateTransitionTimestring date-time
lastBootTimestring date-time

This property may not be present if the node state is unusable.

allocationTimestring date-time
ipAddressstring

Every node that is added to a pool is assigned a unique IP address. Whenever a node is removed from a pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new nodes.

affinityIdstring

Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.

vmSizestring

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

totalTasksRuninteger
runningTasksCountinteger
totalTasksSucceededinteger
isDedicatedboolean

Changes