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

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' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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'
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevTestLab/labs/virtualmachines/schedules

Name	Description	Value
location	The geo-location where the resource lives	string
name	The resource name	string (required)
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: labs/virtualmachines
properties	The properties of the resource.	ScheduleProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

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

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
timeZoneId	The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)	string
weeklyRecurrence	If the schedule will occur only some days of the week, specify the weekly recurrence.	WeekDetails

ScheduleTags

Name	Description	Value

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",
  "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" ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevTestLab/labs/virtualmachines/schedules

Name	Description	Value
apiVersion	The api version	'2018-09-15'
location	The geo-location where the resource lives	string
name	The resource name	string (required)
properties	The properties of the resource.	ScheduleProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DevTestLab/labs/virtualmachines/schedules'

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

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
timeZoneId	The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)	string
weeklyRecurrence	If the schedule will occur only some days of the week, specify the weekly recurrence.	WeekDetails

ScheduleTags

Name	Description	Value

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[]

Usage Examples

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"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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

Microsoft.DevTestLab/labs/virtualmachines/schedules

Name	Description	Value
location	The geo-location where the resource lives	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: labs/virtualmachines
properties	The properties of the resource.	ScheduleProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DevTestLab/labs/virtualmachines/schedules@2018-09-15"

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

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
timeZoneId	The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)	string
weeklyRecurrence	If the schedule will occur only some days of the week, specify the weekly recurrence.	WeekDetails

ScheduleTags

Name	Description	Value

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

Was this page helpful?

Last updated on 2024-12-09

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

Bicep resource definition

Resource format

Property Values

Microsoft.DevTestLab/labs/virtualmachines/schedules

DayDetails

HourDetails

NotificationSettings

ScheduleProperties

ScheduleTags

WeekDetails

ARM template resource definition

Resource format

Property Values

Microsoft.DevTestLab/labs/virtualmachines/schedules

DayDetails

HourDetails

NotificationSettings

ScheduleProperties

ScheduleTags

WeekDetails

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.DevTestLab/labs/virtualmachines/schedules

DayDetails

HourDetails

NotificationSettings

ScheduleProperties

ScheduleTags

WeekDetails

Feedback

Additional resources