Microsoft.DevTestLab labs/virtualmachines/schedules 2018-09-15

The labs/virtualmachines/schedules resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DevTestLab/labs/virtualmachines/schedules resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DevTestLab/labs/virtualmachines/schedules@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'
    timeZoneId: 'string'
    weeklyRecurrence: {
      time: 'string'
      weekdays: [ 'string' ]
    }
  }
}

Property values

labs/virtualmachines/schedules

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DevTestLab/labs/virtualmachines/schedules'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-09-15'
name The resource name

See how to set names and types for child resources in Bicep or 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 Properties of a schedule. ScheduleProperties (required)

ScheduleProperties

Name Description Value
dailyRecurrence Properties of a daily schedule. DayDetails
hourlyRecurrence Properties of an hourly schedule. HourDetails
notificationSettings Notification settings for a schedule. NotificationSettings
status Indicates if the artifact source is enabled (values: 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
timeZoneId The time zone ID (e.g. Pacific Standard time). string
weeklyRecurrence Properties of a weekly schedule. 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 Indicates if the artifact source is enabled (values: 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[]