Jobs interface
Interface representing a Jobs.
Methods
Method Details
beginCreateOrUpdate(string, string, Job, JobsCreateOrUpdateOptionalParams)
Create or Update a Container Apps Job.
function beginCreateOrUpdate(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Job>, 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
- options
- JobsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Job>, Job>>
beginCreateOrUpdateAndWait(string, string, Job, JobsCreateOrUpdateOptionalParams)
Create or Update a Container Apps Job.
function beginCreateOrUpdateAndWait(resourceGroupName: string, jobName: string, jobEnvelope: Job, options?: JobsCreateOrUpdateOptionalParams): Promise<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
- options
- JobsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<Job>
beginDelete(string, string, JobsDeleteOptionalParams)
Delete a Container Apps Job.
function beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)
Delete a Container Apps Job.
function beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginStart(string, string, JobsStartOptionalParams)
Start a Container Apps Job
function beginStart(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams): Promise<SimplePollerLike<OperationState<JobExecutionBase>, JobExecutionBase>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsStartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobExecutionBase>, JobExecutionBase>>
beginStartAndWait(string, string, JobsStartOptionalParams)
Start a Container Apps Job
function beginStartAndWait(resourceGroupName: string, jobName: string, options?: JobsStartOptionalParams): Promise<JobExecutionBase>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsStartOptionalParams
The options parameters.
Returns
Promise<JobExecutionBase>
beginStopExecution(string, string, string, JobsStopExecutionOptionalParams)
Terminates execution of a running container apps job
function beginStopExecution(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- jobExecutionName
-
string
Job execution name.
- options
- JobsStopExecutionOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStopExecutionAndWait(string, string, string, JobsStopExecutionOptionalParams)
Terminates execution of a running container apps job
function beginStopExecutionAndWait(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobsStopExecutionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- jobExecutionName
-
string
Job execution name.
- options
- JobsStopExecutionOptionalParams
The options parameters.
Returns
Promise<void>
beginStopMultipleExecutions(string, string, JobsStopMultipleExecutionsOptionalParams)
Terminates execution of a running container apps job
function beginStopMultipleExecutions(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams): Promise<SimplePollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerAppJobExecutions>, ContainerAppJobExecutions>>
beginStopMultipleExecutionsAndWait(string, string, JobsStopMultipleExecutionsOptionalParams)
Terminates execution of a running container apps job
function beginStopMultipleExecutionsAndWait(resourceGroupName: string, jobName: string, options?: JobsStopMultipleExecutionsOptionalParams): Promise<ContainerAppJobExecutions>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
The options parameters.
Returns
Promise<ContainerAppJobExecutions>
beginUpdate(string, string, JobPatchProperties, JobsUpdateOptionalParams)
Patches a Container Apps Job using JSON Merge Patch
function beginUpdate(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Job>, Job>>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
- options
- JobsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Job>, Job>>
beginUpdateAndWait(string, string, JobPatchProperties, JobsUpdateOptionalParams)
Patches a Container Apps Job using JSON Merge Patch
function beginUpdateAndWait(resourceGroupName: string, jobName: string, jobEnvelope: JobPatchProperties, options?: JobsUpdateOptionalParams): Promise<Job>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
- options
- JobsUpdateOptionalParams
The options parameters.
Returns
Promise<Job>
get(string, string, JobsGetOptionalParams)
Get the properties of a Container Apps Job.
function get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<Job>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsGetOptionalParams
The options parameters.
Returns
Promise<Job>
getDetector(string, string, string, JobsGetDetectorOptionalParams)
Get the diagnostics data for a Container App Job.
function getDetector(resourceGroupName: string, jobName: string, detectorName: string, options?: JobsGetDetectorOptionalParams): Promise<Diagnostics>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.
- options
- JobsGetDetectorOptionalParams
The options parameters.
Returns
Promise<Diagnostics>
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)
Get the Container Apps Jobs in a given resource group.
function listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Job, Job[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(JobsListBySubscriptionOptionalParams)
Get the Container Apps Jobs in a given subscription.
function listBySubscription(options?: JobsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Job, Job[], PageSettings>Parameters
The options parameters.
Returns
listDetectors(string, string, JobsListDetectorsOptionalParams)
Get the list of diagnostics for a Container App Job.
function listDetectors(resourceGroupName: string, jobName: string, options?: JobsListDetectorsOptionalParams): PagedAsyncIterableIterator<Diagnostics, Diagnostics[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsListDetectorsOptionalParams
The options parameters.
Returns
listSecrets(string, string, JobsListSecretsOptionalParams)
List secrets for a container apps job
function listSecrets(resourceGroupName: string, jobName: string, options?: JobsListSecretsOptionalParams): Promise<JobSecretsCollection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
Job Name
- options
- JobsListSecretsOptionalParams
The options parameters.
Returns
Promise<JobSecretsCollection>
proxyGet(string, string, string, JobsProxyGetOptionalParams)
Get the properties of a Container App Job.
function proxyGet(resourceGroupName: string, jobName: string, apiName: string, options?: JobsProxyGetOptionalParams): Promise<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.
- options
- JobsProxyGetOptionalParams
The options parameters.
Returns
Promise<Job>