Virtual Machines - List Applicable Schedules

Lists the applicable start/stop schedules, if any.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules?api-version=2018-09-15

URI Parameters

Name In Required Type Description
labName
path True

string

The name of the lab.

name
path True

string

The name of the virtual machine.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription ID.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

ApplicableSchedule

OK

Other Status Codes

CloudError

BadRequest

Security

azure_auth

OAuth2 Implicit Grant

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Access Microsoft Azure

Examples

VirtualMachines_ListApplicableSchedules

Sample request

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}/listApplicableSchedules?api-version=2018-09-15

Sample response

{
  "properties": {
    "labVmsShutdown": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsShutdownTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1700"
        },
        "dailyRecurrence": {
          "time": "1900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:48:14.1369355+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "4acf0408-1c10-49cb-96b7-28ce655c8320"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule",
      "name": "LabVmsShutdown",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    },
    "labVmsStartup": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsStartupTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1000"
        },
        "dailyRecurrence": {
          "time": "0900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:46:37.0473976+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule",
      "name": "LabVmAutoStart",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    }
  }
}

Definitions

Name Description
ApplicableSchedule

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

CloudError

Error from a REST request.

CloudErrorBody

Body of an error from a REST request.

DayDetails

Properties of a daily schedule.

EnableStatus

The status of the schedule (i.e. Enabled, Disabled)

HourDetails

Properties of an hourly schedule.

NotificationSettings

Notification settings for a schedule.

Schedule

A schedule.

WeekDetails

Properties of a weekly schedule.

ApplicableSchedule

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

Name Type Description
id

string

The identifier of the resource.

location

string

The location of the resource.

name

string

The name of the resource.

properties.labVmsShutdown

Schedule

The auto-shutdown schedule, if one has been set at the lab or lab resource level.

properties.labVmsStartup

Schedule

The auto-startup schedule, if one has been set at the lab or lab resource level.

tags

object

The tags of the resource.

type

string

The type of the resource.

CloudError

Error from a REST request.

Name Type Description
error

CloudErrorBody

The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name Type Description
code

string

The error code.

details

CloudErrorBody[]

Inner errors.

message

string

The error message.

target

string

The error target.

DayDetails

Properties of a daily schedule.

Name Type Description
time

string

The time of day the schedule will occur.

EnableStatus

The status of the schedule (i.e. Enabled, Disabled)

Name Type Description
Disabled

string

Enabled

string

HourDetails

Properties of an hourly schedule.

Name Type Description
minute

integer

Minutes of the hour the schedule will run.

NotificationSettings

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

EnableStatus

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.

Schedule

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

DayDetails

If the schedule will occur once each day of the week, specify the daily recurrence.

properties.hourlyRecurrence

HourDetails

If the schedule will occur multiple times a day, specify the hourly recurrence.

properties.notificationSettings

NotificationSettings

Notification settings.

properties.provisioningState

string

The provisioning status of the resource.

properties.status

EnableStatus

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 IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

The unique immutable identifier of a resource (Guid).

properties.weeklyRecurrence

WeekDetails

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.

WeekDetails

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.).