BatchJobExecutionInfo Class

Definition

Contains information about the execution of a Job in the Azure Batch service.

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

Properties

EndTime

The completion time of the Job. This property is set only if the Job is in the completed state.

PoolId

The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool.

SchedulingError

Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job.

StartTime

The start time of the Job. This is the time at which the Job was created.

TerminationReason

A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation.

Explicit Interface Implementations

IJsonModel<BatchJobExecutionInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<BatchJobExecutionInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchJobExecutionInfo>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchJobExecutionInfo>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<BatchJobExecutionInfo>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to