Virtual Machines - List Applicable Schedules

  • Référence
Service:
Dev Test Labs
API Version:
2018-09-15

Répertorie les planifications de démarrage/arrêt applicables, le cas échéant.

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

Paramètres URI

Nom Dans Obligatoire Type Description
labName
 path True

string

Nom du lab.
name
 path True

string

Nom de la machine virtuelle.
resourceGroupName
 path True

string

Nom du groupe de ressources.
subscriptionId
 path True

string

L'ID de l'abonnement.
api-version
 query True

string

Version d’API client.

Réponses

Nom Type Description
200 OK

ApplicableSchedule

Ok
Other Status Codes

CloudError

BadRequest

Sécurité

azure_auth

Octroi implicite OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom Description
user_impersonation Accéder à Microsoft Azure

Exemples

VirtualMachines_ListApplicableSchedules

Sample Request

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

Sample Response

Status code:
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}"
    }
  }
}

Définitions

Nom Description
ApplicableSchedule

Planifications applicables à une machine virtuelle. Les planifications peuvent avoir été définies sur une machine virtuelle ou au niveau du labo.
CloudError

Erreur d’une requête REST.
CloudErrorBody

Corps d’une erreur à partir d’une requête REST.
DayDetails

Propriétés d’une planification quotidienne.
EnableStatus

Status de la planification (par exemple, Activé, Désactivé)
HourDetails

Propriétés d’une planification horaire.
NotificationSettings

Paramètres de notification pour une planification.
Schedule

Une planification.
WeekDetails

Propriétés d’une planification hebdomadaire.

ApplicableSchedule

Planifications applicables à une machine virtuelle. Les planifications peuvent avoir été définies sur une machine virtuelle ou au niveau du labo.

Nom Type Description
id

string

Identificateur de la ressource.
location

string

Emplacement de la ressource.
name

string

Nom de la ressource.
properties.labVmsShutdown

Schedule

Planification de l’arrêt automatique, si elle a été définie au niveau de la ressource lab ou lab.
properties.labVmsStartup

Schedule

Planification de démarrage automatique, si elle a été définie au niveau de la ressource lab ou lab.
tags

object

Balises de la ressource.
type

string

Type de la ressource.

CloudError

Erreur d’une requête REST.

Nom Type Description
error

CloudErrorBody

Erreur cloud qui s’est produite

CloudErrorBody

Corps d’une erreur à partir d’une requête REST.

Nom Type Description
code

string

Code d'erreur.
details

CloudErrorBody[]

Erreurs internes.
message

string

Message d’erreur.
target

string

Cible d’erreur.

DayDetails

Propriétés d’une planification quotidienne.

Nom Type Description
time

string

Heure de la journée à laquelle la planification aura lieu.

EnableStatus

Status de la planification (par exemple, Activé, Désactivé)

Nom Type Description
Disabled

string

Enabled

string

HourDetails

Propriétés d’une planification horaire.

Nom Type Description
minute

integer

Minutes de l’heure d’exécution de la planification.

NotificationSettings

Paramètres de notification pour une planification.

Nom Type Valeur par défaut Description
emailRecipient

string

Destinataire de l’e-mail auquel envoyer des notifications (peut être une liste d’adresses e-mail séparées par des points-deux-points).
notificationLocale

string

Paramètres régionaux à utiliser lors de l’envoi d’une notification (secours pour les langues non prises en charge est EN).
status

EnableStatus

Disabled

Si les notifications sont activées pour cette planification (par exemple, Activé, Désactivé).
timeInMinutes

integer

Heure en minutes avant l’événement à laquelle la notification sera envoyée.
webhookUrl

string

URL du webhook à laquelle la notification sera envoyée.

Schedule

Une planification.

Nom Type Valeur par défaut Description
id

string

Identificateur de la ressource.
location

string

Emplacement de la ressource.
name

string

Nom de la ressource.
properties.createdDate

string

Date de création de la planification.
properties.dailyRecurrence

DayDetails

Si la planification se produit une fois par jour de la semaine, spécifiez la périodicité quotidienne.
properties.hourlyRecurrence

HourDetails

Si la planification se produit plusieurs fois par jour, spécifiez la périodicité horaire.
properties.notificationSettings

NotificationSettings

Paramètres de notification.
properties.provisioningState

string

Status d’approvisionnement de la ressource.
properties.status

EnableStatus

Disabled

Status de la planification (par exemple, Activé, Désactivé)
properties.targetResourceId

string

ID de ressource auquel appartient la planification
properties.taskType

string

Type de tâche de la planification (par exemple, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId

string

L’ID de fuseau horaire (par exemple, l’heure standard de la Chine, l’heure standard du Groenland, l’heure du Pacifique, etc.). Les valeurs possibles pour cette propriété se trouvent dans IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier

string

Identificateur immuable unique d’une ressource (GUID).
properties.weeklyRecurrence

WeekDetails

Si la planification ne se produit que quelques jours de la semaine, spécifiez la périodicité hebdomadaire.
tags

object

Balises de la ressource.
type

string

Type de la ressource.

WeekDetails

Propriétés d’une planification hebdomadaire.

Nom Type Description
time

string

Heure du jour où la planification aura lieu.
weekdays

string[]

Jours de la semaine pour lesquels la planification est définie (par exemple, dimanche, lundi, mardi, etc.).