Package com.azure.resourcemanager.automation.models

Interface Jobs

public interface Jobs
Resource collection API of Jobs.

  • Method Details

    • getOutput

      String getOutput(String resourceGroupName, String automationAccountName, String jobName)
      Retrieve the job output identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The name of the job to be created.
      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.

    • getOutputWithResponse

      com.azure.core.http.rest.Response<String> getOutputWithResponse(String resourceGroupName, String automationAccountName, String jobName, String clientRequestId, com.azure.core.util.Context context)
      Retrieve the job output identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The name of the job to be created.
      clientRequestId - Identifies this specific client request.
      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.

    • getRunbookContent

      String getRunbookContent(String resourceGroupName, String automationAccountName, String jobName)
      Retrieve the runbook content of the job identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job 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.

    • getRunbookContentWithResponse

      com.azure.core.http.rest.Response<String> getRunbookContentWithResponse(String resourceGroupName, String automationAccountName, String jobName, String clientRequestId, com.azure.core.util.Context context)
      Retrieve the runbook content of the job identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job name.
      clientRequestId - Identifies this specific client request.
      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.

    • suspend

      void suspend(String resourceGroupName, String automationAccountName, String jobName)
      Suspend the job identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job 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.

    • suspendWithResponse

      com.azure.core.http.rest.Response<Void> suspendWithResponse(String resourceGroupName, String automationAccountName, String jobName, String clientRequestId, com.azure.core.util.Context context)
      Suspend the job identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job name.
      clientRequestId - Identifies this specific client request.
      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.

    • stop

      void stop(String resourceGroupName, String automationAccountName, String jobName)
      Stop the job identified by jobName.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job 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.

    • stopWithResponse

      com.azure.core.http.rest.Response<Void> stopWithResponse(String resourceGroupName, String automationAccountName, String jobName, String clientRequestId, com.azure.core.util.Context context)
      Stop the job identified by jobName.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job name.
      clientRequestId - Identifies this specific client request.
      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.

    • get

      Job get(String resourceGroupName, String automationAccountName, String jobName)
      Retrieve the job identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job name.
      Returns:
      definition of the job.
      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<Job> getWithResponse(String resourceGroupName, String automationAccountName, String jobName, String clientRequestId, com.azure.core.util.Context context)
      Retrieve the job identified by job name.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job name.
      clientRequestId - Identifies this specific client request.
      context - The context to associate with this operation.
      Returns:
      definition of the job 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.

    • listByAutomationAccount

      com.azure.core.http.rest.PagedIterable<JobCollectionItem> listByAutomationAccount(String resourceGroupName, String automationAccountName)
      Retrieve a list of jobs.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      Returns:
      the response model for the list job 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<JobCollectionItem> listByAutomationAccount(String resourceGroupName, String automationAccountName, String filter, String clientRequestId, com.azure.core.util.Context context)
      Retrieve a list of jobs.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      filter - The filter to apply on the operation.
      clientRequestId - Identifies this specific client request.
      context - The context to associate with this operation.
      Returns:
      the response model for the list job 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.

    • resume

      void resume(String resourceGroupName, String automationAccountName, String jobName)
      Resume the job identified by jobName.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job 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.

    • resumeWithResponse

      com.azure.core.http.rest.Response<Void> resumeWithResponse(String resourceGroupName, String automationAccountName, String jobName, String clientRequestId, com.azure.core.util.Context context)
      Resume the job identified by jobName.
      Parameters:
      resourceGroupName - Name of an Azure Resource group.
      automationAccountName - The name of the automation account.
      jobName - The job name.
      clientRequestId - Identifies this specific client request.
      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.

    • getById

      Job getById(String id)
      Retrieve the job identified by job name.
      Parameters:
      id - the resource ID.
      Returns:
      definition of the job 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<Job> getByIdWithResponse(String id, String clientRequestId, com.azure.core.util.Context context)
      Retrieve the job identified by job name.
      Parameters:
      id - the resource ID.
      clientRequestId - Identifies this specific client request.
      context - The context to associate with this operation.
      Returns:
      definition of the job 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.

    • define

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