BatchJobSchedule Class

Definition

A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.

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

Constructors

BatchJobSchedule(BatchJobSpecification)

Initializes a new instance of BatchJobSchedule.

Properties

CreationTime

The creation time of the Job Schedule.

DisplayName

The display name for the schedule.

ETag

The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.

ExecutionInfo

Information about Jobs that have been and will be run under this schedule.

Id

A string that uniquely identifies the schedule within the Account.

JobSpecification

The details of the Jobs to be created on this schedule.

LastModified

The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.

Metadata

A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

PreviousState

The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state.

PreviousStateTransitionTime

The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state.

Schedule

The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.

State

The current state of the Job Schedule.

StateTransitionTime

The time at which the Job Schedule entered the current state.

Stats

The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Url

The URL of the Job Schedule.

Explicit Interface Implementations

IJsonModel<BatchJobSchedule>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<BatchJobSchedule>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchJobSchedule>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchJobSchedule>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<BatchJobSchedule>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to