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

Name	Description
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

Name	Description
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: ScheduleCreateOrUpdateParameters, **kwargs) -> Schedule | None

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
schedule_name Required	str The schedule name.
parameters Required	ScheduleCreateOrUpdateParameters The parameters supplied to the create or update schedule operation.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Schedule, None	Schedule, or the result of cls(response)

Exceptions

Type	Description
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

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
schedule_name Required	str The schedule name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Retrieve the schedule identified by schedule name.

async get(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs) -> Schedule

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
schedule_name Required	str The schedule name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Schedule	Schedule, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_automation_account

Retrieve a list of schedules.

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs) -> AsyncIterable[ScheduleListResult]

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ScheduleListResult]	An iterator like instance of either ScheduleListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update the schedule identified by schedule name.

async update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: ScheduleUpdateParameters, **kwargs) -> Schedule

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
schedule_name Required	str The schedule name.
parameters Required	ScheduleUpdateParameters The parameters supplied to the update schedule operation.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Schedule	Schedule, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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