Condividi tramite

Virtual Machines - List Applicable Schedules

  • Riferimento
Servizio:
Dev Test Labs
Versione API:
2018-09-15

Elenca le pianificazioni di avvio/arresto applicabili, se presenti.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
labName
 path True

string

Il nome del lab.
name
 path True

string

Nome della macchina virtuale.
resourceGroupName
 path True

string

Nome del gruppo di risorse.
subscriptionId
 path True

string

ID della sottoscrizione.
api-version
 query True

string

Versione API client.

Risposte

Nome Tipo Descrizione
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

Sicurezza

azure_auth

Concessione implicita OAuth2

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation Accedere a Microsoft Azure

Esempio

VirtualMachines_ListApplicableSchedules

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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}"
    }
  }
}

Definizioni

Nome Descrizione
ApplicableSchedule

Pianificazioni applicabili a una macchina virtuale. Le pianificazioni possono essere state definite in una macchina virtuale o a livello di lab.
CloudError

Errore da una richiesta REST.
CloudErrorBody

Corpo di un errore da una richiesta REST.
DayDetails

Proprietà di una pianificazione giornaliera.
EnableStatus

Stato della pianificazione (ad esempio Abilitato, Disabilitato)
HourDetails

Proprietà di una pianificazione oraria.
NotificationSettings

Impostazioni di notifica per una pianificazione.
Schedule

Una pianificazione.
WeekDetails

Proprietà di una pianificazione settimanale.

ApplicableSchedule

Pianificazioni applicabili a una macchina virtuale. Le pianificazioni possono essere state definite in una macchina virtuale o a livello di lab.

Nome Tipo Descrizione
id

string

Identificatore della risorsa.
location

string

Il percorso della risorsa.
name

string

Nome della risorsa.
properties.labVmsShutdown

Schedule

Pianificazione dell'arresto automatico, se è stato impostato a livello di risorsa lab o lab.
properties.labVmsStartup

Schedule

La pianificazione di avvio automatico, se è stata impostata a livello di risorsa lab o lab.
tags

object

Tag della risorsa.
type

string

Tipo di risorsa.

CloudError

Errore da una richiesta REST.

Nome Tipo Descrizione
error

CloudErrorBody

Errore cloud che si è verificato

CloudErrorBody

Corpo di un errore da una richiesta REST.

Nome Tipo Descrizione
code

string

Codice di errore.
details

CloudErrorBody[]

Errori interni.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

DayDetails

Proprietà di una pianificazione giornaliera.

Nome Tipo Descrizione
time

string

Ora del giorno in cui verrà eseguita la pianificazione.

EnableStatus

Stato della pianificazione (ad esempio Abilitato, Disabilitato)

Nome Tipo Descrizione
Disabled

string

Enabled

string

HourDetails

Proprietà di una pianificazione oraria.

Nome Tipo Descrizione
minute

integer

Minuti dell'ora in cui verrà eseguita la pianificazione.

NotificationSettings

Impostazioni di notifica per una pianificazione.

Nome Tipo Valore predefinito Descrizione
emailRecipient

string

Il destinatario del messaggio di posta elettronica a cui inviare notifiche (può essere un elenco di indirizzi di posta elettronica separati da punto e virgola).
notificationLocale

string

Impostazioni locali da usare per l'invio di una notifica (fallback per le lingue non supportate è EN).
status

EnableStatus

Disabled

Se le notifiche sono abilitate per questa pianificazione ,ad esempio Abilitato, Disabilitato.
timeInMinutes

integer

Tempo in minuti prima dell'evento in cui verrà inviata la notifica.
webhookUrl

string

URL del webhook a cui verrà inviata la notifica.

Schedule

Una pianificazione.

Nome Tipo Valore predefinito Descrizione
id

string

Identificatore della risorsa.
location

string

Il percorso della risorsa.
name

string

Nome della risorsa.
properties.createdDate

string

Data di creazione della pianificazione.
properties.dailyRecurrence

DayDetails

Se la pianificazione verrà eseguita una volta ogni giorno della settimana, specificare la ricorrenza giornaliera.
properties.hourlyRecurrence

HourDetails

Se la pianificazione verrà eseguita più volte al giorno, specificare la ricorrenza oraria.
properties.notificationSettings

NotificationSettings

Impostazioni di notifica.
properties.provisioningState

string

Stato del provisioning della risorsa.
properties.status

EnableStatus

Disabled

Stato della pianificazione (ad esempio Abilitato, Disabilitato)
properties.targetResourceId

string

ID risorsa a cui appartiene la pianificazione
properties.taskType

string

Tipo di attività della pianificazione, ad esempio LabVmsShutdownTask, LabVmAutoStart.
properties.timeZoneId

string

ID del fuso orario (ad esempio, ora solare cina, ora solare della Groenlandia, ora solare pacifico e così via). I valori possibili per questa proprietà sono disponibili in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier

string

Identificatore univoco non modificabile di una risorsa (GUID).
properties.weeklyRecurrence

WeekDetails

Se la pianificazione verrà eseguita solo alcuni giorni della settimana, specificare la ricorrenza settimanale.
tags

object

Tag della risorsa.
type

string

Tipo di risorsa.

WeekDetails

Proprietà di una pianificazione settimanale.

Nome Tipo Descrizione
time

string

Ora del giorno in cui verrà eseguita la pianificazione.
weekdays

string[]

Giorni della settimana per cui è impostata la pianificazione (ad esempio domenica, lunedì, martedì e così via).