Package com.azure.resourcemanager.appcontainers.models

Interface Jobs

public interface Jobs
Resource collection API of Jobs.

  • Method Details

    • listDetectors

      com.azure.core.http.rest.PagedIterable<Diagnostics> 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<Diagnostics> 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<Diagnostics> 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

      Diagnostics 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<Job> 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

      Job 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<Job> 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<Job> 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<Job> 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<Job> 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<Job> 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

      Job 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.

    • deleteByResourceGroup

      void deleteByResourceGroup(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.

    • start

      JobExecutionBase 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

      JobExecutionBase 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.

    • 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.

    • stopMultipleExecutions

      ContainerAppJobExecutions 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

      ContainerAppJobExecutions 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<JobSecretsCollection> 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

      JobSecretsCollection 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.

    • getById

      Job getById(String id)
      Get the properties of a Container Apps Job.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Job> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get the properties of a Container Apps Job.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Delete a Container Apps Job.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete a Container Apps Job.
      Parameters:
      id - the resource ID.
      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.

    • 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.