Microsoft.LabServices labs/schedules
Bicep resource definition
The labs/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.LabServices/labs/schedules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.LabServices/labs/schedules@2023-06-07' = {
parent: resourceSymbolicName
name: 'string'
properties: {
notes: 'string'
recurrencePattern: {
expirationDate: 'string'
frequency: 'string'
interval: int
weekDays: [
'string'
]
}
startAt: 'string'
stopAt: 'string'
timeZoneId: 'string'
}
}
Property Values
Microsoft.LabServices/labs/schedules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 100 Pattern = ^[-\w\\._\\(\\)]+$ (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 |
| properties | Schedule resource properties | ScheduleProperties (required) |
RecurrencePattern
| Name | Description | Value |
|---|---|---|
| expirationDate | When the recurrence will expire. This date is inclusive. | string (required) |
| frequency | The frequency of the recurrence. | 'Daily' 'Weekly' (required) |
| interval | The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. | int Constraints: Min value = 1 Max value = 365 |
| weekDays | The week days the schedule runs. Used for when the Frequency is set to Weekly. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
ScheduleProperties
| Name | Description | Value |
|---|---|---|
| notes | Notes for this schedule. | string Constraints: Max length = 1000 |
| recurrencePattern | The recurrence pattern of the scheduled actions. | RecurrencePattern |
| startAt | When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. | string |
| stopAt | When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. | string |
| timeZoneId | The IANA timezone id for the schedule. | string Constraints: Max length = 50 |
ARM template resource definition
The labs/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.LabServices/labs/schedules resource, add the following JSON to your template.
{
"type": "Microsoft.LabServices/labs/schedules",
"apiVersion": "2023-06-07",
"name": "string",
"properties": {
"notes": "string",
"recurrencePattern": {
"expirationDate": "string",
"frequency": "string",
"interval": "int",
"weekDays": [ "string" ]
},
"startAt": "string",
"stopAt": "string",
"timeZoneId": "string"
}
}
Property Values
Microsoft.LabServices/labs/schedules
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-06-07' |
| name | The resource name | string Constraints: Min length = 1 Max length = 100 Pattern = ^[-\w\\._\\(\\)]+$ (required) |
| properties | Schedule resource properties | ScheduleProperties (required) |
| type | The resource type | 'Microsoft.LabServices/labs/schedules' |
RecurrencePattern
| Name | Description | Value |
|---|---|---|
| expirationDate | When the recurrence will expire. This date is inclusive. | string (required) |
| frequency | The frequency of the recurrence. | 'Daily' 'Weekly' (required) |
| interval | The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. | int Constraints: Min value = 1 Max value = 365 |
| weekDays | The week days the schedule runs. Used for when the Frequency is set to Weekly. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
ScheduleProperties
| Name | Description | Value |
|---|---|---|
| notes | Notes for this schedule. | string Constraints: Max length = 1000 |
| recurrencePattern | The recurrence pattern of the scheduled actions. | RecurrencePattern |
| startAt | When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. | string |
| stopAt | When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. | string |
| timeZoneId | The IANA timezone id for the schedule. | string Constraints: Max length = 50 |
Usage Examples
Terraform (AzAPI provider) resource definition
The labs/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.LabServices/labs/schedules resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.LabServices/labs/schedules@2023-06-07"
name = "string"
body = jsonencode({
properties = {
notes = "string"
recurrencePattern = {
expirationDate = "string"
frequency = "string"
interval = int
weekDays = [
"string"
]
}
startAt = "string"
stopAt = "string"
timeZoneId = "string"
}
})
}
Property Values
Microsoft.LabServices/labs/schedules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 100 Pattern = ^[-\w\\._\\(\\)]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: labs |
| properties | Schedule resource properties | ScheduleProperties (required) |
| type | The resource type | "Microsoft.LabServices/labs/schedules@2023-06-07" |
RecurrencePattern
| Name | Description | Value |
|---|---|---|
| expirationDate | When the recurrence will expire. This date is inclusive. | string (required) |
| frequency | The frequency of the recurrence. | 'Daily' 'Weekly' (required) |
| interval | The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. | int Constraints: Min value = 1 Max value = 365 |
| weekDays | The week days the schedule runs. Used for when the Frequency is set to Weekly. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
ScheduleProperties
| Name | Description | Value |
|---|---|---|
| notes | Notes for this schedule. | string Constraints: Max length = 1000 |
| recurrencePattern | The recurrence pattern of the scheduled actions. | RecurrencePattern |
| startAt | When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. | string |
| stopAt | When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. | string |
| timeZoneId | The IANA timezone id for the schedule. | string Constraints: Max length = 50 |