job_executions

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

Overview

Name	job_executions
Type	Resource
Id	azure.sql.job_executions

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the job.

Name	Datatype	Description
properties	object	Resource properties.

list_by_job

Successfully retrieved job executions.

Name	Datatype	Description
properties	object	Resource properties.

list_by_agent

Successfully retrieved job executions.

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, jobExecutionId, subscriptionId		Gets a job execution.
list_by_job	select	resourceGroupName, serverName, jobAgentName, jobName, subscriptionId	createTimeMin, createTimeMax, endTimeMin, endTimeMax, isActive, $skip, $top	Lists a job's executions.
list_by_agent	select	resourceGroupName, serverName, jobAgentName, subscriptionId	createTimeMin, createTimeMax, endTimeMin, endTimeMax, isActive, $skip, $top	Lists all executions in a job agent.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, jobName, jobExecutionId, subscriptionId		Creates or updates a job execution.
create	insert	resourceGroupName, serverName, jobAgentName, jobName, subscriptionId		Starts an elastic job execution.
cancel	exec	resourceGroupName, serverName, jobAgentName, jobName, jobExecutionId, subscriptionId		Requests cancellation of a job execution.

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.
jobExecutionId	string (uuid)	The id of the job execution to cancel.
jobName	string	The name of the job.
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.
$skip	integer	The number of elements in the collection to skip.
$top	integer	The number of elements to return from the collection.
createTimeMax	string (date-time)	If specified, only job executions created before the specified time are included.
createTimeMin	string (date-time)	If specified, only job executions created at or after the specified time are included.
endTimeMax	string (date-time)	If specified, only job executions completed before the specified time are included.
endTimeMin	string (date-time)	If specified, only job executions completed at or after the specified time are included.
isActive	boolean	If specified, only active or only completed job executions are included.

SELECT examples

get

Gets a job execution.

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

list_by_job

Lists a job's executions.

SELECT
properties
FROM azure.sql.job_executions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND createTimeMin = '{{ createTimeMin }}'
AND createTimeMax = '{{ createTimeMax }}'
AND endTimeMin = '{{ endTimeMin }}'
AND endTimeMax = '{{ endTimeMax }}'
AND isActive = '{{ isActive }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

list_by_agent

Lists all executions in a job agent.

SELECT
properties
FROM azure.sql.job_executions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND createTimeMin = '{{ createTimeMin }}'
AND createTimeMax = '{{ createTimeMax }}'
AND endTimeMin = '{{ endTimeMin }}'
AND endTimeMax = '{{ endTimeMax }}'
AND isActive = '{{ isActive }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a job execution.

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

create

Starts an elastic job execution.

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

Manifest

# Description fields are for documentation purposes
- name: job_executions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_executions resource.
    - name: serverName
      value: string
      description: Required parameter for the job_executions resource.
    - name: jobAgentName
      value: string
      description: Required parameter for the job_executions resource.
    - name: jobName
      value: string
      description: Required parameter for the job_executions resource.
    - name: jobExecutionId
      value: string (uuid)
      description: Required parameter for the job_executions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the job_executions resource.

Lifecycle Methods

cancel

Requests cancellation of a job execution.

EXEC azure.sql.job_executions.cancel 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@jobAgentName='{{ jobAgentName }}' --required, 
@jobName='{{ jobName }}' --required, 
@jobExecutionId='{{ jobExecutionId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;