jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.scheduler.jobs

Fields

vw_jobs

Name	Datatype	Description
id	text	Gets the job resource identifier.
name	text	Gets the job resource name.
action	text	field from the properties object
jobCollectionName	text	field from the properties object
jobName	text	field from the properties object
recurrence	text	field from the properties object
resourceGroupName	text	field from the properties object
start_time	text	field from the properties object
state	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Gets the job resource type.

jobs

Name	Datatype	Description
id	string	Gets the job resource identifier.
name	string	Gets the job resource name.
properties	object
type	string	Gets the job resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	jobCollectionName, jobName, resourceGroupName, subscriptionId	Gets a job.
list	SELECT	jobCollectionName, resourceGroupName, subscriptionId	Lists all jobs under the specified job collection.
create_or_update	INSERT	jobCollectionName, jobName, resourceGroupName, subscriptionId	Provisions a new job or updates an existing job.
delete	DELETE	jobCollectionName, jobName, resourceGroupName, subscriptionId	Deletes a job.
patch	UPDATE	jobCollectionName, jobName, resourceGroupName, subscriptionId	Patches an existing job.
run	EXEC	jobCollectionName, jobName, resourceGroupName, subscriptionId	Runs a job.

SELECT examples

Lists all jobs under the specified job collection.

vw_jobs

SELECT
id,
name,
action,
jobCollectionName,
jobName,
recurrence,
resourceGroupName,
start_time,
state,
status,
subscriptionId,
type
FROM azure.scheduler.vw_jobs
WHERE jobCollectionName = '{{ jobCollectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

jobs

SELECT
id,
name,
properties,
type
FROM azure.scheduler.jobs
WHERE jobCollectionName = '{{ jobCollectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new jobs resource.

All Properties

/*+ create */
INSERT INTO azure.scheduler.jobs (
jobCollectionName,
jobName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ jobCollectionName }}',
'{{ jobName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: type
      value: string
    - name: name
      value: string
    - name: properties
      value:
        - name: startTime
          value: string
        - name: action
          value:
            - name: type
              value: string
            - name: request
              value:
                - name: authentication
                  value:
                    - name: type
                      value: string
                - name: uri
                  value: string
                - name: method
                  value: string
                - name: body
                  value: string
                - name: headers
                  value: object
            - name: queueMessage
              value:
                - name: storageAccount
                  value: string
                - name: queueName
                  value: string
                - name: sasToken
                  value: string
                - name: message
                  value: string
            - name: serviceBusQueueMessage
              value:
                - name: queueName
                  value: string
                - name: authentication
                  value:
                    - name: sasKey
                      value: string
                    - name: sasKeyName
                      value: string
                    - name: type
                      value: string
                - name: brokeredMessageProperties
                  value:
                    - name: contentType
                      value: string
                    - name: correlationId
                      value: string
                    - name: forcePersistence
                      value: boolean
                    - name: label
                      value: string
                    - name: messageId
                      value: string
                    - name: partitionKey
                      value: string
                    - name: replyTo
                      value: string
                    - name: replyToSessionId
                      value: string
                    - name: scheduledEnqueueTimeUtc
                      value: string
                    - name: sessionId
                      value: string
                    - name: timeToLive
                      value: string
                    - name: to
                      value: string
                    - name: viaPartitionKey
                      value: string
                - name: customMessageProperties
                  value: object
                - name: message
                  value: string
                - name: namespace
                  value: string
                - name: transportType
                  value: string
            - name: serviceBusTopicMessage
              value:
                - name: topicPath
                  value: string
                - name: customMessageProperties
                  value: object
                - name: message
                  value: string
                - name: namespace
                  value: string
                - name: transportType
                  value: string
            - name: retryPolicy
              value:
                - name: retryType
                  value: string
                - name: retryInterval
                  value: string
                - name: retryCount
                  value: integer
            - name: errorAction
              value:
                - name: type
                  value: string
        - name: recurrence
          value:
            - name: frequency
              value: string
            - name: interval
              value: integer
            - name: count
              value: integer
            - name: endTime
              value: string
            - name: schedule
              value:
                - name: weekDays
                  value:
                    - string
                - name: hours
                  value:
                    - integer
                - name: minutes
                  value:
                    - integer
                - name: monthDays
                  value:
                    - integer
                - name: monthlyOccurrences
                  value:
                    - - name: day
                        value: string
                      - name: Occurrence
                        value: integer
        - name: state
          value: []
        - name: status
          value:
            - name: executionCount
              value: integer
            - name: failureCount
              value: integer
            - name: faultedCount
              value: integer
            - name: lastExecutionTime
              value: string
            - name: nextExecutionTime
              value: string

UPDATE example

Updates a jobs resource.

/*+ update */
UPDATE azure.scheduler.jobs
SET 
properties = '{{ properties }}'
WHERE 
jobCollectionName = '{{ jobCollectionName }}'
AND jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified jobs resource.

/*+ delete */
DELETE FROM azure.scheduler.jobs
WHERE jobCollectionName = '{{ jobCollectionName }}'
AND jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';