ComputeNode Class

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

ComputeNode.cs

Summarizes the state of a compute node.

public class ComputeNode : Microsoft.Azure.Batch.IInheritedBehaviors, Microsoft.Azure.Batch.IRefreshable

type ComputeNode = class
    interface IRefreshable
    interface IInheritedBehaviors

Public Class ComputeNode
Implements IInheritedBehaviors, IRefreshable

Inheritance

Object

ComputeNode

Implements

IInheritedBehaviors IRefreshable

Properties

AffinityId	Gets an opaque string that contains information about the location of the compute node.
AllocationTime	Gets the time at which this compute node was allocated to the pool.
CertificateReferences	Gets the list of certificates installed on this compute node.
CustomBehaviors	Gets or sets a list of behaviors that modify or customize requests to the Batch service made via this ComputeNode.
EndpointConfiguration	Gets the endpoint configuration for the compute node.
Errors	Gets the list of errors that are currently being encountered by the compute node.
Id	Gets the id of compute node.
IPAddress	Gets the IP address associated with the compute node.
IsDedicated	Gets whether this compute node is a dedicated node. If false, the node is a low-priority node.
LastBootTime	Gets the time at which the compute node was started.
NodeAgentInformation	Gets information about the node agent version and the time the node upgraded to a new version.
RecentTasks	Gets the execution information for the most recent tasks that ran on this compute node. Note that this element is only returned if at least one task was run on this compute node since the time it was assigned to its current pool.
RunningTasksCount	Gets the total number of currently running tasks on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
RunningTaskSlotsCount	Gets 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	Gets whether the node is available for task scheduling.
StartTask	Gets the start task associated with all compute nodes in this pool.
StartTaskInformation	Gets the detailed runtime information of the start task, including current state, error details, exit code, start time, end time, etc.
State	Gets the current state of the compute node.
StateTransitionTime	Gets the time at which the compute node entered the current state.
TotalTasksRun	Gets the number of tasks that have been run on this compute node from the time it was allocated to this pool. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
TotalTasksSucceeded	Gets the total number of tasks which completed successfully (with exitCode 0) on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
Url	Gets the URL of compute node.
VirtualMachineInfo	Gets info about the current state of the virtual machine.
VirtualMachineSize	Gets the size of the virtual machine hosting the compute node.

Methods

CopyNodeFileContentToStream(String, Stream, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>)	Copies the contents of a file from the node to the given Stream.
CopyNodeFileContentToStreamAsync(String, Stream, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>, CancellationToken)	Copies the contents of a file from the node to the given Stream.
CopyNodeFileContentToString(String, Encoding, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>)	Reads the contents of a file from the specified node into a string.
CopyNodeFileContentToStringAsync(String, Encoding, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>, CancellationToken)	Reads the contents of a file from the specified node into a string.
CreateComputeNodeUser()	Instantiates an unbound ComputeNodeUser object to be populated by the caller and used to create a user account on the compute node in the Azure Batch service.
DeleteComputeNodeUser(String, IEnumerable<BatchClientBehavior>)	Blocking call to delete the specified ComputeNodeUser.
DeleteComputeNodeUserAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to delete the specified ComputeNodeUser.
DisableScheduling(Nullable<DisableComputeNodeSchedulingOption>, IEnumerable<BatchClientBehavior>)	Disables task scheduling on the compute node.
DisableSchedulingAsync(Nullable<DisableComputeNodeSchedulingOption>, IEnumerable<BatchClientBehavior>, CancellationToken)	Disables task scheduling on the compute node.
EnableScheduling(IEnumerable<BatchClientBehavior>)	Enables task scheduling on the compute node.
EnableSchedulingAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Enables task scheduling on the compute node.
GetNodeFile(String, IEnumerable<BatchClientBehavior>)	Blocking call to get the specified NodeFile.
GetNodeFileAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous request to get the specified NodeFile.
GetRDPFile(Stream, IEnumerable<BatchClientBehavior>)	Blocking call to get RDP file data targeting the compute node of the current instance and write them to a specified Stream.
GetRDPFile(String, IEnumerable<BatchClientBehavior>)	Blocking call to get RDP file data targeting the compute node of the current instance and write them to a file with the specified name.
GetRDPFileAsync(Stream, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to get RDP file data targeting the compute node of the current instance and write them to a specified Stream.
GetRDPFileAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to get RDP file data targeting the compute node of the current instance and write them to a file with the specified name.
GetRemoteLoginSettings(IEnumerable<BatchClientBehavior>)	Gets the settings required for remote login to a compute node.
GetRemoteLoginSettingsAsync(IEnumerable<BatchClientBehavior>, CancellationToken)	Gets the settings required for remote login to a compute node.
ListNodeFiles(Nullable<Boolean>, DetailLevel, IEnumerable<BatchClientBehavior>)	Exposes synchronous and asynchronous enumeration of the files for the node.
Reboot(Nullable<ComputeNodeRebootOption>, IEnumerable<BatchClientBehavior>)	Blocking call to reboot the compute node.
RebootAsync(Nullable<ComputeNodeRebootOption>, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to reboot the compute node.
Refresh(DetailLevel, IEnumerable<BatchClientBehavior>)	Refreshes the ComputeNode.
RefreshAsync(DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)	Refreshes the current ComputeNode.
Reimage(Nullable<ComputeNodeReimageOption>, IEnumerable<BatchClientBehavior>)	Blocking call to reimage the compute node.
ReimageAsync(Nullable<ComputeNodeReimageOption>, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to reimage the compute node.
RemoveFromPool(Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>)	Blocking call to remove the compute node from the pool.
RemoveFromPoolAsync(Nullable<ComputeNodeDeallocationOption>, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to remove the compute node from the pool.
UploadComputeNodeBatchServiceLogs(String, ComputeNodeIdentityReference, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>)	Upload Azure Batch service log files from the specified compute node.
UploadComputeNodeBatchServiceLogs(String, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>)	Upload Azure Batch service log files from the specified compute node.
UploadComputeNodeBatchServiceLogsAsync(String, ComputeNodeIdentityReference, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken)	Upload Azure Batch service log files from the compute node.
UploadComputeNodeBatchServiceLogsAsync(String, DateTime, Nullable<DateTime>, IEnumerable<BatchClientBehavior>, CancellationToken)	Upload Azure Batch service log files from the compute node.