Share via

Schedule interface

  • Reference
Package:
@azure/arm-automation

Definition of the schedule.

Extends
ProxyResource

Properties

advancedSchedule

Gets or sets the advanced schedule.
creationTime

Gets or sets the creation time.
description

Gets or sets the description.
expiryTime

Gets or sets the end time of the schedule.
expiryTimeOffsetMinutes

Gets or sets the expiry time's offset in minutes.
frequency

Gets or sets the frequency of the schedule. Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'
interval

Gets or sets the interval of the schedule.
isEnabled

Gets or sets a value indicating whether this schedule is enabled. Default value: false.
lastModifiedTime

Gets or sets the last modified time.
nextRun

Gets or sets the next run time of the schedule.
nextRunOffsetMinutes

Gets or sets the next run time's offset in minutes.
startTime

Gets or sets the start time of the schedule.
startTimeOffsetMinutes

Gets the start time's offset in minutes. NOTE: This property will not be serialized. It can only be populated by the server.
timeZone

Gets or sets the time zone of the schedule.

Inherited Properties

id

Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

advancedSchedule

Gets or sets the advanced schedule.

advancedSchedule?: AdvancedSchedule

Property Value

AdvancedSchedule

creationTime

Gets or sets the creation time.

creationTime?: Date

Property Value

Date

description

Gets or sets the description.

description?: string

Property Value

string

expiryTime

Gets or sets the end time of the schedule.

expiryTime?: Date

Property Value

Date

expiryTimeOffsetMinutes

Gets or sets the expiry time's offset in minutes.

expiryTimeOffsetMinutes?: number

Property Value

number

frequency

Gets or sets the frequency of the schedule. Possible values include: 'OneTime', 'Day', 'Hour', 'Week', 'Month'

frequency?: ScheduleFrequency

Property Value

ScheduleFrequency

interval

Gets or sets the interval of the schedule.

interval?: number

Property Value

number

isEnabled

Gets or sets a value indicating whether this schedule is enabled. Default value: false.

isEnabled?: boolean

Property Value

boolean

lastModifiedTime

Gets or sets the last modified time.

lastModifiedTime?: Date

Property Value

Date

nextRun

Gets or sets the next run time of the schedule.

nextRun?: Date

Property Value

Date

nextRunOffsetMinutes

Gets or sets the next run time's offset in minutes.

nextRunOffsetMinutes?: number

Property Value

number

startTime

Gets or sets the start time of the schedule.

startTime?: Date

Property Value

Date

startTimeOffsetMinutes

Gets the start time's offset in minutes. NOTE: This property will not be serialized. It can only be populated by the server.

startTimeOffsetMinutes?: number

Property Value

number

timeZone

Gets or sets the time zone of the schedule.

timeZone?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type