Virtual Machines - List Applicable Schedules

Usługa:: Dev Test Labs

Wersja interfejsu API:: 2018-09-15

Wyświetla 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 LabVirtualMachine
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApplicableSchedule	Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

VirtualMachines_ListApplicableSchedules

Przykładowe żądanie

HTTP

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": {
      "name": "LabVmsShutdown",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule",
      "location": "{location}",
      "properties": {
        "createdDate": "2020-12-29T21:48:14.1369355+00:00",
        "dailyRecurrence": {
          "time": "1900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Succeeded",
        "status": "Enabled",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "taskType": "LabVmsShutdownTask",
        "timeZoneId": "Pacific Standard Time",
        "uniqueIdentifier": "4acf0408-1c10-49cb-96b7-28ce655c8320",
        "weeklyRecurrence": {
          "time": "1700",
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ]
        }
      }
    },
    "labVmsStartup": {
      "name": "LabVmAutoStart",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule",
      "location": "{location}",
      "properties": {
        "createdDate": "2020-12-29T21:46:37.0473976+00:00",
        "dailyRecurrence": {
          "time": "0900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Succeeded",
        "status": "Enabled",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "taskType": "LabVmsStartupTask",
        "timeZoneId": "Pacific Standard Time",
        "weeklyRecurrence": {
          "time": "1000",
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ]
        }
      }
    }
  }
}

Definicje

Nazwa	Opis
ApplicableSchedule	Harmonogramy dotyczące maszyny wirtualnej. Harmonogramy mogły zostać zdefiniowane na maszynie wirtualnej lub na poziomie laboratorium.
DayDetails	Właściwości harmonogramu dziennego.
EnableStatus	Wskazuje, czy źródło artefaktu jest włączone (wartości: Włączone, Wyłączone).
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
HourDetails	Właściwości harmonogramu godzinowego.
NotificationSettings	Ustawienia powiadomień dla harmonogramu.
Schedule	Harmonogram.
WeekDetails	Właściwości harmonogramu tygodniowego.

ApplicableSchedule

Objekt

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 zasobu laboratorium lub laboratorium.
tags	object	Tagi zasobu.
type	string	Typ zasobu.

DayDetails

Objekt

Właściwości harmonogramu dziennego.

Nazwa	Typ	Opis
time	string	Godzina dnia, w ramach których zostanie zaplanowany harmonogram.

EnableStatus

Wyliczanie

Wskazuje, czy źródło artefaktu jest włączone (wartości: Włączone, Wyłączone).

Wartość	Opis
Enabled
Disabled

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

HourDetails

Objekt

Właściwości harmonogramu godzinowego.

Nazwa	Typ	Opis
minute	integer (int32)	Minuty godziny, w których zostanie uruchomiony harmonogram.

NotificationSettings

Objekt

Ustawienia powiadomień dla harmonogramu.

Nazwa	Typ	Domyślna wartość	Opis
emailRecipient	string		Adresat wiadomości e-mail do wysyłania powiadomień (może być listą adresów e-mail rozdzielonych średnikami).
notificationLocale	string		Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwowe 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 (int32)		Czas 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

Objekt

Harmonogram.

Nazwa	Typ	Domyślna wartość	Opis
id	string		Identyfikator zasobu.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.createdDate	string (date-time)		Data utworzenia harmonogramu.
properties.dailyRecurrence	DayDetails		Jeśli harmonogram będzie występować raz dziennie tygodnia, określ cykl dzienny.
properties.hourlyRecurrence	HourDetails		Jeśli harmonogram będzie występować 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 `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

Objekt

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 zaplanowano harmonogram (np. niedziela, poniedziałek, wtorek itp.).

Udostępnij przez

Virtual Machines - List Applicable Schedules

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

VirtualMachines_ListApplicableSchedules

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ApplicableSchedule

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

WeekDetails