Interface JobsClient


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

    • listDetectors

      com.azure.core.http.rest.PagedIterable<DiagnosticsInner> listDetectors(String resourceGroupName, String jobName)
      Get the list of diagnostics for a given Container App Job. Get the list of diagnostics for a Container App Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      the list of diagnostics for a Container App Job as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listDetectors

      com.azure.core.http.rest.PagedIterable<DiagnosticsInner> listDetectors(String resourceGroupName, String jobName, com.azure.core.util.Context context)
      Get the list of diagnostics for a given Container App Job. Get the list of diagnostics for a Container App Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Returns:
      the list of diagnostics for a Container App Job as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getDetectorWithResponse

      com.azure.core.http.rest.Response<DiagnosticsInner> getDetectorWithResponse(String resourceGroupName, String jobName, String detectorName, com.azure.core.util.Context context)
      Get the diagnostics data for a given Container App Job. Get the diagnostics data for a Container App Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      detectorName - Name of the Container App Job detector.
      context - The context to associate with this operation.
      Returns:
      the diagnostics data for a Container App Job along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getDetector

      DiagnosticsInner getDetector(String resourceGroupName, String jobName, String detectorName)
      Get the diagnostics data for a given Container App Job. Get the diagnostics data for a Container App Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      detectorName - Name of the Container App Job detector.
      Returns:
      the diagnostics data for a Container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • proxyGetWithResponse

      com.azure.core.http.rest.Response<JobInner> proxyGetWithResponse(String resourceGroupName, String jobName, String apiName, com.azure.core.util.Context context)
      Get the properties of a Container App Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      apiName - Proxy API Name for Container App Job.
      context - The context to associate with this operation.
      Returns:
      the properties of a Container App Job along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • proxyGet

      JobInner proxyGet(String resourceGroupName, String jobName, String apiName)
      Get the properties of a Container App Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      apiName - Proxy API Name for Container App Job.
      Returns:
      the properties of a Container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<JobInner> list()
      Get the Container Apps Jobs in a given subscription.
      Returns:
      the Container Apps Jobs in a given subscription as paginated response with PagedIterable.
      Throws:
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<JobInner> list(com.azure.core.util.Context context)
      Get the Container Apps Jobs in a given subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the Container Apps Jobs in a given subscription as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<JobInner> listByResourceGroup(String resourceGroupName)
      Get the Container Apps Jobs in a given resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the Container Apps Jobs in a given resource group as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<JobInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Get the Container Apps Jobs in a given resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      the Container Apps Jobs in a given resource group as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<JobInner> getByResourceGroupWithResponse(String resourceGroupName, String jobName, com.azure.core.util.Context context)
      Get the properties of a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Returns:
      the properties of a Container Apps Job along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getByResourceGroup

      JobInner getByResourceGroup(String resourceGroupName, String jobName)
      Get the properties of a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      the properties of a Container Apps Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobInner>,JobInner> beginCreateOrUpdate(String resourceGroupName, String jobName, JobInner jobEnvelope)
      Create or Update a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      Returns:
      the SyncPoller for polling of container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobInner>,JobInner> beginCreateOrUpdate(String resourceGroupName, String jobName, JobInner jobEnvelope, com.azure.core.util.Context context)
      Create or Update a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdate

      JobInner createOrUpdate(String resourceGroupName, String jobName, JobInner jobEnvelope)
      Create or Update a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      Returns:
      container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdate

      JobInner createOrUpdate(String resourceGroupName, String jobName, JobInner jobEnvelope, com.azure.core.util.Context context)
      Create or Update a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      context - The context to associate with this operation.
      Returns:
      container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String jobName)
      Delete a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String jobName, com.azure.core.util.Context context)
      Delete a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - 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 jobName)
      Delete a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - 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 jobName, com.azure.core.util.Context context)
      Delete a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobInner>,JobInner> beginUpdate(String resourceGroupName, String jobName, JobPatchProperties jobEnvelope)
      Update properties of a Container Apps Job Patches a Container Apps Job using JSON Merge Patch.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      Returns:
      the SyncPoller for polling of container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobInner>,JobInner> beginUpdate(String resourceGroupName, String jobName, JobPatchProperties jobEnvelope, com.azure.core.util.Context context)
      Update properties of a Container Apps Job Patches a Container Apps Job using JSON Merge Patch.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • update

      JobInner update(String resourceGroupName, String jobName, JobPatchProperties jobEnvelope)
      Update properties of a Container Apps Job Patches a Container Apps Job using JSON Merge Patch.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      Returns:
      container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • update

      JobInner update(String resourceGroupName, String jobName, JobPatchProperties jobEnvelope, com.azure.core.util.Context context)
      Update properties of a Container Apps Job Patches a Container Apps Job using JSON Merge Patch.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobEnvelope - Properties used to create a container apps job.
      context - The context to associate with this operation.
      Returns:
      container App Job.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobExecutionBaseInner>,JobExecutionBaseInner> beginStart(String resourceGroupName, String jobName)
      Start a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      the SyncPoller for polling of container App's Job execution name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobExecutionBaseInner>,JobExecutionBaseInner> beginStart(String resourceGroupName, String jobName, JobExecutionTemplate template, com.azure.core.util.Context context)
      Start a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      template - Properties used to start a job execution.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of container App's Job execution name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • start

      JobExecutionBaseInner start(String resourceGroupName, String jobName)
      Start a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      container App's Job execution name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • start

      JobExecutionBaseInner start(String resourceGroupName, String jobName, JobExecutionTemplate template, com.azure.core.util.Context context)
      Start a Container Apps Job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      template - Properties used to start a job execution.
      context - The context to associate with this operation.
      Returns:
      container App's Job execution name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStopExecution

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStopExecution(String resourceGroupName, String jobName, String jobExecutionName)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobExecutionName - Job execution name.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStopExecution

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStopExecution(String resourceGroupName, String jobName, String jobExecutionName, com.azure.core.util.Context context)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobExecutionName - Job execution name.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stopExecution

      void stopExecution(String resourceGroupName, String jobName, String jobExecutionName)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobExecutionName - Job execution name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stopExecution

      void stopExecution(String resourceGroupName, String jobName, String jobExecutionName, com.azure.core.util.Context context)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      jobExecutionName - Job execution name.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStopMultipleExecutions

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ContainerAppJobExecutionsInner>,ContainerAppJobExecutionsInner> beginStopMultipleExecutions(String resourceGroupName, String jobName)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      the SyncPoller for polling of container App executions collection ARM resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStopMultipleExecutions

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ContainerAppJobExecutionsInner>,ContainerAppJobExecutionsInner> beginStopMultipleExecutions(String resourceGroupName, String jobName, com.azure.core.util.Context context)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of container App executions collection ARM resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stopMultipleExecutions

      ContainerAppJobExecutionsInner stopMultipleExecutions(String resourceGroupName, String jobName)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      container App executions collection ARM resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stopMultipleExecutions

      ContainerAppJobExecutionsInner stopMultipleExecutions(String resourceGroupName, String jobName, com.azure.core.util.Context context)
      Terminates execution of a running container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Returns:
      container App executions collection ARM resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listSecretsWithResponse

      com.azure.core.http.rest.Response<JobSecretsCollectionInner> listSecretsWithResponse(String resourceGroupName, String jobName, com.azure.core.util.Context context)
      List secrets for a container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      context - The context to associate with this operation.
      Returns:
      container Apps Job Secrets Collection ARM resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listSecrets

      JobSecretsCollectionInner listSecrets(String resourceGroupName, String jobName)
      List secrets for a container apps job.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      jobName - Job Name.
      Returns:
      container Apps Job Secrets Collection ARM resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.