Udostępnij za pośrednictwem

Virtual Machines - List Applicable Schedules

  • Odwołanie
Usługa:
Dev Test Labs
Wersja interfejsu API:
2018-09-15

Listy odpowiednie harmonogramy uruchamiania/zatrzymywania, jeśli istnieją.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
labName
 path True

string

Nazwa laboratorium.
name
 path True

string

Nazwa maszyny wirtualnej.
resourceGroupName
 path True

string

Nazwa grupy zasobów.
subscriptionId
 path True

string

Identyfikator subskrypcji.
api-version
 query True

string

Wersja interfejsu API klienta.

Odpowiedzi

Nazwa Typ Opis
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

Zabezpieczenia

azure_auth

Udzielanie niejawne OAuth2

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation Uzyskiwanie dostępu do platformy Microsoft Azure

Przykłady

VirtualMachines_ListApplicableSchedules

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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}"
    }
  }
}

Definicje

Nazwa Opis
ApplicableSchedule

Harmonogramy dotyczące maszyny wirtualnej. Harmonogramy mogły zostać zdefiniowane na maszynie wirtualnej lub na poziomie laboratorium.
CloudError

Błąd żądania REST.
CloudErrorBody

Treść błędu z żądania REST.
DayDetails

Właściwości harmonogramu dziennego.
EnableStatus

Stan harmonogramu (tj. Włączone, Wyłączone)
HourDetails

Właściwości harmonogramu godzinowego.
NotificationSettings

Ustawienia powiadomień dla harmonogramu.
Schedule

Harmonogram.
WeekDetails

Właściwości harmonogramu tygodniowego.

ApplicableSchedule

Harmonogramy dotyczące maszyny wirtualnej. Harmonogramy mogły zostać zdefiniowane na maszynie wirtualnej lub na poziomie laboratorium.

Nazwa Typ Opis
id

string

Identyfikator zasobu.
location

string

Lokalizacja zasobu.
name

string

Nazwa zasobu.
properties.labVmsShutdown

Schedule

Harmonogram automatycznego zamykania, jeśli został ustawiony na poziomie laboratorium lub zasobu laboratorium.
properties.labVmsStartup

Schedule

Harmonogram automatycznego uruchamiania, jeśli został ustawiony na poziomie laboratorium lub zasobu laboratorium.
tags

object

Tagi zasobu.
type

string

Typ zasobu.

CloudError

Błąd żądania REST.

Nazwa Typ Opis
error

CloudErrorBody

Błąd chmury, który wystąpił

CloudErrorBody

Treść błędu z żądania REST.

Nazwa Typ Opis
code

string

Kod błędu.
details

CloudErrorBody[]

Błędy wewnętrzne.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

DayDetails

Właściwości harmonogramu dziennego.

Nazwa Typ Opis
time

string

Godzina dnia, w ramach których zostanie zaplanowany harmonogram.

EnableStatus

Stan harmonogramu (tj. Włączone, Wyłączone)

Nazwa Typ Opis
Disabled

string

Enabled

string

HourDetails

Właściwości harmonogramu godzinowego.

Nazwa Typ Opis
minute

integer

Minuty godziny, w których zostanie uruchomiony harmonogram.

NotificationSettings

Ustawienia powiadomień dla harmonogramu.

Nazwa Typ Domyślna wartość Opis
emailRecipient

string

Adresat wiadomości e-mail do wysyłania powiadomień do (może to być lista adresów e-mail rozdzielonych średnikami).
notificationLocale

string

Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwa dla nieobsługiwanych języków to EN).
status

EnableStatus

Disabled

Jeśli powiadomienia są włączone dla tego harmonogramu (tj. Włączone, Wyłączone).
timeInMinutes

integer

Godzina w minutach przed zdarzeniem, w którym zostanie wysłane powiadomienie.
webhookUrl

string

Adres URL elementu webhook, do którego zostanie wysłane powiadomienie.

Schedule

Harmonogram.

Nazwa Typ Domyślna wartość Opis
id

string

Identyfikator zasobu.
location

string

Lokalizacja zasobu.
name

string

Nazwa zasobu.
properties.createdDate

string

Data utworzenia harmonogramu.
properties.dailyRecurrence

DayDetails

Jeśli harmonogram wystąpi raz dziennie tygodnia, określ cykl dzienny.
properties.hourlyRecurrence

HourDetails

Jeśli harmonogram wystąpi wiele razy dziennie, określ cykl godzinowy.
properties.notificationSettings

NotificationSettings

Ustawienia powiadomień.
properties.provisioningState

string

Stan aprowizacji zasobu.
properties.status

EnableStatus

Disabled

Stan harmonogramu (tj. Włączone, Wyłączone)
properties.targetResourceId

string

Identyfikator zasobu, do którego należy harmonogram
properties.taskType

string

Typ zadania harmonogramu (np. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId

string

Identyfikator strefy czasowej (np. Chiny (czas standardowy, Grenlandia (czas standardowy), Pacyfik (czas standardowy itp.). Możliwe wartości tej właściwości można znaleźć w pliku IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier

string

Unikatowy niezmienny identyfikator zasobu (Guid).
properties.weeklyRecurrence

WeekDetails

Jeśli harmonogram będzie występował tylko kilka dni tygodnia, określ cykl tygodniowy.
tags

object

Tagi zasobu.
type

string

Typ zasobu.

WeekDetails

Właściwości harmonogramu tygodniowego.

Nazwa Typ Opis
time

string

Godzina dnia, w ramach których zostanie zaplanowany harmonogram.
weekdays

string[]

Dni tygodnia, dla których harmonogram jest ustawiony (np. niedziela, poniedziałek, wtorek itp.).