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

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

订阅 ID。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

ScheduleList

还行

Other Status Codes

CloudError

错误请求

安全性

azure_auth

OAuth2 隐式授权

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

作用域

名称 说明
user_impersonation 访问 azure Microsoft

示例

Schedules_ListApplicable

示例请求

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

示例响应

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

HourDetails

每小时计划的属性。

名称 类型 说明
minute

integer (int32)

计划将运行的小时分钟数。

NotificationSettings

计划的通知设置。

名称 类型 默认值 说明
emailRecipient

string

要向其发送通知的电子邮件收件人(可以是分号分隔电子邮件地址的列表)。

notificationLocale

string

发送通知时要使用的区域设置(不受支持的语言的回退为 EN)。

status

EnableStatus

Disabled

如果为此计划启用了通知(即已启用,已禁用)。

timeInMinutes

integer (int32)

发送通知的事件之前的时间(以分钟为单位)。

webhookUrl

string

通知将发送到的 Webhook URL。

Schedule

计划。

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

计划所属的资源 ID

properties.taskType

string

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

properties.timeZoneId

string

时区 ID(例如中国标准时间、格陵兰标准时间、太平洋标准时间等)。 此属性的可能值可在 IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIdshttps://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[]

计划设置的星期几(例如星期天、星期一、星期二等)。