Virtual Machines - List Applicable Schedules

  • Ссылка
Service:
Dev Test Labs
API Version:
2018-09-15

Выводит список применимых расписаний запуска и остановки, если они есть.

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

Параметры URI

Имя В Обязательно Тип Описание
labName
 path True

string

Имя лаборатории.
name
 path True

string

Имя виртуальной машины.
resourceGroupName
 path True

string

Имя группы ресурсов.
subscriptionId
 path True

string

Идентификатор подписки.
api-version
 query True

string

Версия API клиента.

Ответы

Имя Тип Описание
200 OK

ApplicableSchedule

ОК
Other Status Codes

CloudError

BadRequest

Безопасность

azure_auth

Неявное предоставление OAuth2

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

Scopes

Имя Описание
user_impersonation Доступ к Microsoft Azure

Примеры

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

Status code:
200 
{
  "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}"
    }
  }
}

Определения

Имя Описание
ApplicableSchedule

Расписания, применимые к виртуальной машине. Расписания могли быть определены на виртуальной машине или на уровне лаборатории.
CloudError

Ошибка из запроса REST.
CloudErrorBody

Текст ошибки из запроса REST.
DayDetails

Свойства ежедневного расписания.
EnableStatus

Состояние расписания (т. е. Включено, Отключено)
HourDetails

Свойства почасового расписания.
NotificationSettings

Параметры уведомлений для расписания.
Schedule

Расписание.
WeekDetails

Свойства еженедельного расписания.

ApplicableSchedule

Расписания, применимые к виртуальной машине. Расписания могли быть определены на виртуальной машине или на уровне лаборатории.

Имя Тип Описание
id

string

Идентификатор ресурса.
location

string

Расположение ресурса.
name

string

Имя ресурса.
properties.labVmsShutdown

Schedule

Расписание автоматического завершения работы, если оно было задано на уровне лаборатории или ресурса лаборатории.
properties.labVmsStartup

Schedule

Расписание автоматического запуска, если оно было задано на уровне лаборатории или ресурса лаборатории.
tags

object

Теги ресурса.
type

string

Тип ресурса.

CloudError

Ошибка из запроса REST.

Имя Тип Описание
error

CloudErrorBody

Произошла облачная ошибка

CloudErrorBody

Текст ошибки из запроса REST.

Имя Тип Описание
code

string

Код ошибки.
details

CloudErrorBody[]

Внутренние ошибки.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

DayDetails

Свойства ежедневного расписания.

Имя Тип Описание
time

string

Время суток, когда будет выполняться расписание.

EnableStatus

Состояние расписания (т. е. Включено, Отключено)

Имя Тип Описание
Disabled

string

Enabled

string

HourDetails

Свойства почасового расписания.

Имя Тип Описание
minute

integer

Минуты часа, на который будет выполняться расписание.

NotificationSettings

Параметры уведомлений для расписания.

Имя Тип Значение по умолчанию Описание
emailRecipient

string

Получатель электронной почты для отправки уведомлений (может быть списком адресов электронной почты, разделенных точкой с запятой).
notificationLocale

string

Языковой стандарт, используемый при отправке уведомления (резервный вариант для неподдерживаемых языков — EN).
status

EnableStatus

Disabled

Если для этого расписания включены уведомления (т. е. включено, отключено).
timeInMinutes

integer

Время в минутах до события, при котором будет отправлено уведомление.
webhookUrl

string

URL-адрес веб-перехватчика, на который будет отправлено уведомление.

Schedule

Расписание.

Имя Тип Значение по умолчанию Описание
id

string

Идентификатор ресурса.
location

string

Расположение ресурса.
name

string

Имя ресурса.
properties.createdDate

string

Дата создания расписания.
properties.dailyRecurrence

DayDetails

Если расписание будет выполняться один раз в день недели, укажите ежедневное повторение.
properties.hourlyRecurrence

HourDetails

Если расписание будет выполняться несколько раз в день, укажите ежечасное повторение.
properties.notificationSettings

NotificationSettings

Параметры уведомлений.
properties.provisioningState

string

Состояние подготовки ресурса.
properties.status

EnableStatus

Disabled

Состояние расписания (т. е. Включено, Отключено)
properties.targetResourceId

string

Идентификатор ресурса, которому принадлежит расписание
properties.taskType

string

Тип задачи расписания (например, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId

string

Идентификатор часового пояса (например, стандартное время в Китае, стандартное время в Гренландии, тихоокеанское стандартное время и т. д.). Возможные значения для этого свойства можно найти в IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md).
properties.uniqueIdentifier

string

Уникальный неизменяемый идентификатор ресурса (GUID).
properties.weeklyRecurrence

WeekDetails

Если расписание будет выполняться только в некоторые дни недели, укажите еженедельное повторение.
tags

object

Теги ресурса.
type

string

Тип ресурса.

WeekDetails

Свойства еженедельного расписания.

Имя Тип Описание
time

string

Время суток, когда будет выполняться расписание.
weekdays

string[]

Дни недели, для которых задано расписание (например, воскресенье, понедельник, вторник и т. д.).