Partager via


ScheduleRecurrence Classe

Définit la fréquence, l’intervalle et l’heure de début d’un pipeline Schedule.

ScheduleRecurrence vous permet également de spécifier le fuseau horaire ainsi que les heures, les minutes ou les jours de la périodicité.

Initialisez une périodicité de planification.

Il permet également de spécifier le fuseau horaire et les heures, minutes ou jours de la semaine pour la périodicité.

Héritage
builtins.object
ScheduleRecurrence

Constructeur

ScheduleRecurrence(frequency, interval, start_time=None, time_zone=None, hours=None, minutes=None, week_days=None, time_of_day=None)

Paramètres

frequency
str
Obligatoire

Unité de temps qui décrit la fréquence à laquelle la planification se déclenche. Peut correspondre à « Minute », « Hour », « Day », « Week » ou « Month ».

interval
int
Obligatoire

Valeur qui spécifie le déclenchement de la planification en fonction de sa fréquence, c’est-à-dire le temps d’attente basé sur les unités de temps avant le nouveau déclenchement de la planification.

start_time
datetime ou str
valeur par défaut: None

Objet DateHeure qui décrit la date et l’heure de début. Le tzinfo de l’objet DateHeure doit être None. Utilisez la propriété time_zone pour spécifier un fuseau horaire si nécessaire. Vous pouvez également spécifier ce paramètre sous forme de chaîne au format suivant : AAAA-MM-JJThh:mm:ss. Si None est indiqué, la première charge de travail est exécutée instantanément. Les charges de travail suivantes sont exécutées en fonction de la planification. Si l’heure de début est dans le passé, la première charge de travail est exécutée au moment d’exécution calculé suivant.

Si start_time correspond à week_days et time_of_day (ou hours et minutes), la première charge de travail ne s’exécute pas à start_time, mais s’exécute à la place au moment de l’exécution calculée suivante.

time_zone
TimeZone
valeur par défaut: None

Permet de spécifier le fuseau horaire de start_time. Si None est spécifié, le format UTC est utilisé.

hours
list[int]
valeur par défaut: None

Si vous choisissez « Day » ou « Week » pour la fréquence, vous pouvez spécifier un ou plusieurs entiers compris entre 0 et 23, séparés par des virgules, afin d’indiquer les heures de la journée où vous souhaitez exécuter le workflow. Par exemple, si vous spécifiez « 10 », « 12 » et « 14 », vous obtenez 10h00, 12h00 et 14h00 comme marques horaires. Remarque : Seuls time_of_day ou hours et minutes peuvent être utilisés.

minutes
list[int]
valeur par défaut: None

Si vous choisissez « Day » ou « Week » pour la fréquence, vous pouvez spécifier un ou plusieurs entiers compris entre 0 et 59, séparés par des virgules, afin d’indiquer les minutes de l’heure où vous souhaitez exécuter le workflow. Par exemple, vous pouvez spécifier « 30 » pour les minutes et à l’aide de l’exemple précédent des heures de la journée, vous obtenez 10h30, 12h30 et 14h30. Remarque : Seuls time_of_day ou hours et minutes peuvent être utilisés.

week_days
list[str]
valeur par défaut: None

Si vous choisissez « Week » pour la fréquence, vous pouvez spécifier un ou plusieurs jours, séparés par des virgules, afin d’indiquer le moment où vous souhaitez exécuter le workflow : « Monday », « Tuesday », « Wednesday », « Thursday », « Friday », « Saturday » et « Sunday ».

time_of_day
str
valeur par défaut: None

Si vous choisissez « Day » ou « Week » pour la fréquence, vous pouvez spécifier une heure de la journée sous forme de chaîne au format hh:mm afin d’indiquer le moment où la planification doit s’exécuter. Par exemple, si vous spécifiez « 15:30 », la planification s’exécute à 15h30. Remarque : only time_of_day ou hours et minutes peuvent être utilisés.

frequency
str
Obligatoire

Unité de temps qui décrit la fréquence à laquelle la planification se déclenche. Peut correspondre à « Minute », « Hour », « Day », « Week » ou « Month ».

interval
int
Obligatoire

Valeur qui spécifie le déclenchement de la planification en fonction de sa fréquence, c’est-à-dire le temps d’attente basé sur les unités de temps avant le nouveau déclenchement de la planification.

start_time
datetime ou str
Obligatoire

Objet DateHeure qui décrit la date et l’heure de début. Le tzinfo de l’objet datetime doit être none. Utilisez time_zone propriété pour spécifier un fuseau horaire si nécessaire. Peut également être une chaîne au format suivant : AAAA-MM-JJThh:mm:ss. Si aucun est fourni, la première charge de travail est exécutée instantanément et les charges de travail futures sont exécutées en fonction de la planification. Si l’heure de début est dans le passé, la première charge de travail est exécutée au moment d’exécution calculé suivant.

Si start_time correspond à week_days et time_of_day (ou hours et minutes), la première charge de travail ne s’exécute pas à start_time, mais s’exécute à la place au moment de l’exécution calculée suivante.

time_zone
TimeZone
Obligatoire

Spécifiez le fuseau horaire du start_time. Si None est spécifié, le format UTC est utilisé.

hours
list[int]
Obligatoire

Si vous choisissez « Day » ou « Week » pour la fréquence, vous pouvez spécifier un ou plusieurs entiers compris entre 0 et 23, séparés par des virgules, afin d’indiquer les heures de la journée où vous souhaitez exécuter le workflow. Par exemple, si vous spécifiez « 10 », « 12 » et « 14 », vous obtenez 10h00, 12h00 et 14h00 comme marques horaires. Remarque : seules les time_of_day ou heures et minutes peuvent être utilisées.

minutes
list[int]
Obligatoire

Si vous choisissez « Day » ou « Week » pour la fréquence, vous pouvez spécifier un ou plusieurs entiers compris entre 0 et 59, séparés par des virgules, afin d’indiquer les minutes de l’heure où vous souhaitez exécuter le workflow. Par exemple, vous pouvez spécifier « 30 » pour les minutes et à l’aide de l’exemple précédent des heures de la journée, vous obtenez 10h30, 12h30 et 14h30. Remarque : seules les time_of_day ou heures et minutes peuvent être utilisées.

week_days
list[str]
Obligatoire

Si vous spécifiez « Semaine » pour la fréquence, vous pouvez spécifier un ou plusieurs jours, séparés par des virgules, lorsque vous souhaitez exécuter le flux de travail : « Lundi », « Mardi », « Mercredi », « Jeudi », « Vendredi », « Samedi » et « Dimanche »

time_of_day
str
Obligatoire

Si vous choisissez « Day » ou « Week » pour la fréquence, vous pouvez spécifier une heure de la journée sous forme de chaîne au format hh:mm afin d’indiquer le moment où la planification doit s’exécuter. Par exemple, si vous spécifiez « 15:30 », la planification s’exécute à 15h30. Remarque : seules les time_of_day ou heures et minutes peuvent être utilisées.

Remarques

ScheduleRecurrence est utilisé au moment de la création d’une planification pour un pipeline de la manière suivante :


   from azureml.pipeline.core import Schedule, ScheduleRecurrence

   recurrence = ScheduleRecurrence(frequency="Hour", interval=12)
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id=pipeline.id,
                              experiment_name="experiment_name", recurrence=recurrence)

Voici quelques exemples de ScheduleRecurrences valides :


   from azureml.pipeline.core import ScheduleRecurrence

   # Submit the Pipeline every 15 minutes
   recurrence = ScheduleRecurrence(frequency="Minute", interval=15)
   # Submit the Pipeline every 2 weeks on Monday and Wednesday at 6:30pm UTC
   recurrence = ScheduleRecurrence(frequency="Week", interval=2, week_days=["Monday", "Wednesday"],
                                   time_of_day="18:30")
   # Submit the Pipeline on the first day of every month starting November 1, 2019 at 9AM
   recurrence = ScheduleRecurrence(frequency="Month", interval=1, start_time="2019-11-01T09:00:00")
   # Submit the Pipeline every hour on the 55th minute starting on January 13th, 2020 at 12:55pm
   # if the specified start time is in the past, the first workload is run at the next future 55th minute
   # of the hour.
   recurrence = ScheduleRecurrence(frequency="Hour", interval=1, start_time="2020-01-13T12:55:00")

Méthodes

validate

Permet de valider la périodicité de la planification.

validate

Permet de valider la périodicité de la planification.

validate()