通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

资源组的名称。
subscriptionId
 path True

string

订阅的 ID。
api-version
 query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

ApplicableSchedule

确定
Other Status Codes

CloudError

BadRequest

安全性

azure_auth

OAuth2 隐式授权

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 访问 Microsoft Azure

示例

VirtualMachines_ListApplicableSchedules

示例请求

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": {
      "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

适用于虚拟机的计划。 计划可能是在 VM 或实验室级别定义的。
CloudError

REST 请求出错。
CloudErrorBody

来自 REST 请求的错误正文。
DayDetails

每日计划的属性。
EnableStatus

计划的状态 (，即“已启用”、“已禁用”)

HourDetails

每小时计划的属性。
NotificationSettings

计划的通知设置。
Schedule

计划。
WeekDetails

每周计划的属性。

ApplicableSchedule

适用于虚拟机的计划。 计划可能是在 VM 或实验室级别定义的。

名称 类型 说明
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

通知将发送到的 Webhook 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

计划所属的资源 ID
properties.taskType

string

计划的任务类型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。
properties.timeZoneId

string

时区 ID (例如中国标准时间、格陵兰标准时间、太平洋标准时间等 ) 。 可以在 (中找到https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md此属性IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds的可能值)

properties.uniqueIdentifier

string

资源的唯一不可变标识符 (Guid) 。
properties.weeklyRecurrence

WeekDetails

如果计划仅在一周中的某几天发生，请指定每周重复周期。
tags

object

资源的标记。
type

string

资源类型。

WeekDetails

每周计划的属性。

名称 类型 说明
time

string

计划发生日期的时间。
weekdays

string[]

将计划设置为 (星期几天，例如星期日、星期一、星期二等 ) 。