job_steps

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

Overview

Name	job_steps
Type	Resource
Id	azure.sql.job_steps

Fields

vw_job_steps

Name	Datatype	Description
action	text	field from the properties object
credential	text	field from the properties object
execution_options	text	field from the properties object
jobAgentName	text	field from the properties object
jobName	text	field from the properties object
jobVersion	text	field from the properties object
output	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
stepName	text	field from the properties object
step_id	text	field from the properties object
subscriptionId	text	field from the properties object
target_group	text	field from the properties object

job_steps

Name	Datatype	Description
properties	object	Properties of a job step.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	jobAgentName, jobName, resourceGroupName, serverName, stepName, subscriptionId	Gets a job step in a job's current version.
get_by_version	SELECT	jobAgentName, jobName, jobVersion, resourceGroupName, serverName, stepName, subscriptionId	Gets the specified version of a job step.
list_by_job	SELECT	jobAgentName, jobName, resourceGroupName, serverName, subscriptionId	Gets all job steps for a job's current version.
list_by_version	SELECT	jobAgentName, jobName, jobVersion, resourceGroupName, serverName, subscriptionId	Gets all job steps in the specified job version.
create_or_update	INSERT	jobAgentName, jobName, resourceGroupName, serverName, stepName, subscriptionId	Creates or updates a job step. This will implicitly create a new job version.
delete	DELETE	jobAgentName, jobName, resourceGroupName, serverName, stepName, subscriptionId	Deletes a job step. This will implicitly create a new job version.

SELECT examples

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

vw_job_steps

SELECT
action,
credential,
execution_options,
jobAgentName,
jobName,
jobVersion,
output,
resourceGroupName,
serverName,
stepName,
step_id,
subscriptionId,
target_group
FROM azure.sql.vw_job_steps
WHERE jobAgentName = '{{ jobAgentName }}'
AND jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

job_steps

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

INSERT example

Use the following StackQL query and manifest file to create a new job_steps resource.

All Properties

/*+ create */
INSERT INTO azure.sql.job_steps (
jobAgentName,
jobName,
resourceGroupName,
serverName,
stepName,
subscriptionId,
properties
)
SELECT 
'{{ jobAgentName }}',
'{{ jobName }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ stepName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: stepId
          value: integer
        - name: targetGroup
          value: string
        - name: credential
          value: string
        - name: action
          value:
            - name: type
              value: string
            - name: source
              value: string
            - name: value
              value: string
        - name: output
          value:
            - name: type
              value: string
            - name: subscriptionId
              value: string
            - name: resourceGroupName
              value: string
            - name: serverName
              value: string
            - name: databaseName
              value: string
            - name: schemaName
              value: string
            - name: tableName
              value: string
            - name: credential
              value: string
        - name: executionOptions
          value:
            - name: timeoutSeconds
              value: integer
            - name: retryAttempts
              value: integer
            - name: initialRetryIntervalSeconds
              value: integer
            - name: maximumRetryIntervalSeconds
              value: integer
            - name: retryIntervalBackoffMultiplier
              value: number

DELETE example

Deletes the specified job_steps resource.

/*+ delete */
DELETE FROM azure.sql.job_steps
WHERE jobAgentName = '{{ jobAgentName }}'
AND jobName = '{{ jobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND stepName = '{{ stepName }}'
AND subscriptionId = '{{ subscriptionId }}';