Schedules - List Applicable

Служба:: Dev Test Labs

Версия API:: 2018-09-15

Список всех применимых расписаний

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 minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ScheduleList	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Schedules_ListApplicable

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "name": "{scheduleName}",
      "type": "Microsoft.DevTestLab/labs/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
      "location": "{location}",
      "properties": {
        "createdDate": "2018-10-01T18:40:48.1739018-07:00",
        "dailyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "{Enabled|Disabled}",
          "timeInMinutes": 15,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Creating",
        "status": "{Enabled|Disabled}",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
        "taskType": "{myLabVmTaskType}",
        "timeZoneId": "Pacific Standard Time",
        "uniqueIdentifier": "{uniqueIdentifier}",
        "weeklyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}",
          "weekdays": [
            "Monday",
            "Wednesday",
            "Friday"
          ]
        }
      },
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Определения

Имя	Описание
DayDetails	Свойства ежедневного расписания.
EnableStatus	Указывает, включен ли источник артефакта (значения: включено, отключено).
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HourDetails	Свойства почасового расписания.
NotificationSettings	Параметры уведомлений для расписания.
Schedule	Расписание.
ScheduleList	Ответ операции списка.
WeekDetails	Свойства еженедельного расписания.

DayDetails

Object

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

Имя	Тип	Описание
time	string	Время суток будет выполняться.

EnableStatus

Перечисление

Указывает, включен ли источник артефакта (значения: включено, отключено).

Значение	Описание
Enabled
Disabled

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

HourDetails

Object

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

Имя	Тип	Описание
minute	integer (int32)	В минутах часа будет выполняться расписание.

NotificationSettings

Object

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

Имя	Тип	Default value	Описание
emailRecipient	string		Получатель электронной почты для отправки уведомлений (может быть списком разделенных точкой с запятой адресов электронной почты).
notificationLocale	string		Языковой стандарт, используемый при отправке уведомления (резервный вариант для неподдерживаемых языков — EN).
status	EnableStatus	Disabled	Если уведомления включены для этого расписания (т. е. включено, отключено).
timeInMinutes	integer (int32)		Время в минутах до события, по которому будет отправлено уведомление.
webhookUrl	string		URL-адрес веб-перехватчика, на который будет отправлено уведомление.

Schedule

Object

Расписание.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.createdDate	string (date-time)		Дата создания расписания.
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

Object

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

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	Schedule[]	Элементы расписания на этой странице

WeekDetails

Object

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

Имя	Тип	Описание
time	string	Время дня будет происходить.
weekdays	string[]	Дни недели, для которых устанавливается расписание (например, воскресенье, понедельник, вторник и т. д.).

Поделиться через

Schedules - List Applicable

Параметры URI

Ответы

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

azure_auth

Области

Примеры

Schedules_ListApplicable

Образец запроса

Пример ответа

Определения

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

ScheduleList

WeekDetails