BatchNodeOutput interface

Package:

@azure-rest/batch

A Compute Node in the Batch service.

Properties

affinityId	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.
allocationTime	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.
endpointConfiguration	The endpoint configuration for the Compute Node.
errors	The list of errors that are currently being encountered by the Compute Node.
id	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.
ipAddress	The IP address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute 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 Compute Nodes.
ipv6Address	The IPv6 address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute 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 Compute Nodes. This property will not be present if the Pool is not configured for IPv6.
isDedicated	Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node.
lastBootTime	The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable.
nodeAgentInfo	Information about the Compute Node agent version and the time the Compute Node upgraded to a new version.
recentTasks	A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool.
runningTasksCount	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.
runningTaskSlotsCount	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.
schedulingState	Whether the Compute Node is available for Task scheduling. Possible values: "enabled", "disabled"
startTask	The Task specified to run on the Compute Node as it joins the Pool.
startTaskInfo	Runtime information about the execution of the StartTask on the Compute Node.
state	The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. Possible values: "idle", "rebooting", "reimaging", "running", "unusable", "creating", "starting", "waitingforstarttask", "starttaskfailed", "unknown", "leavingpool", "offline", "preempted", "upgradingos", "deallocated", "deallocating"
stateTransitionTime	The time at which the Compute Node entered its current state.
totalTasksRun	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.
totalTasksSucceeded	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.
url	The URL of the Compute Node.
virtualMachineInfo	Info about the current state of the virtual machine.
vmSize	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).

Property Details

affinityId

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.

affinityId: string

Property Value

string

allocationTime

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.

allocationTime: string

Property Value

string

endpointConfiguration

The endpoint configuration for the Compute Node.

endpointConfiguration?: BatchNodeEndpointConfigurationOutput

Property Value

BatchNodeEndpointConfigurationOutput

errors

The list of errors that are currently being encountered by the Compute Node.

errors?: BatchNodeErrorOutput[]

Property Value

BatchNodeErrorOutput[]

id

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.

id: string

Property Value

string

ipAddress

The IP address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute 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 Compute Nodes.

ipAddress: string

Property Value

string

ipv6Address

The IPv6 address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute 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 Compute Nodes. This property will not be present if the Pool is not configured for IPv6.

ipv6Address: string

Property Value

string

isDedicated

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

isDedicated?: boolean

Property Value

boolean

lastBootTime

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

lastBootTime: string

Property Value

string

nodeAgentInfo

Information about the Compute Node agent version and the time the Compute Node upgraded to a new version.

nodeAgentInfo: BatchNodeAgentInfoOutput

Property Value

BatchNodeAgentInfoOutput

recentTasks

A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool.

recentTasks?: BatchTaskInfoOutput[]

Property Value

BatchTaskInfoOutput[]

runningTasksCount

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.

runningTasksCount?: number

Property Value

number

runningTaskSlotsCount

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.

runningTaskSlotsCount?: number

Property Value

number

schedulingState

Whether the Compute Node is available for Task scheduling.

Possible values: "enabled", "disabled"

schedulingState?: string

Property Value

string

startTask

The Task specified to run on the Compute Node as it joins the Pool.

startTask?: BatchStartTaskOutput

Property Value

BatchStartTaskOutput

startTaskInfo

Runtime information about the execution of the StartTask on the Compute Node.

startTaskInfo?: BatchStartTaskInfoOutput

Property Value

BatchStartTaskInfoOutput

state

The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.

Possible values: "idle", "rebooting", "reimaging", "running", "unusable", "creating", "starting", "waitingforstarttask", "starttaskfailed", "unknown", "leavingpool", "offline", "preempted", "upgradingos", "deallocated", "deallocating"

state: string

Property Value

string

stateTransitionTime

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

stateTransitionTime: string

Property Value

string

totalTasksRun

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.

totalTasksRun: number

Property Value

number

totalTasksSucceeded

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.

totalTasksSucceeded?: number

Property Value

number

url

The URL of the Compute Node.

url: string

Property Value

string

virtualMachineInfo

Info about the current state of the virtual machine.

virtualMachineInfo: VirtualMachineInfoOutput

Property Value

VirtualMachineInfoOutput

vmSize

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

vmSize: string

Property Value

string