Schedules - List

Список расписаний в заданной лаборатории.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

Параметры URI

Name In Required Type Description
labName
path True
  • string

Имя лаборатории.

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

$expand
query
  • string

Укажите запрос $expand. Пример: properties($select=status)"

$filter
query
  • string

Фильтр, применяемый к операции. Пример: "$filter=contains(name,'myName')

$orderby
query
  • string

Выражение упорядочения для результатов с использованием нотации OData. Пример: "$orderby=name desc"

$top
query
  • integer
int32

Максимальное количество ресурсов, возвращаемых из операции. Пример: "$top=10"

Ответы

Name Type Description
200 OK

ОК

Other Status Codes

BadRequest

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

azure_auth

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

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

Scopes

Name Description
user_impersonation Доступ Microsoft Azure

Примеры

Schedules_List

Sample Request

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

Name Type Description
error

Ошибка облака, которая произошла

CloudErrorBody

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

Name Type Description
code
  • string

Код ошибки.

details

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

message
  • string

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

target
  • string

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

DayDetails

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

Name Type Description
time
  • string

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

EnableStatus

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

Name Type Description
Disabled
  • string
Enabled
  • string

HourDetails

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

Name Type Description
minute
  • integer

В минутах часа будет выполнено расписание.

NotificationSettings

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

Name Type Default Value Description
emailRecipient
  • string

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

notificationLocale
  • string

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

status Disabled

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

timeInMinutes
  • integer

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

webhookUrl
  • string

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

Schedule

Расписание.

Name Type Default Value Description
id
  • string

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

location
  • string

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

name
  • string

Имя ресурса.

properties.createdDate
  • string

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

properties.dailyRecurrence

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

properties.hourlyRecurrence

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

properties.notificationSettings

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

properties.provisioningState
  • string

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

properties.status Disabled

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

properties.targetResourceId
  • string

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

properties.taskType
  • string

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

properties.timeZoneId
  • string

Идентификатор часового пояса (например, тихоокеанское стандартное время).

properties.uniqueIdentifier
  • string

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

properties.weeklyRecurrence

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

tags
  • object

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

type
  • string

Тип ресурса.

ScheduleList

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

Name Type Description
nextLink
  • string

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

value

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

WeekDetails

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

Name Type Description
time
  • string

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

weekdays
  • string[]

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