Share via


BatchTaskState Struct

Definition

BatchTaskState enums.

public readonly struct BatchTaskState : IEquatable<Azure.Compute.Batch.BatchTaskState>
type BatchTaskState = struct
Public Structure BatchTaskState
Implements IEquatable(Of BatchTaskState)
Inheritance
BatchTaskState
Implements

Constructors

BatchTaskState(String)

Initializes a new instance of BatchTaskState.

Properties

Active

The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run.

Completed

The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated.

Preparing

The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node.

Running

The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing.

Methods

Equals(BatchTaskState)

Indicates whether the current object is equal to another object of the same type.

ToString()

Returns the fully qualified type name of this instance.

Operators

Equality(BatchTaskState, BatchTaskState)

Determines if two BatchTaskState values are the same.

Implicit(String to BatchTaskState)

Converts a string to a BatchTaskState.

Inequality(BatchTaskState, BatchTaskState)

Determines if two BatchTaskState values are not the same.

Applies to