Virtual Machines - List Applicable Schedules

Служба:: Dev Test Labs

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

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

VirtualMachines_ListApplicableSchedules

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

HTTP

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

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

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

{
  "properties": {
    "labVmsShutdown": {
      "name": "LabVmsShutdown",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule",
      "location": "{location}",
      "properties": {
        "createdDate": "2020-12-29T21:48:14.1369355+00:00",
        "dailyRecurrence": {
          "time": "1900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Succeeded",
        "status": "Enabled",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "taskType": "LabVmsShutdownTask",
        "timeZoneId": "Pacific Standard Time",
        "uniqueIdentifier": "4acf0408-1c10-49cb-96b7-28ce655c8320",
        "weeklyRecurrence": {
          "time": "1700",
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ]
        }
      }
    },
    "labVmsStartup": {
      "name": "LabVmAutoStart",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule",
      "location": "{location}",
      "properties": {
        "createdDate": "2020-12-29T21:46:37.0473976+00:00",
        "dailyRecurrence": {
          "time": "0900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Succeeded",
        "status": "Enabled",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "taskType": "LabVmsStartupTask",
        "timeZoneId": "Pacific Standard Time",
        "weeklyRecurrence": {
          "time": "1000",
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ]
        }
      }
    }
  }
}

Определения

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

ApplicableSchedule

Объект

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Расположение ресурса.
name	string	Имя ресурса
properties.labVmsShutdown	Schedule	Расписание автоматического завершения работы, если оно установлено на уровне лаборатории или лаборатории.
properties.labVmsStartup	Schedule	Расписание автоматического запуска, если оно установлено на уровне лаборатории или лаборатории.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурса.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DayDetails

Объект

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

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

EnableStatus

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

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

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

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

HourDetails

Объект

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

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

NotificationSettings

Объект

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

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

Schedule

Объект

Расписание.

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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		Если расписание будет выполняться только в течение нескольких дней недели, укажите еженедельное повторение.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

WeekDetails

Объект

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

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

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

Virtual Machines - List Applicable Schedules

Параметры URI

Ответы

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

azure_auth

Области

Примеры

VirtualMachines_ListApplicableSchedules

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

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

Определения

ApplicableSchedule

createdByType

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

systemData

WeekDetails