job_steps

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

Overview

Name	job_steps
Type	Resource
Id	azure.sql.job_steps

Fields

The following fields are returned by SELECT queries:

get_by_version

Successfully retrieved the job step.

Name	Datatype	Description
properties	object	Resource properties.

list_by_version

Successfully retrieved the list of job steps.

Name	Datatype	Description
properties	object	Resource properties.

get

Successfully retrieved the job step.

Name	Datatype	Description
properties	object	Resource properties.

list_by_job

Successfully retrieved the list of job steps.

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_by_version	select	resourceGroupName, serverName, jobAgentName, jobName, jobVersion, stepName, subscriptionId		Gets the specified version of a job step.
list_by_version	select	resourceGroupName, serverName, jobAgentName, jobName, jobVersion, subscriptionId		Gets all job steps in the specified job version.
get	select	resourceGroupName, serverName, jobAgentName, jobName, stepName, subscriptionId		Gets a job step in a job's current version.
list_by_job	select	resourceGroupName, serverName, jobAgentName, jobName, subscriptionId		Gets all job steps for a job's current version.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, jobName, stepName, subscriptionId		Creates or updates a job step. This will implicitly create a new job version.
delete	delete	resourceGroupName, serverName, jobAgentName, jobName, stepName, subscriptionId		Deletes a job step. This will implicitly create a new job version.

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.
jobVersion	integer (int32)	The version 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 job step to delete.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get_by_version

Gets the specified version of a job step.

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

list_by_version

Gets all job steps in the specified job version.

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

get

Gets a job step in a job's current version.

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

list_by_job

Gets all job steps for a job's current version.

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

INSERT examples

create_or_update

Creates or updates a job step. This will implicitly create a new job version.

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

Manifest

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

DELETE examples

delete

Deletes a job step. This will implicitly create a new job version.

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