Microsoft.DevTestLab schedules 2016-05-15
Article 08/11/2023
1 contributor
Feedback
In this article
Bicep resource definition
The schedules resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DevTestLab/schedules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DevTestLab/schedules@2016-05-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
dailyRecurrence: {
time: 'string'
}
hourlyRecurrence: {
minute: int
}
notificationSettings: {
status: 'string'
timeInMinutes: int
webhookUrl: 'string'
}
provisioningState: 'string'
status: 'string'
targetResourceId: 'string'
taskType: 'string'
timeZoneId: 'string'
uniqueIdentifier: 'string'
weeklyRecurrence: {
time: 'string'
weekdays: [
'string'
]
}
}
}
Property values
schedules
Name
Description
Value
name
The resource name
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
provisioningState
The provisioning status of the resource.
string
status
The status of the schedule (i.e. Enabled, Disabled)
'Disabled'
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
uniqueIdentifier
The unique immutable identifier of a resource (Guid).
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
status
If notifications are enabled for this schedule (i.e. Enabled, Disabled).
'Disabled'
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[]
Quickstart templates
The following quickstart templates deploy this resource type.
Template
Description
SharePoint Subscription / 2019 / 2016 / 2013 all configured This template creates a SharePoint Subscription / 2019 / 2016 / 2013 farm with an extensive configuration that would take ages to perform manually, including a federated authentication with ADFS, an OAuth trust, the User Profiles service and a web application with 2 zones that contains multiple path based and host-named site collections. On the SharePoint virtual machines, Chocolatey is used to install the latest version of Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer and 7-Zip.
ARM template resource definition
The schedules resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DevTestLab/schedules resource, add the following JSON to your template.
{
"type": "Microsoft.DevTestLab/schedules",
"apiVersion": "2016-05-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"dailyRecurrence": {
"time": "string"
},
"hourlyRecurrence": {
"minute": "int"
},
"notificationSettings": {
"status": "string",
"timeInMinutes": "int",
"webhookUrl": "string"
},
"provisioningState": "string",
"status": "string",
"targetResourceId": "string",
"taskType": "string",
"timeZoneId": "string",
"uniqueIdentifier": "string",
"weeklyRecurrence": {
"time": "string",
"weekdays": [ "string" ]
}
}
}
Property values
schedules
Name
Description
Value
type
The resource type
'Microsoft.DevTestLab/schedules'
apiVersion
The resource api version
'2016-05-15'
name
The resource name
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
provisioningState
The provisioning status of the resource.
string
status
The status of the schedule (i.e. Enabled, Disabled)
'Disabled'
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
uniqueIdentifier
The unique immutable identifier of a resource (Guid).
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
status
If notifications are enabled for this schedule (i.e. Enabled, Disabled).
'Disabled'
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[]
Quickstart templates
The following quickstart templates deploy this resource type.
Template
Description
SharePoint Subscription / 2019 / 2016 / 2013 all configured This template creates a SharePoint Subscription / 2019 / 2016 / 2013 farm with an extensive configuration that would take ages to perform manually, including a federated authentication with ADFS, an OAuth trust, the User Profiles service and a web application with 2 zones that contains multiple path based and host-named site collections. On the SharePoint virtual machines, Chocolatey is used to install the latest version of Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer and 7-Zip.
The schedules resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DevTestLab/schedules resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DevTestLab/schedules@2016-05-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
dailyRecurrence = {
time = "string"
}
hourlyRecurrence = {
minute = int
}
notificationSettings = {
status = "string"
timeInMinutes = int
webhookUrl = "string"
}
provisioningState = "string"
status = "string"
targetResourceId = "string"
taskType = "string"
timeZoneId = "string"
uniqueIdentifier = "string"
weeklyRecurrence = {
time = "string"
weekdays = [
"string"
]
}
}
})
}
Property values
schedules
Name
Description
Value
type
The resource type
"Microsoft.DevTestLab/schedules@2016-05-15"
name
The resource name
string (required)
location
The location of the resource.
string
parent_id
To deploy to a resource group, use the ID of that resource group.
string (required)
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
provisioningState
The provisioning status of the resource.
string
status
The status of the schedule (i.e. Enabled, Disabled)
"Disabled"
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
uniqueIdentifier
The unique immutable identifier of a resource (Guid).
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
status
If notifications are enabled for this schedule (i.e. Enabled, Disabled).
"Disabled"
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[]
