Schedule Class

  • Reference

Schedule object used to create and manage schedules.

This class should not be instantiated directly. Instead, please use the subclasses.

Inheritance
azure.ai.ml.entities._mixins.YamlTranslatableMixin
Schedule
azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin
Schedule
azure.ai.ml.entities._resource.Resource
Schedule

Constructor

Schedule(*, name: str, trigger: CronTrigger | RecurrenceTrigger | None, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The name of the schedule.
trigger
Union[CronTrigger, RecurrenceTrigger]

The schedule trigger configuration.
display_name
Optional[str]

The display name of the schedule.
description
Optional[str]

The description of the schedule.
tags
Optional[dict]]

Tag dictionary. Tags can be added, removed, and updated.
properties
Optional[dict[str, str]]

A dictionary of properties to associate with the schedule.
kwargs
dict

Additional keyword arguments passed to the Resource constructor.

Methods

dump

Dump the schedule content into a file in YAML format.

dump

Dump the schedule content into a file in YAML format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

The local path or file stream to write the YAML content to. If dest is a file path, a new file will be created. If dest is an open file, the file will be written to directly.

Exceptions

Type Description
FileExistsError

Raised if dest is a file path and the file already exists.
IOError

Raised if dest is an open file and the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

create_job

The create_job entity associated with the schedule if exists.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

is_enabled

Specifies if the schedule is enabled or not.

Returns

Type Description
bool

True if the schedule is enabled, False otherwise.

provisioning_state

Returns the schedule's provisioning state. The possible values include "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled".

Returns

Type Description
str

The schedule's provisioning state.

type

The schedule type. Accepted values are 'job' and 'monitor'.

Returns

Type Description
str

The schedule type.