BatchJobScheduleOutput interface

Package:

@azure-rest/batch

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

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. Possible values: "active", "completed", "disabled", "terminating", "deleting"
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. Possible values: "active", "completed", "disabled", "terminating", "deleting"
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.

Property Details

creationTime

The creation time of the Job Schedule.

creationTime: string

Property Value

string

displayName

The display name for the schedule.

displayName?: string

Property Value

string

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.

eTag: string

Property Value

string

executionInfo

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

executionInfo: BatchJobScheduleExecutionInfoOutput

Property Value

BatchJobScheduleExecutionInfoOutput

id

A string that uniquely identifies the schedule within the Account.

id: string

Property Value

string

jobSpecification

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

jobSpecification: BatchJobSpecificationOutput

Property Value

BatchJobSpecificationOutput

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.

lastModified: string

Property Value

string

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.

metadata?: BatchMetadataItemOutput[]

Property Value

BatchMetadataItemOutput[]

previousState

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

Possible values: "active", "completed", "disabled", "terminating", "deleting"

previousState?: string

Property Value

string

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.

previousStateTransitionTime?: string

Property Value

string

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.

schedule?: BatchJobScheduleConfigurationOutput

Property Value

BatchJobScheduleConfigurationOutput

state

The current state of the Job Schedule.

Possible values: "active", "completed", "disabled", "terminating", "deleting"

state: string

Property Value

string

stateTransitionTime

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

stateTransitionTime: string

Property Value

string

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.

stats?: BatchJobScheduleStatisticsOutput

Property Value

BatchJobScheduleStatisticsOutput

url

The URL of the Job Schedule.

url: string

Property Value

string