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

Schedules - Get

获取实验室计划。
返回实验室计划的属性。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/schedules/{scheduleName}?api-version=2023-06-07

URI 参数

名称 必需 类型 说明
labName
path True

string

在包含的实验室计划中唯一标识它的实验室的名称。 在资源 URI 中使用。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

scheduleName
path True

string

在包含的实验室中唯一标识它的计划的名称。 在资源 URI 中使用。

正则表达式模式: ^[-\w\\._\\(\\)]+$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

Schedule

请求成功;响应包含实验室计划。

Other Status Codes

ErrorResponse

默认错误响应。

示例

getSchedule

示例请求

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/schedules/schedule1?api-version=2023-06-07

示例响应

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/schedules/schedule1",
  "name": "schedule1",
  "type": "Microsoft.LabServices/Schedule",
  "systemData": {
    "createdBy": "identity123",
    "createdByType": "User",
    "createdAt": "2020-05-01T10:00:00Z",
    "lastModifiedBy": "identity123",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-01T09:12:28Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "startAt": "2020-05-26T12:00:00Z",
    "stopAt": "2020-05-26T18:00:00Z",
    "recurrencePattern": {
      "frequency": "Daily",
      "interval": 1,
      "expirationDate": "2020-08-14T23:59:59Z"
    },
    "timeZoneId": "America/Los_Angeles",
    "notes": "Schedule 1 for students"
  }
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ProvisioningState

计划的当前预配状态。

RecurrenceFrequency

计划重复频率。

RecurrencePattern

实验室计划的定期模式。

ResourceOperationError

此资源上的最新操作失败的错误详细信息

Schedule

计划在特定时间自动打开和关闭实验室中的虚拟机。

systemData

与资源的创建和上次修改相关的元数据。

WeekDay

一周中的天数。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ProvisioningState

计划的当前预配状态。

名称 类型 说明
Creating

string

正在创建资源。

Deleting

string

正在删除资源。

Failed

string

以前对资源执行的操作失败,使资源处于不正常状态。

Locked

string

资源已锁定,并且当前阻止更改。 这可能是由于维护或计划的操作造成的。 锁定操作完成后,状态将恢复为成功。

Succeeded

string

资源在创建或更新操作后处于正常状态。

Updating

string

正在向资源应用新的属性值。

RecurrenceFrequency

计划重复频率。

名称 类型 说明
Daily

string

计划将每天运行一次。

Weekly

string

计划将每周在 weekDays 中指定的日期运行。

RecurrencePattern

实验室计划的定期模式。

名称 类型 说明
expirationDate

string

定期到期时间。 此日期是非独占日期。

frequency

RecurrenceFrequency

重复周期的频率。

interval

integer

调用计划的间隔。 例如,interval = 2 和 RecurrenceFrequency.Daily 将每 2 天运行一次。 如果未提供间隔,则使用 1 的间隔。

weekDays

WeekDay[]

计划运行的周天数。 在“频率”设置为“每周”时使用。

ResourceOperationError

此资源上的最新操作失败的错误详细信息

名称 类型 说明
action

string

失败的操作操作

code

string

对应于操作失败类型的代码

message

string

操作失败消息

timestamp

string

发生错误的日期时间

Schedule

计划在特定时间自动打开和关闭实验室中的虚拟机。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.notes

string

此计划的说明。

properties.provisioningState

ProvisioningState

计划的当前预配状态。

properties.recurrencePattern

RecurrencePattern

计划操作的定期模式。

properties.resourceOperationError

ResourceOperationError

按计划执行的最后一个操作的错误详细信息。

properties.startAt

string

何时启动实验室用户虚拟机。 将忽略时间戳偏移量,并改用 timeZoneId。

properties.stopAt

string

实验室用户虚拟机何时停止。 将忽略时间戳偏移量,并改用 timeZoneId。

properties.timeZoneId

string

计划的 IANA 时区 ID。

systemData

systemData

与计划的创建和上次修改相关的元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

WeekDay

一周中的天数。

名称 类型 说明
Friday

string

计划将在星期五运行

Monday

string

计划将在星期一运行

Saturday

string

计划将在星期六运行

Sunday

string

计划将在星期日运行

Thursday

string

计划将在星期四运行

Tuesday

string

计划将在星期二运行

Wednesday

string

计划将在星期三运行