Interface JobStepsClient


public interface JobStepsClient
An instance of this class provides access to all the operations defined in JobStepsClient.
  • Method Details

    • listByJobAsync

      com.azure.core.http.rest.PagedFlux<JobStepInner> listByJobAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)
      Gets all job steps for a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job to get.
      Returns:
      all job steps for a job's current version as paginated response with PagedFlux.
      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.
    • listByJob

      com.azure.core.http.rest.PagedIterable<JobStepInner> listByJob(String resourceGroupName, String serverName, String jobAgentName, String jobName)
      Gets all job steps for a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job to get.
      Returns:
      all job steps for a job's current version 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.
    • listByJob

      com.azure.core.http.rest.PagedIterable<JobStepInner> listByJob(String resourceGroupName, String serverName, String jobAgentName, String jobName, com.azure.core.util.Context context)
      Gets all job steps for a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job to get.
      context - The context to associate with this operation.
      Returns:
      all job steps for a job's current version 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.
    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<JobStepInner>> getWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName)
      Gets a job step in a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      Returns:
      a job step in a job's current version along with Response on successful completion of Mono.
      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.
    • getAsync

      Mono<JobStepInner> getAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName)
      Gets a job step in a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      Returns:
      a job step in a job's current version on successful completion of Mono.
      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<JobStepInner> getWithResponse(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName, com.azure.core.util.Context context)
      Gets a job step in a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      context - The context to associate with this operation.
      Returns:
      a job step in a job's current version 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

      JobStepInner get(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName)
      Gets a job step in a job's current version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      Returns:
      a job step in a job's current version.
      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.
    • createOrUpdateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<JobStepInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName, JobStepInner parameters)
      Creates or updates a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      parameters - The requested state of the job step.
      Returns:
      a job step along with Response on successful completion of Mono.
      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.
    • createOrUpdateAsync

      Mono<JobStepInner> createOrUpdateAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName, JobStepInner parameters)
      Creates or updates a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      parameters - The requested state of the job step.
      Returns:
      a job step on successful completion of Mono.
      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.
    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<JobStepInner> createOrUpdateWithResponse(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName, JobStepInner parameters, com.azure.core.util.Context context)
      Creates or updates a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      parameters - The requested state of the job step.
      context - The context to associate with this operation.
      Returns:
      a job step 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.
    • createOrUpdate

      JobStepInner createOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName, JobStepInner parameters)
      Creates or updates a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step.
      parameters - The requested state of the job step.
      Returns:
      a job step.
      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.
    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName)
      Deletes a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step to delete.
      Returns:
      the Response on successful completion of Mono.
      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.
    • deleteAsync

      Mono<Void> deleteAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName)
      Deletes a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step to delete.
      Returns:
      A Mono that completes when a successful response is received.
      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 serverName, String jobAgentName, String jobName, String stepName, com.azure.core.util.Context context)
      Deletes a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step to delete.
      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.
    • delete

      void delete(String resourceGroupName, String serverName, String jobAgentName, String jobName, String stepName)
      Deletes a job step. This will implicitly create a new job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      stepName - The name of the job step to delete.
      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.
    • listByVersionAsync

      com.azure.core.http.rest.PagedFlux<JobStepInner> listByVersionAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion)
      Gets all job steps in the specified job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job to get.
      jobVersion - The version of the job to get.
      Returns:
      all job steps in the specified job version as paginated response with PagedFlux.
      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.
    • listByVersion

      com.azure.core.http.rest.PagedIterable<JobStepInner> listByVersion(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion)
      Gets all job steps in the specified job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job to get.
      jobVersion - The version of the job to get.
      Returns:
      all job steps in the specified job version 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.
    • listByVersion

      com.azure.core.http.rest.PagedIterable<JobStepInner> listByVersion(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion, com.azure.core.util.Context context)
      Gets all job steps in the specified job version.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job to get.
      jobVersion - The version of the job to get.
      context - The context to associate with this operation.
      Returns:
      all job steps in the specified job version 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.
    • getByVersionWithResponseAsync

      Mono<com.azure.core.http.rest.Response<JobStepInner>> getByVersionWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion, String stepName)
      Gets the specified version of a job step.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      jobVersion - The version of the job to get.
      stepName - The name of the job step.
      Returns:
      the specified version of a job step along with Response on successful completion of Mono.
      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.
    • getByVersionAsync

      Mono<JobStepInner> getByVersionAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion, String stepName)
      Gets the specified version of a job step.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      jobVersion - The version of the job to get.
      stepName - The name of the job step.
      Returns:
      the specified version of a job step on successful completion of Mono.
      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.
    • getByVersionWithResponse

      com.azure.core.http.rest.Response<JobStepInner> getByVersionWithResponse(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion, String stepName, com.azure.core.util.Context context)
      Gets the specified version of a job step.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      jobVersion - The version of the job to get.
      stepName - The name of the job step.
      context - The context to associate with this operation.
      Returns:
      the specified version of a job step 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.
    • getByVersion

      JobStepInner getByVersion(String resourceGroupName, String serverName, String jobAgentName, String jobName, int jobVersion, String stepName)
      Gets the specified version of a job step.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serverName - The name of the server.
      jobAgentName - The name of the job agent.
      jobName - The name of the job.
      jobVersion - The version of the job to get.
      stepName - The name of the job step.
      Returns:
      the specified version of a job step.
      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.