jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.sql.jobs

Fields

The following fields are returned by SELECT queries:

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.
description	string	User-defined description of the job.
schedule	object	Schedule properties of the job.
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".
version	integer	The job version number.

list_by_agent

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.
description	string	User-defined description of the job.
schedule	object	Schedule properties of the job.
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".
version	integer	The job version number.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, job_agent_name, job_name, subscription_id		Gets a job.
list_by_agent	select	resource_group_name, server_name, job_agent_name, subscription_id		Gets a list of jobs.
create_or_update	insert	resource_group_name, server_name, job_agent_name, job_name, subscription_id		Creates or updates a job.
create_or_update	replace	resource_group_name, server_name, job_agent_name, job_name, subscription_id		Creates or updates a job.
delete	delete	resource_group_name, server_name, job_agent_name, job_name, subscription_id		Deletes 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
job_agent_name	string	The name of the job agent to be retrieved. Required.
job_name	string	The name of the job to get. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a job.

SELECT
id,
name,
description,
schedule,
systemData,
type,
version
FROM azure.sql.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND job_name = '{{ job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_agent

Gets a list of jobs.

SELECT
id,
name,
description,
schedule,
systemData,
type,
version
FROM azure.sql.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a job.

INSERT INTO azure.sql.jobs (
properties,
resource_group_name,
server_name,
job_agent_name,
job_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ job_agent_name }}',
'{{ job_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
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: server_name
    value: "{{ server_name }}"
    description: Required parameter for the jobs resource.
  - name: job_agent_name
    value: "{{ job_agent_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: properties
    description: |
      Resource properties.
    value:
      description: "{{ description }}"
      version: {{ version }}
      schedule:
        startTime: "{{ startTime }}"
        endTime: "{{ endTime }}"
        type: "{{ type }}"
        enabled: {{ enabled }}
        interval: "{{ interval }}"

REPLACE examples

create_or_update

Creates or updates a job.

REPLACE azure.sql.jobs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND job_agent_name = '{{ job_agent_name }}' --required
AND job_name = '{{ job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a job.

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