JobsOperations interface

Package:

@azure/arm-appcontainers

Interface representing a Jobs operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginResume
beginResumeAndWait
beginStart
beginStartAndWait
beginStopExecution
beginStopExecutionAndWait
beginStopMultipleExecutions
beginStopMultipleExecutionsAndWait
beginSuspend
beginSuspendAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	Create or Update a Container Apps Job.
delete	Delete a Container Apps Job.
get	Get the properties of a Container Apps Job.
getDetector	Get the diagnostics data for a Container App Job.
listByResourceGroup	Get the Container Apps Jobs in a given resource group.
listBySubscription	Get the Container Apps Jobs in a given subscription.
listDetectors	Get the list of diagnostics for a Container App Job.
listSecrets	List secrets for a container apps job
proxyGet	Get the properties of a Container App Job.
resume	Resumes a suspended job
start	Start a Container Apps Job
stopExecution	Terminates execution of a running container apps job
stopMultipleExecutions	Terminates execution of a running container apps job
suspend	Suspends a job
update	Patches a Container Apps Job using JSON Merge Patch

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams) => Promise<Job>

Property Value

(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams) => Promise<Job>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<void>

beginResume

Warning

This API is now deprecated.

use resume instead

beginResume: (resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

beginResumeAndWait

Warning

This API is now deprecated.

use resume instead

beginResumeAndWait: (resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams) => Promise<Job>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams) => Promise<Job>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams) => Promise<SimplePollerLike<OperationState<JobExecutionBase>, JobExecutionBase>>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams) => Promise<SimplePollerLike<OperationState<JobExecutionBase>, JobExecutionBase>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams) => Promise<JobExecutionBase>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams) => Promise<JobExecutionBase>

beginStopExecution

Warning

This API is now deprecated.

use stopExecution instead

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

Property Value

(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopExecutionAndWait

Warning

This API is now deprecated.

use stopExecution instead

beginStopExecutionAndWait: (resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams) => Promise<void>

beginStopMultipleExecutions

Warning

This API is now deprecated.

use stopMultipleExecutions instead

beginStopMultipleExecutions: (resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>>

beginStopMultipleExecutionsAndWait

Warning

This API is now deprecated.

use stopMultipleExecutions instead

beginStopMultipleExecutionsAndWait: (resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams) => Promise<ContainerAppJobExecutions>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams) => Promise<ContainerAppJobExecutions>

beginSuspend

Warning

This API is now deprecated.

use suspend instead

beginSuspend: (resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

beginSuspendAndWait

Warning

This API is now deprecated.

use suspend instead

beginSuspendAndWait: (resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams) => Promise<Job>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams) => Promise<Job>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

Property Value

(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Job>, Job>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams) => Promise<Job>

Property Value

(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams) => Promise<Job>

createOrUpdate

Create or Update a Container Apps Job.

createOrUpdate: (resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Job>, Job>

Property Value

(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Job>, Job>

delete

Delete a Container Apps Job.

delete: (resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the properties of a Container Apps Job.

get: (resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams) => Promise<Job>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams) => Promise<Job>

getDetector

Get the diagnostics data for a Container App Job.

getDetector: (resourceGroupName: string, jobName: string, detectorName: string, options?: JobsGetDetectorOptionalParams) => Promise<Diagnostics>

Property Value

(resourceGroupName: string, jobName: string, detectorName: string, options?: JobsGetDetectorOptionalParams) => Promise<Diagnostics>

listByResourceGroup

Get the Container Apps Jobs in a given resource group.

listByResourceGroup: (resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Job, Job[], PageSettings>

Property Value

(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Job, Job[], PageSettings>

listBySubscription

Get the Container Apps Jobs in a given subscription.

listBySubscription: (options?: JobsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Job, Job[], PageSettings>

Property Value

(options?: JobsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Job, Job[], PageSettings>

listDetectors

Get the list of diagnostics for a Container App Job.

listDetectors: (resourceGroupName: string, jobName: string, options?: JobsListDetectorsOptionalParams) => PagedAsyncIterableIterator<Diagnostics, Diagnostics[], PageSettings>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsListDetectorsOptionalParams) => PagedAsyncIterableIterator<Diagnostics, Diagnostics[], PageSettings>

listSecrets

List secrets for a container apps job

listSecrets: (resourceGroupName: string, jobName: string, options?: JobsListSecretsOptionalParams) => Promise<JobSecretsCollection>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsListSecretsOptionalParams) => Promise<JobSecretsCollection>

proxyGet

Get the properties of a Container App Job.

proxyGet: (resourceGroupName: string, jobName: string, apiName: string, options?: JobsProxyGetOptionalParams) => Promise<Job>

Property Value

(resourceGroupName: string, jobName: string, apiName: string, options?: JobsProxyGetOptionalParams) => Promise<Job>

resume

Resumes a suspended job

resume: (resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams) => PollerLike<OperationState<Job>, Job>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsResumeOptionalParams) => PollerLike<OperationState<Job>, Job>

start

Start a Container Apps Job

start: (resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams) => PollerLike<OperationState<JobExecutionBase>, JobExecutionBase>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams) => PollerLike<OperationState<JobExecutionBase>, JobExecutionBase>

stopExecution

Terminates execution of a running container apps job

stopExecution: (resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams) => PollerLike<OperationState<void>, void>

stopMultipleExecutions

Terminates execution of a running container apps job

stopMultipleExecutions: (resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams) => PollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams) => PollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>

suspend

Suspends a job

suspend: (resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams) => PollerLike<OperationState<Job>, Job>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsSuspendOptionalParams) => PollerLike<OperationState<Job>, Job>

update

Patches a Container Apps Job using JSON Merge Patch

update: (resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams) => PollerLike<OperationState<Job>, Job>

Property Value

(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams) => PollerLike<OperationState<Job>, Job>