job_collections

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

Overview

Name	job_collections
Type	Resource
Id	azure.scheduler.job_collections

Fields

The following fields are returned by SELECT queries:

get

The job collection has been successfully returned.

Name	Datatype	Description
id	string	Gets the job collection resource identifier.
name	string	Gets or sets the job collection resource name.
location	string	Gets or sets the storage account location.
properties	object	Gets or sets the job collection properties.
tags	object	Gets or sets the tags.
type	string	Gets the job collection resource type.

list_by_resource_group

The job collections have been successfully returned.

Name	Datatype	Description
id	string	Gets the job collection resource identifier.
name	string	Gets or sets the job collection resource name.
location	string	Gets or sets the storage account location.
properties	object	Gets or sets the job collection properties.
tags	object	Gets or sets the tags.
type	string	Gets the job collection resource type.

list_by_subscription

The job collections have been successfully returned.

Name	Datatype	Description
id	string	Gets the job collection resource identifier.
name	string	Gets or sets the job collection resource name.
location	string	Gets or sets the storage account location.
properties	object	Gets or sets the job collection properties.
tags	object	Gets or sets the tags.
type	string	Gets the job collection resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, jobCollectionName	api-version	Gets a job collection.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Gets all job collections under specified resource group.
list_by_subscription	select	subscriptionId	api-version	Gets all job collections under specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, jobCollectionName	api-version	Provisions a new job collection or updates an existing job collection.
patch	update	subscriptionId, resourceGroupName, jobCollectionName	api-version	Patches an existing job collection.
delete	delete	subscriptionId, resourceGroupName, jobCollectionName	api-version	Deletes a job collection.
enable	exec	subscriptionId, resourceGroupName, jobCollectionName	api-version	Enables all of the jobs in the job collection.
disable	exec	subscriptionId, resourceGroupName, jobCollectionName	api-version	Disables all of the jobs in the job collection.

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.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription id.
api-version	string	The API version.

SELECT examples

get

Gets a job collection.

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

list_by_resource_group

Gets all job collections under specified resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.scheduler.job_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_subscription

Gets all job collections under specified subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.scheduler.job_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Provisions a new job collection or updates an existing job collection.

INSERT INTO azure.scheduler.job_collections (
data__name,
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
jobCollectionName,
api-version
)
SELECT 
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobCollectionName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: job_collections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the job_collections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_collections resource.
    - name: jobCollectionName
      value: string
      description: Required parameter for the job_collections resource.
    - name: name
      value: string
      description: |
        Gets or sets the job collection resource name.
    - name: location
      value: string
      description: |
        Gets or sets the storage account location.
    - name: tags
      value: object
      description: |
        Gets or sets the tags.
    - name: properties
      value: object
      description: |
        Gets or sets the job collection properties.
    - name: api-version
      value: string
      description: The API version.

UPDATE examples

patch

Patches an existing job collection.

UPDATE azure.scheduler.job_collections
SET 
data__name = '{{ name }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobCollectionName = '{{ jobCollectionName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a job collection.

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

Lifecycle Methods

enable

Enables all of the jobs in the job collection.

EXEC azure.scheduler.job_collections.enable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobCollectionName='{{ jobCollectionName }}' --required, 
@api-version='{{ api-version }}'
;

disable

Disables all of the jobs in the job collection.

EXEC azure.scheduler.job_collections.disable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@jobCollectionName='{{ jobCollectionName }}' --required, 
@api-version='{{ api-version }}'
;