Package version:

Interface Jobs

Interface representing a Jobs.

interface Jobs {
    beginCreateOrUpdate(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Job>, Job>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams): Promise<Job>;
    beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>;
    beginResume(resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams): Promise<SimplePollerLike<OperationState<Job>, Job>>;
    beginResumeAndWait(resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams): Promise<Job>;
    beginStart(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams): Promise<SimplePollerLike<OperationState<JobExecutionBase>, JobExecutionBase>>;
    beginStartAndWait(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams): Promise<JobExecutionBase>;
    beginStopExecution(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStopExecutionAndWait(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams): Promise<void>;
    beginStopMultipleExecutions(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams): Promise<SimplePollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>>;
    beginStopMultipleExecutionsAndWait(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams): Promise<ContainerAppJobExecutions>;
    beginSuspend(resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams): Promise<SimplePollerLike<OperationState<Job>, Job>>;
    beginSuspendAndWait(resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams): Promise<Job>;
    beginUpdate(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Job>, Job>>;
    beginUpdateAndWait(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams): Promise<Job>;
    get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<Job>;
    getDetector(resourceGroupName: string, jobName: string, detectorName: string, options?: JobsGetDetectorOptionalParams): Promise<Diagnostics>;
    listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Job>;
    listBySubscription(options?: JobsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Job>;
    listDetectors(resourceGroupName: string, jobName: string, options?: JobsListDetectorsOptionalParams): PagedAsyncIterableIterator<Diagnostics>;
    listSecrets(resourceGroupName: string, jobName: string, options?: JobsListSecretsOptionalParams): Promise<JobSecretsCollection>;
    proxyGet(resourceGroupName: string, jobName: string, apiName: string, options?: JobsProxyGetOptionalParams): Promise<Job>;
}

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginResume beginResumeAndWait beginStart beginStartAndWait beginStopExecution beginStopExecutionAndWait beginStopMultipleExecutions beginStopMultipleExecutionsAndWait beginSuspend beginSuspendAndWait beginUpdate beginUpdateAndWait get getDetector listByResourceGroup listBySubscription listDetectors listSecrets proxyGet

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName, jobName, jobEnvelope, options?): Promise<SimplePollerLike<OperationState<Job>, Job>>

  • Create or Update a Container Apps Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • jobEnvelope: Job

      Properties used to create a container apps job

    • Optionaloptions: JobsCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Job>, Job>>

beginCreateOrUpdateAndWait

  • beginCreateOrUpdateAndWait(resourceGroupName, jobName, jobEnvelope, options?): Promise<Job>

  • Create or Update a Container Apps Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • jobEnvelope: Job

      Properties used to create a container apps job

    • Optionaloptions: JobsCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<Job>

beginDelete

  • beginDelete(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Delete a Container Apps Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • Optionaloptions: JobsDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, jobName, options?): Promise<void>

  • Delete a Container Apps Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • Optionaloptions: JobsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginResume

  • beginResume(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<Job>, Job>>

  • Resumes a suspended job

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Name of the Job.

    • Optionaloptions: JobsResumeOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Job>, Job>>

beginResumeAndWait

  • beginResumeAndWait(resourceGroupName, jobName, options?): Promise<Job>

  • Resumes a suspended job

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Name of the Job.

    • Optionaloptions: JobsResumeOptionalParams

      The options parameters.

    Returns Promise<Job>

beginStart

beginStartAndWait

beginStopExecution

  • beginStopExecution(resourceGroupName, jobName, jobExecutionName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Terminates execution of a running container apps job

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • jobExecutionName: string

      Job execution name.

    • Optionaloptions: JobsStopExecutionOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginStopExecutionAndWait

  • beginStopExecutionAndWait(resourceGroupName, jobName, jobExecutionName, options?): Promise<void>

  • Terminates execution of a running container apps job

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • jobExecutionName: string

      Job execution name.

    • Optionaloptions: JobsStopExecutionOptionalParams

      The options parameters.

    Returns Promise<void>

beginStopMultipleExecutions

beginStopMultipleExecutionsAndWait

beginSuspend

  • beginSuspend(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<Job>, Job>>

  • Suspends a job

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Name of the Job.

    • Optionaloptions: JobsSuspendOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Job>, Job>>

beginSuspendAndWait

  • beginSuspendAndWait(resourceGroupName, jobName, options?): Promise<Job>

  • Suspends a job

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Name of the Job.

    • Optionaloptions: JobsSuspendOptionalParams

      The options parameters.

    Returns Promise<Job>

beginUpdate

  • beginUpdate(resourceGroupName, jobName, jobEnvelope, options?): Promise<SimplePollerLike<OperationState<Job>, Job>>

  • Patches a Container Apps Job using JSON Merge Patch

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • jobEnvelope: JobPatchProperties

      Properties used to create a container apps job

    • Optionaloptions: JobsUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Job>, Job>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, jobName, jobEnvelope, options?): Promise<Job>

  • Patches a Container Apps Job using JSON Merge Patch

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • jobEnvelope: JobPatchProperties

      Properties used to create a container apps job

    • Optionaloptions: JobsUpdateOptionalParams

      The options parameters.

    Returns Promise<Job>

get

  • get(resourceGroupName, jobName, options?): Promise<Job>

  • Get the properties of a Container Apps Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • Optionaloptions: JobsGetOptionalParams

      The options parameters.

    Returns Promise<Job>

getDetector

  • getDetector(resourceGroupName, jobName, detectorName, options?): Promise<Diagnostics>

  • Get the diagnostics data for a Container App Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • detectorName: string

      Name of the Container App Job detector.

    • Optionaloptions: JobsGetDetectorOptionalParams

      The options parameters.

    Returns Promise<Diagnostics>

listByResourceGroup

  • listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<Job>

  • Get the Container Apps Jobs in a given resource group.

    Parameters

    Returns PagedAsyncIterableIterator<Job>

listBySubscription

listDetectors

  • listDetectors(resourceGroupName, jobName, options?): PagedAsyncIterableIterator<Diagnostics>

  • Get the list of diagnostics for a Container App Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • Optionaloptions: JobsListDetectorsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Diagnostics>

listSecrets

proxyGet

  • proxyGet(resourceGroupName, jobName, apiName, options?): Promise<Job>

  • Get the properties of a Container App Job.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • jobName: string

      Job Name

    • apiName: string

      Proxy API Name for Container App Job.

    • Optionaloptions: JobsProxyGetOptionalParams

      The options parameters.

    Returns Promise<Job>

Settings

Member Visibility