BatchSubtask Class

Definition

Information about an Azure Batch subtask.

public class BatchSubtask : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchSubtask>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchSubtask>
type BatchSubtask = class
    interface IJsonModel<BatchSubtask>
    interface IPersistableModel<BatchSubtask>
Public Class BatchSubtask
Implements IJsonModel(Of BatchSubtask), IPersistableModel(Of BatchSubtask)
Inheritance
BatchSubtask
Implements

Properties

ContainerInfo

Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.

EndTime

The time at which the subtask completed. This property is set only if the subtask is in the Completed state.

ExitCode

The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

FailureInfo

Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.

Id

The ID of the subtask.

NodeInfo

Information about the Compute Node on which the subtask ran.

PreviousState

The previous state of the subtask. This property is not set if the subtask is in its initial running state.

PreviousStateTransitionTime

The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.

Result

The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.

StartTime

The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running.

State

The current state of the subtask.

StateTransitionTime

The time at which the subtask entered its current state.

Explicit Interface Implementations

IJsonModel<BatchSubtask>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<BatchSubtask>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchSubtask>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchSubtask>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<BatchSubtask>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to