ScheduleOperations Class

ScheduleOperations async operations.

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

Inheritance

builtins.object

ScheduleOperations

Constructor

ScheduleOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Create a schedule.
delete	Delete the schedule identified by schedule name.
get	Retrieve the schedule identified by schedule name.
list_by_automation_account	Retrieve a list of schedules.
update	Update the schedule identified by schedule name.

create_or_update

Create a schedule.

async create_or_update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: azure.mgmt.automation.models._models_py3.ScheduleCreateOrUpdateParameters, **kwargs) -> Optional[azure.mgmt.automation.models._models_py3.Schedule]

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

schedule_name

str

Required

The schedule name.

parameters

ScheduleCreateOrUpdateParameters

Required

The parameters supplied to the create or update schedule operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

Schedule, or the result of cls(response)

Return type

Schedule,

None

Exceptions

HttpResponseError

delete

Delete the schedule identified by schedule name.

async delete(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

schedule_name

str

Required

The schedule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Retrieve the schedule identified by schedule name.

async get(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs) -> azure.mgmt.automation.models._models_py3.Schedule

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

schedule_name

str

Required

The schedule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Exceptions

HttpResponseError

list_by_automation_account

Retrieve a list of schedules.

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs) -> AsyncIterable[azure.mgmt.automation.models._models_py3.ScheduleListResult]

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ScheduleListResult or the result of cls(response)

Return type

AsyncItemPaged[ScheduleListResult]

Exceptions

HttpResponseError

update

Update the schedule identified by schedule name.

async update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: azure.mgmt.automation.models._models_py3.ScheduleUpdateParameters, **kwargs) -> azure.mgmt.automation.models._models_py3.Schedule

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

schedule_name

str

Required

The schedule name.

parameters

ScheduleUpdateParameters

Required

The parameters supplied to the update schedule operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.automation.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\automation\\models\\__init__.py'>