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

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

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) -> AsyncLROPoller[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.
runbook_name Required	str The parameters supplied to the publish runbook operation.

Keyword-Only Parameters

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

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
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: RunbookCreateOrUpdateParameters, **kwargs) -> Runbook

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.
runbook_name Required	str The runbook name.
parameters Required	RunbookCreateOrUpdateParameters The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

delete

Delete the runbook by name.

async delete(resource_group_name: str, automation_account_name: str, runbook_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.
runbook_name Required	str The runbook 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 runbook identified by runbook name.

async get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs) -> Runbook

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.
runbook_name Required	str The runbook name.

Keyword-Only Parameters

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

Returns

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

Exceptions

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

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_automation_account

Retrieve a list of runbooks.

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

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[RunbookListResult]	An iterator like instance of either RunbookListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update the runbook identified by runbook name.

async update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: RunbookUpdateParameters, **kwargs) -> Runbook

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.
runbook_name Required	str The runbook name.
parameters Required	RunbookUpdateParameters The update parameters for runbook.

Keyword-Only Parameters

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

Returns

Type	Description
Runbook	Runbook, 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'>