Share via


BatchJobScheduleCreateOptions interface

Parameters for creating an Azure Batch Job Schedule

Properties

displayName

The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

id

A string that uniquely identifies the schedule within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).

jobSpecification

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

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.

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.

Property Details

displayName

The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

displayName?: string

Property Value

string

id

A string that uniquely identifies the schedule within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).

id: string

Property Value

string

jobSpecification

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

jobSpecification: BatchJobSpecification

Property Value

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?: BatchMetadataItem[]

Property Value

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: BatchJobScheduleConfiguration

Property Value