Partager via

Virtual Machines - List Applicable Schedules

Service:
Dev Test Labs
Version d'API:
2018-09-15

Répertorie les planifications de début/d’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 labo.
name
 path True

string

Le nom de la LabVirtualMachine
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

minLength: 1

ID de l’abonnement cible.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

ApplicableSchedule

L’opération Azure s’est terminée avec succès.
Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

VirtualMachines_ListApplicableSchedules

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
          ]
        }
      }
    }
  }
}

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 laboratoire.
DayDetails

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

Indique si la source de l’artefact est activée (valeurs : Activé, Désactivé).
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
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

Object

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

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 l’une d’elles a été définie au niveau du labo ou de la ressource lab.
properties.labVmsStartup

Schedule

Planification de démarrage automatique, si l’une d’elles a été définie au niveau du labo ou de la ressource lab.
tags

object

Balises de la ressource.
type

string

Type de la ressource.

DayDetails

Object

Propriétés d’une planification quotidienne.

Nom Type Description
time

string

L’heure de la planification se produit.

EnableStatus

Énumération

Indique si la source de l’artefact est activée (valeurs : Activé, Désactivé).

Valeur Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

HourDetails

Object

Propriétés d’une planification horaire.

Nom Type Description
minute

integer (int32)

Minutes de l’heure pendant laquelle la planification s’exécutera.

NotificationSettings

Object

Paramètres de notification pour une planification.

Nom Type Valeur par défaut Description
emailRecipient

string

Le destinataire de l’e-mail auquel envoyer des notifications (il peut s’agir d’une liste d’adresses e-mail séparées par des points-virgules).
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 (c’est-à-dire activée, désactivée).
timeInMinutes

integer (int32)

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

string

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

Schedule

Object

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-time)

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

État d’approvisionnement de la ressource.
properties.status

EnableStatus

Disabled

État de la planification (c’est-à-dire 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

ID de fuseau horaire (par exemple, Heure standard de chine, heure standard du Groenland, heure standard du Pacifique, etc.). Les valeurs possibles pour cette propriété sont disponibles 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

Object

Propriétés d’une planification hebdomadaire.

Nom Type Description
time

string

Heure de la planification.
weekdays

string[]

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