job_step_executions

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

Overview

Name	job_step_executions
Type	Resource
Id	azure.sql.job_step_executions

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the step execution.

Name	Datatype	Description
properties	object	Resource properties.

list_by_job_execution

Successfully retrieved the step 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, stepName, subscriptionId		Gets a step execution of a job execution.
list_by_job_execution	select	resourceGroupName, serverName, jobAgentName, jobName, jobExecutionId, subscriptionId	createTimeMin, createTimeMax, endTimeMin, endTimeMax, isActive, $skip, $top	Lists the step executions 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
jobName	string	The name of the job to get.
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.
stepName	string	The name of the step.
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 step execution of a job execution.

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

list_by_job_execution

Lists the step executions of a job execution.

SELECT
properties
FROM azure.sql.job_step_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
AND createTimeMin = '{{ createTimeMin }}'
AND createTimeMax = '{{ createTimeMax }}'
AND endTimeMin = '{{ endTimeMin }}'
AND endTimeMax = '{{ endTimeMax }}'
AND isActive = '{{ isActive }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;