Schedules - List Applicable
Lists all applicable schedules
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable?api-version=2018-09-15
Name | In | Required | Type | Description |
---|---|---|---|---|
lab
|
path | True |
string |
The name of the lab. |
name
|
path | True |
string |
The name of the schedule. |
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
The subscription ID. |
api-version
|
query | True |
string |
Client API version. |
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
OAuth2 Implicit Grant
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | Access Microsoft Azure |
Sample request
Sample response
{
"value": [
{
"properties": {
"status": "{Enabled|Disabled}",
"taskType": "{myLabVmTaskType}",
"weeklyRecurrence": {
"weekdays": [
"Monday",
"Wednesday",
"Friday"
],
"time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}"
},
"dailyRecurrence": {
"time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
},
"hourlyRecurrence": {
"minute": 30
},
"timeZoneId": "Pacific Standard Time",
"notificationSettings": {
"status": "{Enabled|Disabled}",
"timeInMinutes": 15,
"webhookUrl": "{webhookUrl}",
"emailRecipient": "{email}",
"notificationLocale": "EN"
},
"createdDate": "2018-10-01T18:40:48.1739018-07:00",
"targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
"provisioningState": "Creating",
"uniqueIdentifier": "{uniqueIdentifier}"
},
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
"name": "{scheduleName}",
"type": "Microsoft.DevTestLab/labs/schedules",
"location": "{location}",
"tags": {
"tagName1": "tagValue1"
}
}
]
}
Name | Description |
---|---|
Cloud |
Error from a REST request. |
Cloud |
Body of an error from a REST request. |
Day |
Properties of a daily schedule. |
Enable |
The status of the schedule (i.e. Enabled, Disabled) |
Hour |
Properties of an hourly schedule. |
Notification |
Notification settings for a schedule. |
Schedule |
A schedule. |
Schedule |
The response of a list operation. |
Week |
Properties of a weekly schedule. |
Error from a REST request.
Name | Type | Description |
---|---|---|
error |
The cloud error that occurred |
Body of an error from a REST request.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
details |
Inner errors. |
|
message |
string |
The error message. |
target |
string |
The error target. |
Properties of a daily schedule.
Name | Type | Description |
---|---|---|
time |
string |
The time of day the schedule will occur. |
The status of the schedule (i.e. Enabled, Disabled)
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
Properties of an hourly schedule.
Name | Type | Description |
---|---|---|
minute |
integer |
Minutes of the hour the schedule will run. |
Notification settings for a schedule.
Name | Type | Default value | Description |
---|---|---|---|
emailRecipient |
string |
The email recipient to send notifications to (can be a list of semi-colon separated email addresses). |
|
notificationLocale |
string |
The locale to use when sending a notification (fallback for unsupported languages is EN). |
|
status | Disabled |
If notifications are enabled for this schedule (i.e. Enabled, Disabled). |
|
timeInMinutes |
integer |
Time in minutes before event at which notification will be sent. |
|
webhookUrl |
string |
The webhook URL to which the notification will be sent. |
A schedule.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
The identifier of the resource. |
|
location |
string |
The location of the resource. |
|
name |
string |
The name of the resource. |
|
properties.createdDate |
string |
The creation date of the schedule. |
|
properties.dailyRecurrence |
If the schedule will occur once each day of the week, specify the daily recurrence. |
||
properties.hourlyRecurrence |
If the schedule will occur multiple times a day, specify the hourly recurrence. |
||
properties.notificationSettings |
Notification settings. |
||
properties.provisioningState |
string |
The provisioning status of the resource. |
|
properties.status | Disabled |
The status of the schedule (i.e. Enabled, Disabled) |
|
properties.targetResourceId |
string |
The resource ID to which the schedule belongs |
|
properties.taskType |
string |
The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). |
|
properties.timeZoneId |
string |
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 |
|
properties.uniqueIdentifier |
string |
The unique immutable identifier of a resource (Guid). |
|
properties.weeklyRecurrence |
If the schedule will occur only some days of the week, specify the weekly recurrence. |
||
tags |
object |
The tags of the resource. |
|
type |
string |
The type of the resource. |
The response of a list operation.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link for next set of results. |
value |
Schedule[] |
Results of the list operation. |
Properties of a weekly schedule.
Name | Type | Description |
---|---|---|
time |
string |
The time of the day the schedule will occur. |
weekdays |
string[] |
The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). |