Virtual Machines - List Applicable Schedules

  • 參考
Service:
Dev Test Labs
API Version:
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 參數

名稱 位於 必要 類型 Description
labName
 path True

string

實驗室的名稱。
name
 path True

string

虛擬機器的名稱。
resourceGroupName
 path True

string

資源群組的名稱。
subscriptionId
 path True

string

訂閱識別碼。
api-version
 query True

string

用戶端 API 版本。

回應

名稱 類型 Description
200 OK

ApplicableSchedule

確定
Other Status Codes

CloudError

BadRequest

安全性

azure_auth

OAuth2 隱含授與

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

Scopes

名稱 Description
user_impersonation 存取 Microsoft Azure

範例

VirtualMachines_ListApplicableSchedules

Sample Request

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

Sample Response

Status code:
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}"
    }
  }
}

定義

名稱 Description
ApplicableSchedule

適用於虛擬機的排程。 排程可能已在 VM 或實驗室層級上定義。
CloudError

REST 要求發生錯誤。
CloudErrorBody

REST 要求的錯誤本文。
DayDetails

每日排程的屬性。
EnableStatus

排程 (的狀態，也就是已啟用、停用)

HourDetails

每小時排程的屬性。
NotificationSettings

排程的通知設定。
Schedule

排程。
WeekDetails

每周排程的屬性。

ApplicableSchedule

適用於虛擬機的排程。 排程可能已在 VM 或實驗室層級上定義。

名稱 類型 Description
id

string

資源的標識碼。
location

string

資源的位置。
name

string

資源名稱。
properties.labVmsShutdown

Schedule

如果已在實驗室或實驗室資源層級設定自動關機排程。
properties.labVmsStartup

Schedule

如果已在實驗室或實驗室資源層級設定自動啟動排程。
tags

object

資源的標記。
type

string

資源類型。

CloudError

REST 要求發生錯誤。

名稱 類型 Description
error

CloudErrorBody

發生的雲端錯誤

CloudErrorBody

REST 要求的錯誤本文。

名稱 類型 Description
code

string

錯誤碼。
details

CloudErrorBody[]

內部錯誤。
message

string

錯誤訊息。
target

string

錯誤目標。

DayDetails

每日排程的屬性。

名稱 類型 Description
time

string

排程的當天時間。

EnableStatus

排程 (的狀態，也就是已啟用、停用)

名稱 類型 Description
Disabled

string

Enabled

string

HourDetails

每小時排程的屬性。

名稱 類型 Description
minute

integer

排程執行的小時分鐘數。

NotificationSettings

排程的通知設定。

名稱 類型 預設值 Description
emailRecipient

string

傳送通知給 (的電子郵件收件者可以是分號分隔的電子郵件地址清單) 。
notificationLocale

string

傳送通知時所要使用的地區設定 (不支援語言的後援為 EN) 。
status

EnableStatus

Disabled

如果此排程已啟用通知， (亦即已啟用、停用) 。
timeInMinutes

integer

在事件傳送通知前幾分鐘的時間。
webhookUrl

string

將傳送通知的 Webhook URL。

Schedule

排程。

名稱 類型 預設值 Description
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

排程所屬的資源標識碼
properties.taskType

string

排程的工作類型 (例如 LabVmsShutdownTask、LabVmAutoStart) 。
properties.timeZoneId

string

時區標識碼 (例如中國標準時間、綠地標準時間、太平洋標準時間等 ) 。 您可以在 () 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

每周排程的屬性。

名稱 類型 Description
time

string

排程的當天時間。
weekdays

string[]

排程設定的星期幾 (例如星期日、星期一、星期二等 ) 。