v22

latestSwagger 2.02026-07-1372236814.0 KB

Nodes

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

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

$selectstring[]

An OData $select clause.

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.

Response

The request has succeeded.

idstring required

The ID of the Compute Node. Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes.

urlstring uri required

The URL of the Compute Node.

BatchNodeState enums

schedulingState'enabled' | 'disabled'

SchedulingState enums

stateTransitionTimestring date-time required

The time at which the Compute Node entered its current state.

lastBootTimestring date-time required

The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable.

allocationTimestring date-time required

The time at which this Compute Node was allocated to the Pool. This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted.

ipAddressstring required

Represent an IP V4 address serialized as a string.

It is formatted as four 8-bit fields separated by periods.

ipv6Addressstring required

Represent an IP V6 address serialized as a string.

It is formatted as eight hex decimal values(16-bit) between 0 and FFFF separated by colon. (i.e. y:y:y:y:y:y:y:y)

affinityIdstring required

An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.

vmSizestring required

The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

totalTasksRuninteger required

The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks.

runningTasksCountinteger

The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks.

runningTaskSlotsCountinteger

The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks.

totalTasksSucceededinteger

The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks.

isDedicatedboolean

Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node.