Schedule interface
Schedule for automatically turning virtual machines in a lab on and off at specified times.
- Extends
Properties
notes | Notes for this schedule. |
provisioning |
Current provisioning state of the schedule. NOTE: This property will not be serialized. It can only be populated by the server. |
recurrence |
The recurrence pattern of the scheduled actions. |
start |
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. |
stop |
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. |
system |
Metadata pertaining to creation and last modification of the schedule. NOTE: This property will not be serialized. It can only be populated by the server. |
time |
The IANA timezone id for the schedule. |
Inherited Properties
id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
notes
Notes for this schedule.
notes?: string
Property Value
string
provisioningState
Current provisioning state of the schedule. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: ProvisioningState
Property Value
recurrencePattern
The recurrence pattern of the scheduled actions.
recurrencePattern?: RecurrencePattern
Property Value
startAt
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
startAt?: Date
Property Value
Date
stopAt
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
stopAt?: Date
Property Value
Date
systemData
Metadata pertaining to creation and last modification of the schedule. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
timeZoneId
The IANA timezone id for the schedule.
timeZoneId?: string
Property Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyResource.type