RunbookOperations.yml

### YamlMime:TSType
name: RunbookOperations
uid: '@azure/arm-automation.RunbookOperations'
package: '@azure/arm-automation'
summary: Class representing a RunbookOperations.
fullName: RunbookOperations
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: RunbookOperations(AutomationClientContext)
    uid: '@azure/arm-automation.RunbookOperations.constructor'
    package: '@azure/arm-automation'
    summary: Create a RunbookOperations.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'new RunbookOperations(client: AutomationClientContext)'
      parameters:
        - id: client
          type: <xref uid="@azure/arm-automation.AutomationClientContext" />
          description: Reference to the service client.
methods:
  - name: beginPublish(string, string, string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.beginPublish'
    package: '@azure/arm-automation'
    summary: Publish runbook draft.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginPublish(resourceGroupName: string, automationAccountName:
        string, runbookName: string, options?: RequestOptionsBase):
        Promise<LROPoller>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The parameters supplied to the publish runbook operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<msRestAzure.LROPoller>
        type: Promise&lt;<xref uid="@azure/ms-rest-azure-js.LROPoller" />&gt;
  - name: >-
      createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters,
      RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.createOrUpdate'
    package: '@azure/arm-automation'
    summary: Create the runbook identified by runbook name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdate(resourceGroupName: string,
        automationAccountName: string, runbookName: string, parameters:
        RunbookCreateOrUpdateParameters, options?: RequestOptionsBase):
        Promise<RunbookCreateOrUpdateResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-automation.AutomationModels.RunbookCreateOrUpdateParameters"
            />
          description: >-
            The create or update parameters for runbook. Provide either content
            link for a

            published runbook or draft, not both.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookCreateOrUpdateResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookCreateOrUpdateResponse"
          />&gt;
  - name: >-
      createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters,
      RequestOptionsBase, ServiceCallback<Runbook>)
    uid: '@azure/arm-automation.RunbookOperations.createOrUpdate_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdate(resourceGroupName: string,
        automationAccountName: string, runbookName: string, parameters:
        RunbookCreateOrUpdateParameters, options: RequestOptionsBase, callback:
        ServiceCallback<Runbook>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-automation.AutomationModels.RunbookCreateOrUpdateParameters"
            />
          description: >-
            The create or update parameters for runbook. Provide either content
            link for a

            published runbook or draft, not both.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.Runbook" />&gt;
          description: The callback
  - name: >-
      createOrUpdate(string, string, string, RunbookCreateOrUpdateParameters,
      ServiceCallback<Runbook>)
    uid: '@azure/arm-automation.RunbookOperations.createOrUpdate_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdate(resourceGroupName: string,
        automationAccountName: string, runbookName: string, parameters:
        RunbookCreateOrUpdateParameters, callback: ServiceCallback<Runbook>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-automation.AutomationModels.RunbookCreateOrUpdateParameters"
            />
          description: >-
            The create or update parameters for runbook. Provide either content
            link for a

            published runbook or draft, not both.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.Runbook" />&gt;
          description: The callback
  - name: deleteMethod(string, string, string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.deleteMethod'
    package: '@azure/arm-automation'
    summary: Delete the runbook by name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteMethod(resourceGroupName: string, automationAccountName:
        string, runbookName: string, options?: RequestOptionsBase):
        Promise<RestResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<msRest.RestResponse>
        type: Promise&lt;<xref uid="@azure/ms-rest-js.RestResponse" />&gt;
  - name: >-
      deleteMethod(string, string, string, RequestOptionsBase,
      ServiceCallback<void>)
    uid: '@azure/arm-automation.RunbookOperations.deleteMethod_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteMethod(resourceGroupName: string, automationAccountName:
        string, runbookName: string, options: RequestOptionsBase, callback:
        ServiceCallback<void>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: deleteMethod(string, string, string, ServiceCallback<void>)
    uid: '@azure/arm-automation.RunbookOperations.deleteMethod_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteMethod(resourceGroupName: string, automationAccountName:
        string, runbookName: string, callback: ServiceCallback<void>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: get(string, string, string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.get'
    package: '@azure/arm-automation'
    summary: Retrieve the runbook identified by runbook name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, automationAccountName: string,
        runbookName: string, options?: RequestOptionsBase):
        Promise<RunbookGetResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookGetResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookGetResponse" />&gt;
  - name: get(string, string, string, RequestOptionsBase, ServiceCallback<Runbook>)
    uid: '@azure/arm-automation.RunbookOperations.get_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, automationAccountName: string,
        runbookName: string, options: RequestOptionsBase, callback:
        ServiceCallback<Runbook>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.Runbook" />&gt;
          description: The callback
  - name: get(string, string, string, ServiceCallback<Runbook>)
    uid: '@azure/arm-automation.RunbookOperations.get_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, automationAccountName: string,
        runbookName: string, callback: ServiceCallback<Runbook>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.Runbook" />&gt;
          description: The callback
  - name: getContent(string, string, string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.getContent'
    package: '@azure/arm-automation'
    summary: Retrieve the content of runbook identified by runbook name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getContent(resourceGroupName: string, automationAccountName:
        string, runbookName: string, options?: RequestOptionsBase):
        Promise<RunbookGetContentResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookGetContentResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookGetContentResponse"
          />&gt;
  - name: >-
      getContent(string, string, string, RequestOptionsBase,
      ServiceCallback<void>)
    uid: '@azure/arm-automation.RunbookOperations.getContent_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getContent(resourceGroupName: string, automationAccountName:
        string, runbookName: string, options: RequestOptionsBase, callback:
        ServiceCallback<void>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: getContent(string, string, string, ServiceCallback<void>)
    uid: '@azure/arm-automation.RunbookOperations.getContent_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getContent(resourceGroupName: string, automationAccountName:
        string, runbookName: string, callback: ServiceCallback<void>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: listByAutomationAccount(string, string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccount'
    package: '@azure/arm-automation'
    summary: Retrieve a list of runbooks.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByAutomationAccount(resourceGroupName: string,
        automationAccountName: string, options?: RequestOptionsBase):
        Promise<RunbookListByAutomationAccountResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookListByAutomationAccountResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookListByAutomationAccountResponse"
          />&gt;
  - name: >-
      listByAutomationAccount(string, string, RequestOptionsBase,
      ServiceCallback<RunbookListResult>)
    uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccount_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByAutomationAccount(resourceGroupName: string,
        automationAccountName: string, options: RequestOptionsBase, callback:
        ServiceCallback<RunbookListResult>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.RunbookListResult"
            />&gt;
          description: The callback
  - name: >-
      listByAutomationAccount(string, string,
      ServiceCallback<RunbookListResult>)
    uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccount_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByAutomationAccount(resourceGroupName: string,
        automationAccountName: string, callback:
        ServiceCallback<RunbookListResult>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.RunbookListResult"
            />&gt;
          description: The callback
  - name: listByAutomationAccountNext(string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccountNext'
    package: '@azure/arm-automation'
    summary: Retrieve a list of runbooks.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByAutomationAccountNext(nextPageLink: string, options?:
        RequestOptionsBase): Promise<RunbookListByAutomationAccountNextResponse>
      parameters:
        - id: nextPageLink
          type: string
          description: The NextLink from the previous successful call to List operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookListByAutomationAccountNextResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookListByAutomationAccountNextResponse"
          />&gt;
  - name: >-
      listByAutomationAccountNext(string, RequestOptionsBase,
      ServiceCallback<RunbookListResult>)
    uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccountNext_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByAutomationAccountNext(nextPageLink: string, options:
        RequestOptionsBase, callback: ServiceCallback<RunbookListResult>)
      parameters:
        - id: nextPageLink
          type: string
          description: The NextLink from the previous successful call to List operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.RunbookListResult"
            />&gt;
          description: The callback
  - name: listByAutomationAccountNext(string, ServiceCallback<RunbookListResult>)
    uid: '@azure/arm-automation.RunbookOperations.listByAutomationAccountNext_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByAutomationAccountNext(nextPageLink: string, callback:
        ServiceCallback<RunbookListResult>)
      parameters:
        - id: nextPageLink
          type: string
          description: The NextLink from the previous successful call to List operation.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.RunbookListResult"
            />&gt;
          description: The callback
  - name: publish(string, string, string, RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.publish'
    package: '@azure/arm-automation'
    summary: Publish runbook draft.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function publish(resourceGroupName: string, automationAccountName:
        string, runbookName: string, options?: RequestOptionsBase):
        Promise<RunbookPublishResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The parameters supplied to the publish runbook operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookPublishResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookPublishResponse"
          />&gt;
  - name: >-
      update(string, string, string, RunbookUpdateParameters,
      RequestOptionsBase)
    uid: '@azure/arm-automation.RunbookOperations.update'
    package: '@azure/arm-automation'
    summary: Update the runbook identified by runbook name.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function update(resourceGroupName: string, automationAccountName:
        string, runbookName: string, parameters: RunbookUpdateParameters,
        options?: RequestOptionsBase): Promise<RunbookUpdateResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-automation.AutomationModels.RunbookUpdateParameters"
            />
          description: The update parameters for runbook.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.RunbookUpdateResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-automation.AutomationModels.RunbookUpdateResponse"
          />&gt;
  - name: >-
      update(string, string, string, RunbookUpdateParameters,
      RequestOptionsBase, ServiceCallback<Runbook>)
    uid: '@azure/arm-automation.RunbookOperations.update_2'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function update(resourceGroupName: string, automationAccountName:
        string, runbookName: string, parameters: RunbookUpdateParameters,
        options: RequestOptionsBase, callback: ServiceCallback<Runbook>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-automation.AutomationModels.RunbookUpdateParameters"
            />
          description: The update parameters for runbook.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.Runbook" />&gt;
          description: The callback
  - name: >-
      update(string, string, string, RunbookUpdateParameters,
      ServiceCallback<Runbook>)
    uid: '@azure/arm-automation.RunbookOperations.update_1'
    package: '@azure/arm-automation'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function update(resourceGroupName: string, automationAccountName:
        string, runbookName: string, parameters: RunbookUpdateParameters,
        callback: ServiceCallback<Runbook>)
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of an Azure Resource group.
        - id: automationAccountName
          type: string
          description: The name of the automation account.
        - id: runbookName
          type: string
          description: The runbook name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-automation.AutomationModels.RunbookUpdateParameters"
            />
          description: The update parameters for runbook.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/arm-automation.AutomationModels.Runbook" />&gt;
          description: The callback