azure.mgmt.automation.aio.operations.RunbookOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.automation.aio.operations.RunbookOperations
name: RunbookOperations
fullName: azure.mgmt.automation.aio.operations.RunbookOperations
module: azure.mgmt.automation.aio.operations
inheritances:
- builtins.object
summary: '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.'
constructor:
  syntax: RunbookOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.begin_publish
  name: begin_publish
  summary: Publish runbook draft.
  signature: 'async begin_publish(resource_group_name: str, automation_account_name:
    str, runbook_name: str, **kwargs) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  - name: runbook_name
    description: The parameters supplied to the publish runbook operation.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'True for ARMPolling, False for no polling, or a

      polling object for personal polling strategy'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.create_or_update
  name: create_or_update
  summary: Create the runbook identified by runbook name.
  signature: 'async create_or_update(resource_group_name: str, automation_account_name:
    str, runbook_name: str, parameters: RunbookCreateOrUpdateParameters, **kwargs)
    -> Runbook'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  - name: runbook_name
    description: The runbook name.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The create or update parameters for runbook. Provide either content
      link for

      a published runbook or draft, not both.'
    isRequired: true
    types:
    - <xref:azure.mgmt.automation.models.RunbookCreateOrUpdateParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Runbook, or the result of cls(response)
    types:
    - <xref:azure.mgmt.automation.models.Runbook>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.delete
  name: delete
  summary: Delete the runbook by name.
  signature: 'async delete(resource_group_name: str, automation_account_name: str,
    runbook_name: str, **kwargs) -> None'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  - name: runbook_name
    description: The runbook name.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.get
  name: get
  summary: Retrieve the runbook identified by runbook name.
  signature: 'async get(resource_group_name: str, automation_account_name: str, runbook_name:
    str, **kwargs) -> Runbook'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  - name: runbook_name
    description: The runbook name.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Runbook, or the result of cls(response)
    types:
    - <xref:azure.mgmt.automation.models.Runbook>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.get_content
  name: get_content
  summary: Retrieve the content of runbook identified by runbook name.
  signature: 'async get_content(resource_group_name: str, automation_account_name:
    str, runbook_name: str, **kwargs) -> IO'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  - name: runbook_name
    description: The runbook name.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: IO, or the result of cls(response)
    types:
    - <xref:typing.IO>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.list_by_automation_account
  name: list_by_automation_account
  summary: Retrieve a list of runbooks.
  signature: 'list_by_automation_account(resource_group_name: str, automation_account_name:
    str, **kwargs) -> AsyncIterable[RunbookListResult]'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either RunbookListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.automation.models.RunbookListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.update
  name: update
  summary: Update the runbook identified by runbook name.
  signature: 'async update(resource_group_name: str, automation_account_name: str,
    runbook_name: str, parameters: RunbookUpdateParameters, **kwargs) -> Runbook'
  parameters:
  - name: resource_group_name
    description: Name of an Azure Resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: automation_account_name
    description: The name of the automation account.
    isRequired: true
    types:
    - <xref:str>
  - name: runbook_name
    description: The runbook name.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The update parameters for runbook.
    isRequired: true
    types:
    - <xref:azure.mgmt.automation.models.RunbookUpdateParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Runbook, or the result of cls(response)
    types:
    - <xref:azure.mgmt.automation.models.Runbook>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.automation.aio.operations.RunbookOperations.models
  name: models
  signature: models = <module 'azure.mgmt.automation.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\automation\\models\\__init__.py'>