Package com.azure.resourcemanager.automation.models

Interface Runbooks

public interface Runbooks
Resource collection API of Runbooks.

  • Method Details

    • publish

      void publish(String resourceGroupName, String automationAccountName, String runbookName)
      Publish runbook draft.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The parameters supplied to the publish runbook operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • publish

      void publish(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context)
      Publish runbook draft.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The parameters supplied to the publish runbook operation.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getContent

      Flux<ByteBuffer> getContent(String resourceGroupName, String automationAccountName, String runbookName)
      Retrieve the content of runbook identified by runbook name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The runbook name.
      Returns:
      the response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getContentWithResponse

      com.azure.core.http.rest.Response<Flux<ByteBuffer>> getContentWithResponse(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context)
      Retrieve the content of runbook identified by runbook name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The runbook name.
      context - The context to associate with this operation.
      Returns:
      the response body along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      Runbook get(String resourceGroupName, String automationAccountName, String runbookName)
      Retrieve the runbook identified by runbook name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The runbook name.
      Returns:
      definition of the runbook type.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<Runbook> getWithResponse(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context)
      Retrieve the runbook identified by runbook name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The runbook name.
      context - The context to associate with this operation.
      Returns:
      definition of the runbook type along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String automationAccountName, String runbookName)
      Delete the runbook by name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The runbook name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context)
      Delete the runbook by name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      runbookName - The runbook name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByAutomationAccount

      com.azure.core.http.rest.PagedIterable<Runbook> listByAutomationAccount(String resourceGroupName, String automationAccountName)
      Retrieve a list of runbooks.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      Returns:
      the response model for the list runbook operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByAutomationAccount

      com.azure.core.http.rest.PagedIterable<Runbook> listByAutomationAccount(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context)
      Retrieve a list of runbooks.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      context - The context to associate with this operation.
      Returns:
      the response model for the list runbook operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      Runbook getById(String id)
      Retrieve the runbook identified by runbook name.
      Parameters:
      id - the resource ID.
      Returns:
      definition of the runbook type along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Runbook> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Retrieve the runbook identified by runbook name.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      definition of the runbook type along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Delete the runbook by name.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete the runbook by name.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      Runbook.DefinitionStages.Blank define(String name)
      Begins definition for a new Runbook resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Runbook definition.