Virtual Machines - List Applicable Schedules

Dienst:: Dev Test Labs

API-Version:: 2018-09-15

Listet ggf. die zutreffenden Start-/Stopppläne auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labors.
name	path	True	string	Der Name der LabVirtualMachine
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ApplicableSchedule	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VirtualMachines_ListApplicableSchedules

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
          ]
        }
      }
    }
  }
}

Definitionen

Name	Beschreibung
ApplicableSchedule	Zeitpläne, die für einen virtuellen Computer gelten. Möglicherweise wurden die Zeitpläne auf einer VM oder auf Laborebene definiert.
DayDetails	Eigenschaften eines täglichen Zeitplans.
EnableStatus	Gibt an, ob die Artefaktquelle aktiviert ist (Werte: Aktiviert, deaktiviert).
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HourDetails	Eigenschaften eines stündlich geplanten Zeitplans.
NotificationSettings	Benachrichtigungseinstellungen für einen Zeitplan.
Schedule	Ein Zeitplan.
WeekDetails	Eigenschaften eines wöchentlichen Zeitplans.

ApplicableSchedule

Objekt

Zeitpläne, die für einen virtuellen Computer gelten. Möglicherweise wurden die Zeitpläne auf einer VM oder auf Laborebene definiert.

Name	Typ	Beschreibung
id	string	Der Bezeichner der Ressource.
location	string	Der Standort der Ressource.
name	string	Der Name der Ressource.
properties.labVmsShutdown	Schedule	Der Zeitplan für das automatische Herunterfahren, wenn eins auf Lab- oder Lab-Ressourcenebene festgelegt wurde.
properties.labVmsStartup	Schedule	Der Zeitplan für den automatischen Start, wenn eins auf Lab- oder Lab-Ressourcenebene festgelegt wurde.
tags	object	Die Tags der Ressource.
type	string	Der Typ der Ressource.

DayDetails

Objekt

Eigenschaften eines täglichen Zeitplans.

Name	Typ	Beschreibung
time	string	Die Tageszeit, zu der der Zeitplan eintritt.

EnableStatus

Enumeration

Gibt an, ob die Artefaktquelle aktiviert ist (Werte: Aktiviert, deaktiviert).

Wert	Beschreibung
Enabled
Disabled

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HourDetails

Objekt

Eigenschaften eines stündlich geplanten Zeitplans.

Name	Typ	Beschreibung
minute	integer (int32)	Minuten der Stunde, die der Zeitplan ausgeführt wird.

NotificationSettings

Objekt

Benachrichtigungseinstellungen für einen Zeitplan.

Name	Typ	Standardwert	Beschreibung
emailRecipient	string		Der E-Mail-Empfänger, an den Benachrichtigungen gesendet werden sollen (kann eine Liste von durch Semikolons getrennten E-Mail-Adressen sein).
notificationLocale	string		Das Gebietsschema, das beim Senden einer Benachrichtigung verwendet werden soll (Fallback für nicht unterstützte Sprachen ist EN).
status	EnableStatus	Disabled	Wenn Benachrichtigungen für diesen Zeitplan aktiviert sind (d. h. aktiviert, deaktiviert).
timeInMinutes	integer (int32)		Zeit in Minuten vor dem Ereignis, zu dem die Benachrichtigung gesendet wird.
webhookUrl	string		Die Webhook-URL, an die die Benachrichtigung gesendet wird.

Schedule

Objekt

Ein Zeitplan.

Name	Typ	Standardwert	Beschreibung
id	string		Der Bezeichner der Ressource.
location	string		Der Standort der Ressource.
name	string		Der Name der Ressource.
properties.createdDate	string (date-time)		Das Erstellungsdatum des Zeitplans.
properties.dailyRecurrence	DayDetails		Wenn der Zeitplan einmal pro Wochentag auftritt, geben Sie die tägliche Serie an.
properties.hourlyRecurrence	HourDetails		Wenn der Zeitplan mehrmals pro Tag auftritt, geben Sie die Stündlichkeitsserie an.
properties.notificationSettings	NotificationSettings		Benachrichtigungseinstellungen.
properties.provisioningState	string		Der Bereitstellungsstatus der Ressource.
properties.status	EnableStatus	Disabled	Der Status des Zeitplans (d. h. aktiviert, deaktiviert)
properties.targetResourceId	string		Die Ressourcen-ID, zu der der Zeitplan gehört
properties.taskType	string		Der Vorgangstyp des Zeitplans (z. B. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		Die Zeitzonen-ID (z. B. China Standardzeit, Grönland Standardzeit, Pazifische Standardzeit usw.). Die möglichen Werte für diese Eigenschaft finden Sie in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Der eindeutige unveränderliche Bezeichner einer Ressource (GUID).
properties.weeklyRecurrence	WeekDetails		Wenn der Zeitplan nur einige Wochentage auftritt, geben Sie die wöchentliche Serie an.
tags	object		Die Tags der Ressource.
type	string		Der Typ der Ressource.

WeekDetails

Objekt

Eigenschaften eines wöchentlichen Zeitplans.

Name	Typ	Beschreibung
time	string	Die Uhrzeit des Tages, zu dem der Zeitplan eintritt.
weekdays	string[]	Die Wochentage, für die der Zeitplan festgelegt ist (z. B. Sonntag, Montag, Dienstag usw.).

Freigeben über

Virtual Machines - List Applicable Schedules

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

VirtualMachines_ListApplicableSchedules

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ApplicableSchedule

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

WeekDetails