jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.container_apps.jobs

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
extendedLocation	object	The complex type of the extended location.
identity	object	Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.
location	string	The geo-location where the resource lives
properties	object	Container Apps Job resource specific properties.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
extendedLocation	object	The complex type of the extended location.
identity	object	Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.
location	string	The geo-location where the resource lives
properties	object	Container Apps Job resource specific properties.
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
extendedLocation	object	The complex type of the extended location.
identity	object	Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.
location	string	The geo-location where the resource lives
properties	object	Container Apps Job resource specific properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, jobName
list_by_resource_group	select	subscriptionId, resourceGroupName
list_by_subscription	select	subscriptionId
create_or_update	insert	subscriptionId, resourceGroupName, jobName		Create or Update a Container Apps Job.
update	update	subscriptionId, resourceGroupName, jobName		Patches a Container Apps Job using JSON Merge Patch
delete	delete	subscriptionId, resourceGroupName, jobName		Delete a Container Apps Job.
start	exec	subscriptionId, resourceGroupName, jobName
stop_execution	exec	subscriptionId, resourceGroupName, jobName, jobExecutionName
stop_multiple_executions	exec	subscriptionId, resourceGroupName, jobName
proxy_get	exec	subscriptionId, resourceGroupName, jobName, apiName		Get the properties of a Container App 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
apiName	string	Proxy API Name for Container App Job.
jobExecutionName	string	Job execution name.
jobName	string	Job Name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK.

SELECT
extendedLocation,
identity,
location,
properties,
tags
FROM azure.container_apps.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobName = '{{ jobName }}' -- required
;

list_by_resource_group

OK

SELECT
extendedLocation,
identity,
location,
properties,
tags
FROM azure.container_apps.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

OK

SELECT
extendedLocation,
identity,
location,
properties,
tags
FROM azure.container_apps.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or Update a Container Apps Job.

INSERT INTO azure.container_apps.jobs (
data__tags,
data__location,
data__extendedLocation,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
jobName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ extendedLocation }}',
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobName }}'
RETURNING
extendedLocation,
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the jobs resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: extendedLocation
      value: object
      description: |
        The complex type of the extended location.
    - name: identity
      value: object
      description: |
        Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.
    - name: properties
      value: object
      description: |
        Container Apps Job resource specific properties.

UPDATE examples

update

Patches a Container Apps Job using JSON Merge Patch

UPDATE azure.container_apps.jobs
SET 
data__extendedLocation = '{{ extendedLocation }}',
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
RETURNING
extendedLocation,
identity,
location,
properties,
tags;

DELETE examples

delete

Delete a Container Apps Job.

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

Lifecycle Methods

start

OK

EXEC azure.container_apps.jobs.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required 
@@json=
'{
"containers": "{{ containers }}", 
"initContainers": "{{ initContainers }}"
}'
;

stop_execution

Container Apps Jobs terminated successfully.

EXEC azure.container_apps.jobs.stop_execution 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required, 
@jobExecutionName='{{ jobExecutionName }}' --required
;

stop_multiple_executions

List of all the job executions that were requested to be stopped

EXEC azure.container_apps.jobs.stop_multiple_executions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required
;

proxy_get

Get the properties of a Container App Job.

EXEC azure.container_apps.jobs.proxy_get 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobName='{{ jobName }}' --required, 
@apiName='{{ apiName }}' --required
;