Schedules - List Applicable

Выводит список всех применимых расписаний.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable?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

ScheduleList

ОК

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

Примеры

Schedules_ListApplicable

Sample Request

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

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"
      }
    }
  ]
}

Определения

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

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

CloudErrorBody

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

DayDetails

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

EnableStatus

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

HourDetails

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

NotificationSettings

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

Schedule

Расписание.

ScheduleList

Ответ операции со списком.

WeekDetails

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

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

Тип ресурса.

ScheduleList

Ответ операции со списком.

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

string

Ссылка для следующего набора результатов.

value

Schedule[]

Результаты операции со списком.

WeekDetails

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

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

string

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

weekdays

string[]

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