Sign in

v1

latestSwagger 2.02026-07-1377151733.6 KB
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'

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'
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 in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

totalTasksRuninteger
runningTasksCountinteger
totalTasksSucceededinteger
isDedicatedboolean