Schedule interface

A schedule.

Extends

Properties

createdDate

The creation date of the schedule. NOTE: This property will not be serialized. It can only be populated by the server.

dailyRecurrence

If the schedule will occur once each day of the week, specify the daily recurrence.

hourlyRecurrence

If the schedule will occur multiple times a day, specify the hourly recurrence.

notificationSettings

Notification settings.

provisioningState

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

status

The status of the schedule (i.e. Enabled, Disabled)

targetResourceId

The resource ID to which the schedule belongs

taskType

The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

timeZoneId

The time zone ID (e.g. Pacific Standard time).

uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

weeklyRecurrence

If the schedule will occur only some days of the week, specify the weekly recurrence.

Inherited Properties

id

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

location

The location of the resource.

name

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

tags

The tags of the resource.

type

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

Property Details

createdDate

The creation date of the schedule. NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: Date

Property Value

Date

dailyRecurrence

If the schedule will occur once each day of the week, specify the daily recurrence.

dailyRecurrence?: DayDetails

Property Value

hourlyRecurrence

If the schedule will occur multiple times a day, specify the hourly recurrence.

hourlyRecurrence?: HourDetails

Property Value

notificationSettings

Notification settings.

notificationSettings?: NotificationSettings

Property Value

provisioningState

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

provisioningState?: string

Property Value

string

status

The status of the schedule (i.e. Enabled, Disabled)

status?: string

Property Value

string

targetResourceId

The resource ID to which the schedule belongs

targetResourceId?: string

Property Value

string

taskType

The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

taskType?: string

Property Value

string

timeZoneId

The time zone ID (e.g. Pacific Standard time).

timeZoneId?: string

Property Value

string

uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

uniqueIdentifier?: string

Property Value

string

weeklyRecurrence

If the schedule will occur only some days of the week, specify the weekly recurrence.

weeklyRecurrence?: WeekDetails

Property Value

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From Resource.id

location

The location of the resource.

location?: string

Property Value

string

Inherited From Resource.location

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 Resource.name

tags

The tags of the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

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 Resource.type