RunbookOperations Class
RunbookOperations 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.objectRunbookOperations
Constructor
RunbookOperations(client, config, serializer, deserializer)
Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
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.
begin_publish(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Keyword-Only Parameters
- 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 PollingMethod
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 LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
create_or_update
Create the runbook identified by runbook name.
create_or_update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: '_models.RunbookCreateOrUpdateParameters', **kwargs: Any) -> _models.Runbook
Parameters
- parameters
- RunbookCreateOrUpdateParameters
The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.
Keyword-Only Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Runbook, or the result of cls(response)
Return type
Exceptions
delete
Delete the runbook by name.
delete(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) -> None
Parameters
Keyword-Only Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
Retrieve the runbook identified by runbook name.
get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) -> _models.Runbook
Parameters
Keyword-Only Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Runbook, or the result of cls(response)
Return type
Exceptions
get_content
Retrieve the content of runbook identified by runbook name.
get_content(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) -> IO
Parameters
Keyword-Only Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IO, or the result of cls(response)
Return type
Exceptions
list_by_automation_account
Retrieve a list of runbooks.
list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) -> Iterable['_models.RunbookListResult']
Parameters
Keyword-Only Parameters
- 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
Exceptions
update
Update the runbook identified by runbook name.
update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: '_models.RunbookUpdateParameters', **kwargs: Any) -> _models.Runbook
Parameters
Keyword-Only Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Runbook, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.automation.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\automation\\models\\__init__.py'>
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for