BetaSchedulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:schedules> attribute.

Constructor

BetaSchedulesOperations(*args, **kwargs)

Methods

create_or_update

Create or update a schedule.

Creates a new schedule or updates an existing schedule with the supplied definition.
delete

Delete a schedule.

Deletes the specified schedule resource.
get

Get a schedule.

Retrieves the specified schedule resource.
get_run

Get a schedule run.

Retrieves the specified run for a schedule.
list

List schedules.

Returns schedules that match the supplied type and enabled filters.
list_runs

List schedule runs.

Returns schedule runs that match the supplied filters.

create_or_update

Create or update a schedule.

Creates a new schedule or updates an existing schedule with the supplied definition.

create_or_update(schedule_id: str, schedule: _models.Schedule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Schedule

Parameters

Name Description
schedule_id
Required
str

Identifier of the schedule. Required.
schedule
Required
Schedule or <xref:JSON> or IO[bytes]

The resource instance. Is one of the following types: Schedule, JSON, IO[bytes] Required.

Returns

Type Description
Schedule

Schedule. The Schedule is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete

Delete a schedule.

Deletes the specified schedule resource.

delete(schedule_id: str, **kwargs: Any) -> None

Parameters

Name Description
schedule_id
Required
str

Identifier of the schedule. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get

Get a schedule.

Retrieves the specified schedule resource.

get(schedule_id: str, **kwargs: Any) -> Schedule

Parameters

Name Description
schedule_id
Required
str

Identifier of the schedule. Required.

Returns

Type Description
Schedule

Schedule. The Schedule is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get_run

Get a schedule run.

Retrieves the specified run for a schedule.

get_run(schedule_id: str, run_id: str, **kwargs: Any) -> ScheduleRun

Parameters

Name Description
schedule_id
Required
str

The unique identifier of the schedule. Required.
run_id
Required
str

The unique identifier of the schedule run. Required.

Returns

Type Description
ScheduleRun

ScheduleRun. The ScheduleRun is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

List schedules.

Returns schedules that match the supplied type and enabled filters.

list(*, type: str | ScheduleTaskType | None = None, enabled: bool | None = None, **kwargs: Any) -> ItemPaged[Schedule]

Keyword-Only Parameters

Name Description
type
str or ScheduleTaskType

Filter by the type of schedule. Known values are: "Evaluation" and "Insight". Default value is None.

Default value: None
enabled
bool

Filter by the enabled status. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[Schedule]

An iterator like instance of Schedule

Exceptions

Type Description
HttpResponseError

list_runs

List schedule runs.

Returns schedule runs that match the supplied filters.

list_runs(schedule_id: str, *, type: str | ScheduleTaskType | None = None, enabled: bool | None = None, **kwargs: Any) -> ItemPaged[ScheduleRun]

Parameters

Name Description
schedule_id
Required
str

Identifier of the schedule. Required.

Keyword-Only Parameters

Name Description
type
str or ScheduleTaskType

Filter by the type of schedule. Known values are: "Evaluation" and "Insight". Default value is None.

Default value: None
enabled
bool

Filter by the enabled status. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[ScheduleRun]

An iterator like instance of ScheduleRun

Exceptions

Type Description
HttpResponseError