RunbookOperations Class

RunbookOperations 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

RunbookOperations

Constructor

RunbookOperations(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

begin_publish	Publish runbook draft.
create_or_update	Create the runbook identified by runbook name.
delete	Delete the runbook by name.
get	Retrieve the runbook identified by runbook name.
get_content	Retrieve the content of runbook identified by runbook name.
list_by_automation_account	Retrieve a list of runbooks.
update	Update the runbook identified by runbook name.

begin_publish

Publish runbook draft.

async begin_publish(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

runbook_name

str

Required

The parameters supplied to the publish runbook operation.

cls

callable

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

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

create_or_update

Create the runbook identified by runbook name.

async create_or_update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: azure.mgmt.automation.models._models_py3.RunbookCreateOrUpdateParameters, **kwargs) -> azure.mgmt.automation.models._models_py3.Runbook

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

runbook_name

str

Required

The runbook name.

parameters

RunbookCreateOrUpdateParameters

Required

The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.

cls

callable

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

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Exceptions

HttpResponseError

delete

Delete the runbook by name.

async delete(resource_group_name: str, automation_account_name: str, runbook_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.

runbook_name

str

Required

The runbook 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 runbook identified by runbook name.

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

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

runbook_name

str

Required

The runbook name.

cls

callable

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

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Exceptions

HttpResponseError

get_content

Retrieve the content of runbook identified by runbook name.

async get_content(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs) -> IO

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

runbook_name

str

Required

The runbook name.

cls

callable

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

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

list_by_automation_account

Retrieve a list of runbooks.

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

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 RunbookListResult or the result of cls(response)

Return type

AsyncItemPaged[RunbookListResult]

Exceptions

HttpResponseError

update

Update the runbook identified by runbook name.

async update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: azure.mgmt.automation.models._models_py3.RunbookUpdateParameters, **kwargs) -> azure.mgmt.automation.models._models_py3.Runbook

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

runbook_name

str

Required

The runbook name.

parameters

RunbookUpdateParameters

Required

The update parameters for runbook.

cls

callable

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

Returns

Runbook, or the result of cls(response)

Return type

Runbook

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'>