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

Successfully retrieved the job.

Name	Datatype	Description
properties	object	Resource properties.

list_by_agent

Successfully retrieved the list of jobs.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, jobAgentName, jobName, subscriptionId		Gets a job.
list_by_agent	select	resourceGroupName, serverName, jobAgentName, subscriptionId		Gets a list of jobs.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, jobName, subscriptionId		Creates or updates a job.
delete	delete	resourceGroupName, serverName, jobAgentName, jobName, subscriptionId		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
jobAgentName	string	The name of the job agent.
jobName	string	The name of the job to delete.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a job.

SELECT
properties
FROM azure.sql.jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_agent

Gets a list of jobs.

SELECT
properties
FROM azure.sql.jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a job.

INSERT INTO azure.sql.jobs (
data__properties,
resourceGroupName,
serverName,
jobAgentName,
jobName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ jobAgentName }}',
'{{ jobName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the jobs resource.
    - name: serverName
      value: string
      description: Required parameter for the jobs resource.
    - name: jobAgentName
      value: string
      description: Required parameter for the jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the jobs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the jobs resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a job.

DELETE FROM azure.sql.jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND jobAgentName = '{{ jobAgentName }}' --required
AND jobName = '{{ jobName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;