jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.scheduler.jobs

Fields

The following fields are returned by SELECT queries:

get

The job has been successfully returned.

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

list

The job has been successfully returned.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, jobCollectionName, jobName	api-version	Gets a job.
list	select	subscriptionId, resourceGroupName, jobCollectionName	api-version, $top, $skip, $filter	Lists all jobs under the specified job collection.
create_or_update	insert	subscriptionId, resourceGroupName, jobCollectionName, jobName	api-version	Provisions a new job or updates an existing job.
patch	update	subscriptionId, resourceGroupName, jobCollectionName, jobName	api-version	Patches an existing job.
delete	delete	subscriptionId, resourceGroupName, jobCollectionName, jobName	api-version	Deletes a job.
run	exec	subscriptionId, resourceGroupName, jobCollectionName, jobName	api-version	Runs a 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
jobCollectionName	string	The job collection name.
jobName	string	The job name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription id.
$filter	string	The filter to apply on the job state.
$skip	integer	The (0-based) index of the job history list from which to begin requesting entries.
$top	integer	The number of jobs to request, in the of range of [1..100].
api-version	string	The API version.

SELECT examples

get

Gets a job.

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

list

Lists all jobs under the specified job collection.

SELECT
id,
name,
properties,
type
FROM azure.scheduler.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobCollectionName = '{{ jobCollectionName }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Provisions a new job or updates an existing job.

INSERT INTO azure.scheduler.jobs (
data__properties,
subscriptionId,
resourceGroupName,
jobCollectionName,
jobName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobCollectionName }}',
'{{ jobName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
type
;

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: jobCollectionName
      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: |
        Gets or sets the job properties.
    - name: api-version
      value: string
      description: The API version.

UPDATE examples

patch

Patches an existing job.

UPDATE azure.scheduler.jobs
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobCollectionName = '{{ jobCollectionName }}' --required
AND jobName = '{{ jobName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a job.

DELETE FROM azure.scheduler.jobs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobCollectionName = '{{ jobCollectionName }}' --required
AND jobName = '{{ jobName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

run

Runs a job.

EXEC azure.scheduler.jobs.run 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobCollectionName='{{ jobCollectionName }}' --required, 
@jobName='{{ jobName }}' --required, 
@api-version='{{ api-version }}'
;