Microsoft.Sql servers/jobAgents/jobs/steps 2020-02-02-preview

The servers/jobAgents/jobs/steps resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Sql/servers/jobAgents/jobs/steps resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2020-02-02-preview' = {
  name: 'string'
  properties: {
    action: {
      source: 'string'
      type: 'string'
      value: 'string'
    }
    credential: 'string'
    executionOptions: {
      initialRetryIntervalSeconds: int
      maximumRetryIntervalSeconds: int
      retryAttempts: int
      retryIntervalBackoffMultiplier: int
      timeoutSeconds: int
    }
    output: {
      credential: 'string'
      databaseName: 'string'
      resourceGroupName: 'string'
      schemaName: 'string'
      serverName: 'string'
      subscriptionId: 'string'
      tableName: 'string'
      type: 'string'
    }
    stepId: int
    targetGroup: 'string'
  }
}

Property values

servers/jobAgents/jobs/steps

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Sql/servers/jobAgents/jobs/steps'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-02-02-preview'
name The resource name string (required)

See how to set names and types for child resources in Bicep or JSON ARM templates.
properties Properties of a job step. JobStepProperties

JobStepProperties

Name Description Value
action The action to be executed by a job step. JobStepAction (required)
credential The resource ID of the job credential that will be used to connect to the targets. string (required)
executionOptions The execution options of a job step. JobStepExecutionOptions
output The output configuration of a job step. JobStepOutput
stepId The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. int
targetGroup The resource ID of the target group that the job step will be executed on. string (required)

JobStepAction

Name Description Value
source The source of the action to execute. 'Inline'
type Type of action being executed by the job step. 'TSql'
value The action value, for example the text of the T-SQL script to execute. string (required)

JobStepExecutionOptions

Name Description Value
initialRetryIntervalSeconds Initial delay between retries for job step execution. int
maximumRetryIntervalSeconds The maximum amount of time to wait between retries for job step execution. int
retryAttempts Maximum number of times the job step will be reattempted if the first attempt fails. int
retryIntervalBackoffMultiplier The backoff multiplier for the time between retries. int
timeoutSeconds Execution timeout for the job step. int

JobStepOutput

Name Description Value
credential The resource ID of the credential to use to connect to the output destination. string (required)
databaseName The output destination database. string (required)
resourceGroupName The output destination resource group. string
schemaName The output destination schema. string
serverName The output destination server name. string (required)
subscriptionId The output destination subscription id. string
tableName The output destination table. string (required)
type The output destination type. 'SqlDatabase'