Share via

ScheduleOperations Class

  • Reference

You should not instantiate this class directly. Instead, you should create an MLClient instance that instantiates it for you and attaches it as an attribute.

Inheritance
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
ScheduleOperations

Constructor

ScheduleOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_06_2023_preview: AzureMachineLearningWorkspaces, service_client_01_2024_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, credential: TokenCredential, **kwargs: Any)

Parameters

Name Description
operation_scope
Required
operation_config
Required
service_client_06_2023_preview
Required
service_client_01_2024_preview
Required
all_operations
Required
credential
Required

Methods

begin_create_or_update

Create or update schedule.
begin_delete

Delete schedule.
begin_disable

Disable a schedule.
begin_enable

Enable a schedule.
get

Get a schedule.
list

List schedules in specified workspace.
trigger

Trigger a schedule once.

begin_create_or_update

Create or update schedule.

begin_create_or_update(schedule: Schedule, **kwargs: Any) -> LROPoller[Schedule]

Parameters

Name Description
schedule
Required
Schedule

Schedule definition.

Returns

Type Description
Union[<xref:LROPoller>, Schedule],
Union[<xref:LROPoller>, Schedule]

An instance of LROPoller that returns Schedule if no_wait=True, or Schedule if no_wait=False

begin_delete

Delete schedule.

begin_delete(name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
name
Required
str

Schedule name.

Returns

Type Description
<xref:LROPoller>[None]

A poller for deletion status

begin_disable

Disable a schedule.

begin_disable(name: str, **kwargs: Any) -> LROPoller[Schedule]

Parameters

Name Description
name
Required
str

Schedule name.

Returns

Type Description
<xref:LROPoller>

An instance of LROPoller that returns Schedule if no_wait=True, or Schedule if no_wait=False

begin_enable

Enable a schedule.

begin_enable(name: str, **kwargs: Any) -> LROPoller[Schedule]

Parameters

Name Description
name
Required
str

Schedule name.

Returns

Type Description
<xref:LROPoller>

An instance of LROPoller that returns Schedule

get

Get a schedule.

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

Parameters

Name Description
name
Required
str

Schedule name.

Returns

Type Description
Schedule

The schedule object.

list

List schedules in specified workspace.

list(*, list_view_type: ScheduleListViewType = ScheduleListViewType.ENABLED_ONLY, **kwargs: Any) -> Iterable[Schedule]

Keyword-Only Parameters

Name Description
list_view_type

View type for including/excluding (for example) archived schedules. Default: ENABLED_ONLY.

Returns

Type Description
Iterable[Schedule]

An iterator to list Schedule.

trigger

Trigger a schedule once.

trigger(name: str, **kwargs: Any) -> ScheduleTriggerResult

Parameters

Name Description
name
Required
str

Schedule name.

Returns

Type Description
ScheduleTriggerResult

TriggerRunSubmissionDto, or the result of cls(response)