BatchNode Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Source:

BatchNode.cs

A Compute Node in the Batch service.

public class BatchNode : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchNode>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchNode>

type BatchNode = class
    interface IJsonModel<BatchNode>
    interface IPersistableModel<BatchNode>

Public Class BatchNode
Implements IJsonModel(Of BatchNode), IPersistableModel(Of BatchNode)

Inheritance

Object

BatchNode

Implements

IJsonModel<BatchNode> IPersistableModel<BatchNode> IPersistableModel<T>

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.
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.
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.
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://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

Explicit Interface Implementations

IJsonModel<BatchNode>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchNode>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchNode>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchNode>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchNode>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.