build_job_schedule

kedro_azureml_pipeline.scheduler.build_job_schedule(name, trigger, pipeline_job, display_name=None, description=None)

Wrap an Azure ML pipeline job into a JobSchedule.

Parameters

Name	Type	Description	Default
name	str	Unique schedule name in the Azure ML workspace.	required
trigger	CronTrigger or RecurrenceTrigger	Trigger defining when the job should run.	required
pipeline_job	Job	Azure ML pipeline job to execute on each trigger.	required
display_name	str or None	Human-readable display name.	None
description	str or None	Schedule description.	None

Returns

Type	Description
JobSchedule	Ready to submit via ml_client.schedules.

See Also

build_trigger : Creates the trigger argument. AzureMLScheduleClient : Submits this schedule.

Source Code

View on GitHub

Show/Hide source

def build_job_schedule(
    name: str,
    trigger: CronTrigger | RecurrenceTrigger,
    pipeline_job: Job,
    display_name: str | None = None,
    description: str | None = None,
) -> JobSchedule:
    """Wrap an Azure ML pipeline job into a ``JobSchedule``.

    Parameters
    ----------
    name : str
        Unique schedule name in the Azure ML workspace.
    trigger : CronTrigger or RecurrenceTrigger
        Trigger defining when the job should run.
    pipeline_job : Job
        Azure ML pipeline job to execute on each trigger.
    display_name : str or None
        Human-readable display name.
    description : str or None
        Schedule description.

    Returns
    -------
    JobSchedule
        Ready to submit via ``ml_client.schedules``.

    See Also
    --------
    [build_trigger][kedro_azureml_pipeline.scheduler.build_trigger] : Creates the trigger argument.
    [AzureMLScheduleClient][kedro_azureml_pipeline.scheduler.AzureMLScheduleClient] : Submits this schedule.
    """
    return JobSchedule(
        name=name,
        trigger=trigger,
        create_job=pipeline_job,
        display_name=display_name or None,
        description=description or None,
    )