jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.app_containers.jobs

Fields

The following fields are returned by SELECT queries:

get_detector

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProviderMetadata	object	List of data providers' metadata.
dataset	array	Set of data collections associated with the response.
metadata	object	Metadata of the diagnostics response.
status	object	Status of the diagnostics response.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configuration	object	Container Apps Job configuration properties.
environmentId	string	Resource ID of environment.
eventStreamEndpoint	string	The endpoint of the eventstream of the container apps job.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
outboundIpAddresses	array	Outbound IP Addresses of a container apps job.
provisioningState	string	Provisioning state of the Container Apps Job. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	Container Apps job definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadProfileName	string	Workload profile name to pin for container apps job execution.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configuration	object	Container Apps Job configuration properties.
environmentId	string	Resource ID of environment.
eventStreamEndpoint	string	The endpoint of the eventstream of the container apps job.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
outboundIpAddresses	array	Outbound IP Addresses of a container apps job.
provisioningState	string	Provisioning state of the Container Apps Job. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	Container Apps job definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadProfileName	string	Workload profile name to pin for container apps job execution.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configuration	object	Container Apps Job configuration properties.
environmentId	string	Resource ID of environment.
eventStreamEndpoint	string	The endpoint of the eventstream of the container apps job.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
outboundIpAddresses	array	Outbound IP Addresses of a container apps job.
provisioningState	string	Provisioning state of the Container Apps Job. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	Container Apps job definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadProfileName	string	Workload profile name to pin for container apps job execution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_detector	select	resource_group_name, job_name, detector_name, subscription_id		Get the diagnostics data for a given Container App Job. Get the diagnostics data for a Container App Job.
get	select	resource_group_name, job_name, subscription_id		Get the properties of a Container Apps Job. Get the properties of a Container Apps Job.
list_by_resource_group	select	resource_group_name, subscription_id		Get the Container Apps Jobs in a given resource group. Get the Container Apps Jobs in a given resource group.
list_by_subscription	select	subscription_id		Get the Container Apps Jobs in a given subscription. Get the Container Apps Jobs in a given subscription.
create_or_update	insert	resource_group_name, job_name, subscription_id, location		Create or Update a Container Apps Job. Create or Update a Container Apps Job.
update	update	resource_group_name, job_name, subscription_id		Update properties of a Container Apps Job. Patches a Container Apps Job using JSON Merge Patch.
create_or_update	replace	resource_group_name, job_name, subscription_id, location		Create or Update a Container Apps Job. Create or Update a Container Apps Job.
delete	delete	resource_group_name, job_name, subscription_id		Delete a Container Apps Job. Delete a Container Apps Job.
list_secrets	exec	resource_group_name, job_name, subscription_id		List secrets for a container apps job. List secrets for a container apps job.
list_detectors	exec	resource_group_name, job_name, subscription_id		Get the list of diagnostics for a given Container App Job. Get the list of diagnostics for a Container App Job.
start	exec	resource_group_name, job_name, subscription_id		Start a Container Apps Job. Start a Container Apps Job.
stop_multiple_executions	exec	resource_group_name, job_name, subscription_id		Terminates execution of a running container apps job. Terminates execution of a running container apps job.
stop_execution	exec	resource_group_name, job_name, job_execution_name, subscription_id		Terminates execution of a running container apps job. Terminates execution of a running container apps job.
proxy_get	exec	resource_group_name, job_name, api_name, subscription_id		Get the properties of a Container App Job. Get the properties for a given 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
api_name	string	Proxy API Name for Container App Job. Required.
detector_name	string	Proxy API Name for Container App Job. Required.
job_execution_name	string	Job execution name. Required.
job_name	string	Job Name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_detector

Get the diagnostics data for a given Container App Job. Get the diagnostics data for a Container App Job.

SELECT
id,
name,
dataProviderMetadata,
dataset,
metadata,
status,
systemData,
type
FROM azure.app_containers.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get the properties of a Container Apps Job. Get the properties of a Container Apps Job.

SELECT
id,
name,
configuration,
environmentId,
eventStreamEndpoint,
identity,
location,
outboundIpAddresses,
provisioningState,
systemData,
tags,
template,
type,
workloadProfileName
FROM azure.app_containers.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get the Container Apps Jobs in a given resource group. Get the Container Apps Jobs in a given resource group.

SELECT
id,
name,
configuration,
environmentId,
eventStreamEndpoint,
identity,
location,
outboundIpAddresses,
provisioningState,
systemData,
tags,
template,
type,
workloadProfileName
FROM azure.app_containers.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get the Container Apps Jobs in a given subscription. Get the Container Apps Jobs in a given subscription.

SELECT
id,
name,
configuration,
environmentId,
eventStreamEndpoint,
identity,
location,
outboundIpAddresses,
provisioningState,
systemData,
tags,
template,
type,
workloadProfileName
FROM azure.app_containers.jobs
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update a Container Apps Job. Create or Update a Container Apps Job.

INSERT INTO azure.app_containers.jobs (
tags,
location,
properties,
identity,
resource_group_name,
job_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ job_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: jobs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the jobs resource.
  - name: job_name
    value: "{{ job_name }}"
    description: Required parameter for the jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the jobs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Container Apps Job resource specific properties.
    value:
      provisioningState: "{{ provisioningState }}"
      environmentId: "{{ environmentId }}"
      workloadProfileName: "{{ workloadProfileName }}"
      configuration:
        secrets:
          - name: "{{ name }}"
            value: "{{ value }}"
            identity: "{{ identity }}"
            keyVaultUrl: "{{ keyVaultUrl }}"
        triggerType: "{{ triggerType }}"
        replicaTimeout: {{ replicaTimeout }}
        replicaRetryLimit: {{ replicaRetryLimit }}
        manualTriggerConfig:
          replicaCompletionCount: {{ replicaCompletionCount }}
          parallelism: {{ parallelism }}
        scheduleTriggerConfig:
          replicaCompletionCount: {{ replicaCompletionCount }}
          cronExpression: "{{ cronExpression }}"
          parallelism: {{ parallelism }}
        eventTriggerConfig:
          replicaCompletionCount: {{ replicaCompletionCount }}
          parallelism: {{ parallelism }}
          scale:
            pollingInterval: {{ pollingInterval }}
            minExecutions: {{ minExecutions }}
            maxExecutions: {{ maxExecutions }}
            rules:
              - name: "{{ name }}"
                type: "{{ type }}"
                metadata: "{{ metadata }}"
                auth: "{{ auth }}"
                identity: "{{ identity }}"
        registries:
          - server: "{{ server }}"
            username: "{{ username }}"
            passwordSecretRef: "{{ passwordSecretRef }}"
            identity: "{{ identity }}"
        identitySettings:
          - identity: "{{ identity }}"
            lifecycle: "{{ lifecycle }}"
      template:
        initContainers:
          - image: "{{ image }}"
            name: "{{ name }}"
            command: "{{ command }}"
            args: "{{ args }}"
            env: "{{ env }}"
            resources:
              cpu: {{ cpu }}
              memory: "{{ memory }}"
              ephemeralStorage: "{{ ephemeralStorage }}"
            volumeMounts: "{{ volumeMounts }}"
        containers:
          - image: "{{ image }}"
            name: "{{ name }}"
            command: "{{ command }}"
            args: "{{ args }}"
            env: "{{ env }}"
            resources:
              cpu: {{ cpu }}
              memory: "{{ memory }}"
              ephemeralStorage: "{{ ephemeralStorage }}"
            volumeMounts: "{{ volumeMounts }}"
            probes: "{{ probes }}"
        volumes:
          - name: "{{ name }}"
            storageType: "{{ storageType }}"
            storageName: "{{ storageName }}"
            secrets: "{{ secrets }}"
            mountOptions: "{{ mountOptions }}"
      outboundIpAddresses:
        - "{{ outboundIpAddresses }}"
      eventStreamEndpoint: "{{ eventStreamEndpoint }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update properties of a Container Apps Job. Patches a Container Apps Job using JSON Merge Patch.

UPDATE azure.app_containers.jobs
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or Update a Container Apps Job. Create or Update a Container Apps Job.

REPLACE azure.app_containers.jobs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Container Apps Job. Delete a Container Apps Job.

DELETE FROM azure.app_containers.jobs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND job_name = '{{ job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_secrets

List secrets for a container apps job. List secrets for a container apps job.

EXEC azure.app_containers.jobs.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_detectors

Get the list of diagnostics for a given Container App Job. Get the list of diagnostics for a Container App Job.

EXEC azure.app_containers.jobs.list_detectors 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Start a Container Apps Job. Start a Container Apps Job.

EXEC azure.app_containers.jobs.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"containers": "{{ containers }}", 
"initContainers": "{{ initContainers }}"
}'
;

stop_multiple_executions

Terminates execution of a running container apps job. Terminates execution of a running container apps job.

EXEC azure.app_containers.jobs.stop_multiple_executions 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop_execution

Terminates execution of a running container apps job. Terminates execution of a running container apps job.

EXEC azure.app_containers.jobs.stop_execution 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@job_execution_name='{{ job_execution_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

proxy_get

Get the properties of a Container App Job. Get the properties for a given Container App Job.

EXEC azure.app_containers.jobs.proxy_get 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@api_name='{{ api_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;