Sdílet prostřednictvím

Virtual Machines - List Applicable Schedules

  • Reference
Služba:
Dev Test Labs
Verze rozhraní API:
2018-09-15

Seznamy příslušné plány zahájení/zastavení, pokud existují.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
labName
 path True

string

Název testovacího prostředí.
name
 path True

string

Název virtuálního počítače.
resourceGroupName
 path True

string

Název skupiny prostředků.
subscriptionId
 path True

string

ID předplatného.
api-version
 query True

string

Verze rozhraní API klienta.

Odpovědi

Name Typ Description
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

Zabezpečení

azure_auth

Implicitní udělení OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Přístup k Microsoft Azure

Příklady

VirtualMachines_ListApplicableSchedules

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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}"
    }
  }
}

Definice

Name Description
ApplicableSchedule

Plány použitelné pro virtuální počítač. Plány mohly být definované na virtuálním počítači nebo na úrovni testovacího prostředí.
CloudError

Chyba požadavku REST.
CloudErrorBody

Text chyby z požadavku REST
DayDetails

Vlastnosti denního plánu.
EnableStatus

Stav plánu (tj. Povoleno, Zakázáno)
HourDetails

Vlastnosti hodinového plánu.
NotificationSettings

Nastavení oznámení pro plán
Schedule

Plán.
WeekDetails

Vlastnosti týdenního plánu

ApplicableSchedule

Plány použitelné pro virtuální počítač. Plány mohly být definované na virtuálním počítači nebo na úrovni testovacího prostředí.

Name Typ Description
id

string

Identifikátor prostředku.
location

string

Umístění prostředku.
name

string

Název prostředku.
properties.labVmsShutdown

Schedule

Plán automatického vypínání, pokud je nastavený na úrovni testovacího prostředí nebo prostředků testovacího prostředí.
properties.labVmsStartup

Schedule

Plán automatického spouštění, pokud je nastavený na úrovni prostředků testovacího prostředí nebo testovacího prostředí.
tags

object

Značky prostředku.
type

string

Typ prostředku.

CloudError

Chyba požadavku REST.

Name Typ Description
error

CloudErrorBody

Chyba cloudu, ke které došlo

CloudErrorBody

Text chyby z požadavku REST

Name Typ Description
code

string

Kód chyby
details

CloudErrorBody[]

Vnitřní chyby.
message

string

Chybová zpráva
target

string

Cíl chyby.

DayDetails

Vlastnosti denního plánu.

Name Typ Description
time

string

Denní čas, kdy plán nastane.

EnableStatus

Stav plánu (tj. Povoleno, Zakázáno)

Name Typ Description
Disabled

string

Enabled

string

HourDetails

Vlastnosti hodinového plánu.

Name Typ Description
minute

integer

Počet minut v hodinách, kdy plán poběží.

NotificationSettings

Nastavení oznámení pro plán

Name Typ Default value Description
emailRecipient

string

Příjemce e-mailu, na který se mají posílat oznámení (může to být seznam e-mailových adres oddělených středníkem).
notificationLocale

string

Národní prostředí, které se má použít při odesílání oznámení (záložní pro nepodporované jazyky je EN).
status

EnableStatus

Disabled

Pokud jsou pro tento plán povolená oznámení (tj. Povoleno, Zakázáno).
timeInMinutes

integer

Čas v minutách před událostí, kdy se oznámení odešle.
webhookUrl

string

Adresa URL webhooku, na kterou se oznámení odešle.

Schedule

Plán.

Name Typ Default value Description
id

string

Identifikátor prostředku.
location

string

Umístění prostředku.
name

string

Název prostředku.
properties.createdDate

string

Datum vytvoření plánu.
properties.dailyRecurrence

DayDetails

Pokud bude plán probíhat každý den v týdnu, zadejte denní opakování.
properties.hourlyRecurrence

HourDetails

Pokud se plán bude vyskytovat několikrát denně, zadejte hodinové opakování.
properties.notificationSettings

NotificationSettings

Nastavení oznámení.
properties.provisioningState

string

Stav zřizování prostředku.
properties.status

EnableStatus

Disabled

Stav plánu (tj. Povoleno, Zakázáno)
properties.targetResourceId

string

ID prostředku, ke kterému patří plán
properties.taskType

string

Typ úlohy plánu (např. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId

string

ID časového pásma (např. Čína (běžný čas), Grónsko (běžný čas), Tichomoří (běžný čas) atd.). Možné hodnoty této vlastnosti najdete v IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier

string

Jedinečný neměnný identifikátor prostředku (GUID).
properties.weeklyRecurrence

WeekDetails

Pokud se plán bude vyskytnou jen některé dny v týdnu, zadejte týdenní opakování.
tags

object

Značky prostředku.
type

string

Typ prostředku.

WeekDetails

Vlastnosti týdenního plánu

Name Typ Description
time

string

Čas dne, kdy bude plán nacházet.
weekdays

string[]

Dny v týdnu, pro které je plán nastavený (např. neděle, pondělí, úterý atd.).