Partager via

Service Fabrics - List Applicable Schedules

  • Référence
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}/users/{userName}/servicefabrics/{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

Nom de service fabric.
resourceGroupName
 path True

string

Nom du groupe de ressources.
subscriptionId
 path True

string

ID d’abonnement.
userName
 path True

string

Nom du profil utilisateur.
api-version
 query True

string

Version de l’API cliente.

Réponses

Nom Type Description
200 OK

ApplicableSchedule

D’ACCORD
Other Status Codes

CloudError

Requête incorrecte

Sécurité

azure_auth

Octroi implicite OAuth2

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

Étendues

Nom Description
user_impersonation Accéder à Microsoft Azure

Exemples

ServiceFabrics_ListApplicableSchedules

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{scheduleName}",
  "location": "{location}",
  "name": "{scheduleName}",
  "properties": {
    "labVmsShutdown": {
      "properties": {
        "status": "{Enabled|Disabled}",
        "taskType": "{myLabVmTaskType}",
        "weeklyRecurrence": {
          "weekdays": [
            "Monday",
            "Wednesday",
            "Friday"
          ],
          "time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}"
        },
        "dailyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "{Enabled|Disabled}",
          "timeInMinutes": 15,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2018-10-01T18:40:48.1739018-07:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
        "provisioningState": "Creating",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
      "name": "{scheduleName}",
      "type": "Microsoft.DevTestLab/labs/schedules",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    },
    "labVmsStartup": {
      "properties": {
        "status": "{Enabled|Disabled}",
        "taskType": "{myLabVmTaskType}",
        "weeklyRecurrence": {
          "weekdays": [
            "Monday",
            "Wednesday",
            "Friday"
          ],
          "time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}"
        },
        "dailyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "{Enabled|Disabled}",
          "timeInMinutes": 15,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2018-10-01T18:40:48.1739018-07:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
        "provisioningState": "Creating",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
      "name": "{scheduleName}",
      "type": "Microsoft.DevTestLab/labs/schedules",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  },
  "type": "{scheduleType}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

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.
CloudError

Erreur à partir 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

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

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.

CloudError

Object

Erreur à partir d’une requête REST.

Nom Type Description
error

CloudErrorBody

Erreur cloud qui s’est produite

CloudErrorBody

Object

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

Object

Propriétés d’une planification quotidienne.

Nom Type Description
time

string

L’heure de la planification se produit.

EnableStatus

Énumération

État de la planification (c’est-à-dire Activé, Désactivé)

Valeur Description
Disabled
Enabled

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