jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.spring_apps.jobs

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Job.

Name	Datatype	Description
properties	object	Properties of the Job resource

list

Success. The response describes the list of Jobs in the Service.

Name	Datatype	Description
properties	object	Properties of the Job resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, jobName		Get a Job and its properties.
list	select	subscriptionId, resourceGroupName, serviceName		Get the Azure Spring Apps Jobs in a given service
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, jobName		Create a new Job or update an exiting Job.
delete	delete	subscriptionId, resourceGroupName, serviceName, jobName		Operation to delete a Job.
start	exec	subscriptionId, resourceGroupName, serviceName, jobName

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
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 a Job and its properties.

SELECT
properties
FROM azure.spring_apps.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND jobName = '{{ jobName }}' -- required
;

list

Get the Azure Spring Apps Jobs in a given service

SELECT
properties
FROM azure.spring_apps.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

INSERT examples

create_or_update

Create a new Job or update an exiting Job.

INSERT INTO azure.spring_apps.jobs (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
jobName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ jobName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the jobs resource.
    - name: serviceName
      value: string
      description: Required parameter for the jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the jobs resource.
    - name: properties
      value: object
      description: |
        Properties of the Job resource

DELETE examples

delete

Operation to delete a Job.

DELETE FROM azure.spring_apps.jobs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND jobName = '{{ jobName }}' --required
;

Lifecycle Methods

start

Success.

EXEC azure.spring_apps.jobs.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@jobName='{{ jobName }}' --required 
@@json=
'{
"environmentVariables": "{{ environmentVariables }}", 
"args": "{{ args }}", 
"resourceRequests": "{{ resourceRequests }}"
}'
;