Microsoft.DevTestLab labs/virtualmachines/schedules
Bicep resource definition
The labs/virtualmachines/schedules resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DevTestLab/labs/virtualmachines/schedules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines/schedules@2018-09-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
dailyRecurrence: {
time: 'string'
}
hourlyRecurrence: {
minute: int
}
notificationSettings: {
emailRecipient: 'string'
notificationLocale: 'string'
status: 'string'
timeInMinutes: int
webhookUrl: 'string'
}
status: 'string'
targetResourceId: 'string'
taskType: 'string'
weeklyRecurrence: {
time: 'string'
weekdays: [
'string'
]
}
}
}
Property values
labs/virtualmachines/schedules
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| location | The location of the resource. | string |
| tags | The tags of the resource. | Dictionary of tag names and values. See Tags in templates |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: virtualmachines |
| properties | The properties of the resource. | ScheduleProperties (required) |
ScheduleProperties
| Name | Description | Value |
|---|---|---|
| dailyRecurrence | If the schedule will occur once each day of the week, specify the daily recurrence. | DayDetails |
| hourlyRecurrence | If the schedule will occur multiple times a day, specify the hourly recurrence. | HourDetails |
| notificationSettings | Notification settings. | NotificationSettings |
| status | The status of the schedule (i.e. Enabled, Disabled) | 'Disabled' 'Enabled' |
| targetResourceId | The resource ID to which the schedule belongs | string |
| taskType | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | string |
| weeklyRecurrence | If the schedule will occur only some days of the week, specify the weekly recurrence. | WeekDetails |
DayDetails
| Name | Description | Value |
|---|---|---|
| time | The time of day the schedule will occur. | string |
HourDetails
| Name | Description | Value |
|---|---|---|
| minute | Minutes of the hour the schedule will run. | int |
NotificationSettings
| Name | Description | Value |
|---|---|---|
| emailRecipient | The email recipient to send notifications to (can be a list of semi-colon separated email addresses). | string |
| notificationLocale | The locale to use when sending a notification (fallback for unsupported languages is EN). | string |
| status | If notifications are enabled for this schedule (i.e. Enabled, Disabled). | 'Disabled' 'Enabled' |
| timeInMinutes | Time in minutes before event at which notification will be sent. | int |
| webhookUrl | The webhook URL to which the notification will be sent. | string |
WeekDetails
| Name | Description | Value |
|---|---|---|
| time | The time of the day the schedule will occur. | string |
| weekdays | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). | string[] |
ARM template resource definition
The labs/virtualmachines/schedules resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DevTestLab/labs/virtualmachines/schedules resource, add the following JSON to your template.
{
"type": "Microsoft.DevTestLab/labs/virtualmachines/schedules",
"apiVersion": "2018-09-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"dailyRecurrence": {
"time": "string"
},
"hourlyRecurrence": {
"minute": "int"
},
"notificationSettings": {
"emailRecipient": "string",
"notificationLocale": "string",
"status": "string",
"timeInMinutes": "int",
"webhookUrl": "string"
},
"status": "string",
"targetResourceId": "string",
"taskType": "string",
"weeklyRecurrence": {
"time": "string",
"weekdays": [ "string" ]
}
}
}
Property values
labs/virtualmachines/schedules
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DevTestLab/labs/virtualmachines/schedules' |
| apiVersion | The resource api version | '2018-09-15' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| location | The location of the resource. | string |
| tags | The tags of the resource. | Dictionary of tag names and values. See Tags in templates |
| properties | The properties of the resource. | ScheduleProperties (required) |
ScheduleProperties
| Name | Description | Value |
|---|---|---|
| dailyRecurrence | If the schedule will occur once each day of the week, specify the daily recurrence. | DayDetails |
| hourlyRecurrence | If the schedule will occur multiple times a day, specify the hourly recurrence. | HourDetails |
| notificationSettings | Notification settings. | NotificationSettings |
| status | The status of the schedule (i.e. Enabled, Disabled) | 'Disabled' 'Enabled' |
| targetResourceId | The resource ID to which the schedule belongs | string |
| taskType | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | string |
| weeklyRecurrence | If the schedule will occur only some days of the week, specify the weekly recurrence. | WeekDetails |
DayDetails
| Name | Description | Value |
|---|---|---|
| time | The time of day the schedule will occur. | string |
HourDetails
| Name | Description | Value |
|---|---|---|
| minute | Minutes of the hour the schedule will run. | int |
NotificationSettings
| Name | Description | Value |
|---|---|---|
| emailRecipient | The email recipient to send notifications to (can be a list of semi-colon separated email addresses). | string |
| notificationLocale | The locale to use when sending a notification (fallback for unsupported languages is EN). | string |
| status | If notifications are enabled for this schedule (i.e. Enabled, Disabled). | 'Disabled' 'Enabled' |
| timeInMinutes | Time in minutes before event at which notification will be sent. | int |
| webhookUrl | The webhook URL to which the notification will be sent. | string |
WeekDetails
| Name | Description | Value |
|---|---|---|
| time | The time of the day the schedule will occur. | string |
| weekdays | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). | string[] |
Terraform (AzAPI provider) resource definition
The labs/virtualmachines/schedules resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DevTestLab/labs/virtualmachines/schedules resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DevTestLab/labs/virtualmachines/schedules@2018-09-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
dailyRecurrence = {
time = "string"
}
hourlyRecurrence = {
minute = int
}
notificationSettings = {
emailRecipient = "string"
notificationLocale = "string"
status = "string"
timeInMinutes = int
webhookUrl = "string"
}
status = "string"
targetResourceId = "string"
taskType = "string"
weeklyRecurrence = {
time = "string"
weekdays = [
"string"
]
}
}
})
}
Property values
labs/virtualmachines/schedules
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DevTestLab/labs/virtualmachines/schedules@2018-09-15" |
| name | The resource name | string (required) |
| location | The location of the resource. | string |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: virtualmachines |
| tags | The tags of the resource. | Dictionary of tag names and values. |
| properties | The properties of the resource. | ScheduleProperties (required) |
ScheduleProperties
| Name | Description | Value |
|---|---|---|
| dailyRecurrence | If the schedule will occur once each day of the week, specify the daily recurrence. | DayDetails |
| hourlyRecurrence | If the schedule will occur multiple times a day, specify the hourly recurrence. | HourDetails |
| notificationSettings | Notification settings. | NotificationSettings |
| status | The status of the schedule (i.e. Enabled, Disabled) | "Disabled" "Enabled" |
| targetResourceId | The resource ID to which the schedule belongs | string |
| taskType | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | string |
| weeklyRecurrence | If the schedule will occur only some days of the week, specify the weekly recurrence. | WeekDetails |
DayDetails
| Name | Description | Value |
|---|---|---|
| time | The time of day the schedule will occur. | string |
HourDetails
| Name | Description | Value |
|---|---|---|
| minute | Minutes of the hour the schedule will run. | int |
NotificationSettings
| Name | Description | Value |
|---|---|---|
| emailRecipient | The email recipient to send notifications to (can be a list of semi-colon separated email addresses). | string |
| notificationLocale | The locale to use when sending a notification (fallback for unsupported languages is EN). | string |
| status | If notifications are enabled for this schedule (i.e. Enabled, Disabled). | "Disabled" "Enabled" |
| timeInMinutes | Time in minutes before event at which notification will be sent. | int |
| webhookUrl | The webhook URL to which the notification will be sent. | string |
WeekDetails
| Name | Description | Value |
|---|---|---|
| time | The time of the day the schedule will occur. | string |
| weekdays | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). | string[] |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for