Schedule Classe

Permet de créer une planification pour un pipeline.

Spécifiez la périodicité d’une planification sur une base temporelle, ou spécifiez un magasin de données, polling_interval (facultatif), data_path_parameter_name (facultatif) pour créer une planification qui effectue le monitoring de l’emplacement du magasin de données à la recherche de modifications/d’ajouts.

static create(workspace, name, pipeline_id, experiment_name, recurrence=None, description=None, pipeline_parameters=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=5, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Crée une planification pour un point de terminaison de pipeline.

Spécifiez la périodicité d’une planification sur une base temporelle, ou spécifiez un magasin de données, polling_interval (facultatif), data_path_parameter_name (facultatif) pour créer une planification qui effectue le monitoring de l’emplacement du magasin de données à la recherche de modifications/d’ajouts.

static create_for_pipeline_endpoint(workspace, name, pipeline_endpoint_id, experiment_name, recurrence=None, description=None, pipeline_parameters=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=5, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Permet de définir la planification à l’état « Désactivé » pour l’empêcher de s’exécuter.

disable(wait_for_provisioning=False, wait_timeout=3600)

Paramètres

Permet de définir la planification à l’état « Actif » pour lui permettre de s’exécuter.

enable(wait_for_provisioning=False, wait_timeout=3600)

Paramètres

Permet d’obtenir la planification ayant l’ID donné.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Permet d’obtenir toutes les planifications de l’espace de travail actuel.

DÉPRÉCIÉE : Cette méthode est dépréciée en faveur de la méthode list.

static get_all(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Permet de récupérer la dernière exécution de pipeline soumise par la planification. Retourne None si aucune exécution n’a été soumise.

get_last_pipeline_run()

Retours

Permet de récupérer les exécutions de pipeline générées à partir de la planification.

get_pipeline_runs()

Retours

Permet d’obtenir toutes les planifications correspondant à l’ID de point de terminaison de pipeline donné.

static get_schedules_for_pipeline_endpoint_id(workspace, pipeline_endpoint_id, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Permet d’obtenir toutes les planifications correspondant à l’ID de pipeline donné.

static get_schedules_for_pipeline_id(workspace, pipeline_id, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Permet d’obtenir toutes les planifications de l’espace de travail actuel.

static list(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Permet de charger et de lire le fichier YAML pour obtenir les paramètres de planification.

Le fichier YAML est un moyen supplémentaire de passer les paramètres de Schedule pour créer une planification.

static load_yaml(workspace, filename, _workflow_provider=None, _service_endpoint=None)

Paramètres

Retours

Remarques

Deux types de fichier YAML sont pris en charge pour les planifications. Le premier lit et charge les informations de périodicité pour permettre la création de la planification et le déclenchement du pipeline. Le deuxième lit et charge les informations du magasin de données pour permettre la création de la planification et le déclenchement du pipeline.

Exemple de création d’une planification qui soumet un pipeline en fonction d’une périodicité :

   from azureml.pipeline.core import Schedule

   schedule_info = Schedule.load_yaml(workspace=workspace,
                                      filename='./yaml/test_schedule_with_recurrence.yaml')
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld", recurrence=schedule_info.get("recurrence"),
                              description=schedule_info.get("description"))

Exemple de fichier YAML test_schedule_with_recurrence.yaml :

   Schedule:
       description: "Test create with recurrence"
       recurrence:
           frequency: Week # Can be "Minute", "Hour", "Day", "Week", or "Month".
           interval: 1 # how often fires
           start_time: 2019-06-07T10:50:00
           time_zone: UTC
           hours:
           - 1
           minutes:
           - 0
           time_of_day: null
           week_days:
           - Friday
       pipeline_parameters: {'a':1}
       wait_for_provisioning: True
       wait_timeout: 3600
       datastore_name: ~
       polling_interval: ~
       data_path_parameter_name: ~
       continue_on_step_failure: None
       path_on_datastore: ~

Exemple de création d’une planification qui soumet un pipeline en fonction d’un magasin de données :

   from azureml.pipeline.core import Schedule

   schedule_info = Schedule.load_yaml(workspace=workspace,
                                      filename='./yaml/test_schedule_with_datastore.yaml')
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld",datastore=schedule_info.get("datastore_name"),
                              polling_interval=schedule_info.get("polling_interval"),
                              data_path_parameter_name=schedule_info.get("data_path_parameter_name"),
                              continue_on_step_failure=schedule_info.get("continue_on_step_failure"),
                              path_on_datastore=schedule_info.get("path_on_datastore"))

Permet de mettre à jour la planification.

update(name=None, description=None, recurrence=None, pipeline_parameters=None, status=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=None, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None)

Paramètres

Permet d’obtenir la valeur du paramètre continue_on_step_failure.

Retours

Permet d’obtenir le nom du paramètre de pipeline relatif au chemin de données à définir avec le chemin d’objet blob changé.

Retours

Permet d’obtenir le nom du magasin de données utilisé pour la planification.

Retours

Permet d’obtenir la description de la planification.

Retours

Permet d’obtenir l’ID de la planification.

Retours

Permet d’obtenir le nom de la planification.

Retours

Permet d’obtenir le chemin au sein du magasin de données faisant l’objet d’un monitoring par la planification.

Retours

Obtient l’ID du point de terminaison de pipeline soumis par la planification.

Retours

Permet d’obtenir l’ID du pipeline soumis par la planification.

Retours

Permet d’obtenir le délai, en minutes, qui s’écoule entre les interrogations des objets blob modifiés/ajoutés.

Retours

Permet d’obtenir la périodicité de la planification.

Retours

Permet d’obtenir l’état de la planification.

Retours