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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID.

resourceGroupName
path True
  • string

The name of the resource group.

labName
path True
  • string

The name of the lab.

name
path True
  • string

The name of the schedule.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

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

Definitions

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.

ScheduleList

The response of a list operation.

WeekDetails

Properties of a weekly schedule.

CloudError

Error from a REST request.

Name Type Description
error

The cloud error that occurred

CloudErrorBody

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.

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

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

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. Pacific Standard time).

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.

ScheduleList

The response of a list operation.

Name Type Description
nextLink
  • string

Link for next set of results.

value

Results of the list operation.

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