job_executions

Creates, updates, deletes, gets or lists a job_executions resource.

Overview

Name	job_executions
Type	Resource
Id	azure.spring_apps.job_executions

Fields

The following fields are returned by SELECT queries:

get

Success.

Name	Datatype	Description
name	string	Job execution Name.
endTime	string (date-time)	Job execution end time.
jobSnapshot	object	The snapshot of job configuration
startTime	string (date-time)	Job execution start time.
status	string	Current state of the job execution
template	object	The template which is applied for the execution of the Job.

list

Success. The response describes the list of Job executions in the Service.

Name	Datatype	Description
name	string	Job execution Name.
endTime	string (date-time)	Job execution end time.
jobSnapshot	object	The snapshot of job configuration
startTime	string (date-time)	Job execution start time.
status	string	Current state of the job execution
template	object	The template which is applied for the execution of the Job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, jobName, jobExecutionName		Get details of an execution of an Azure Spring Apps Job
list	select	subscriptionId, resourceGroupName, serviceName, jobName		Get executions of a Azure Spring Apps Job
cancel	exec	subscriptionId, resourceGroupName, serviceName, jobName, jobExecutionName		Terminate execution of a running Azure Spring Apps Job

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
jobExecutionName	string	The name of the Job execution.
jobName	string	The name of the Job resource.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get details of an execution of an Azure Spring Apps Job

SELECT
name,
endTime,
jobSnapshot,
startTime,
status,
template
FROM azure.spring_apps.job_executions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND jobExecutionName = '{{ jobExecutionName }}' -- required
;

list

Get executions of a Azure Spring Apps Job

SELECT
name,
endTime,
jobSnapshot,
startTime,
status,
template
FROM azure.spring_apps.job_executions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND jobName = '{{ jobName }}' -- required
;

Lifecycle Methods

cancel

Terminate execution of a running Azure Spring Apps Job

EXEC azure.spring_apps.job_executions.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@jobName='{{ jobName }}' --required, 
@jobExecutionName='{{ jobExecutionName }}' --required
;