Microsoft.Sql servers/jobAgents/jobs/steps
Bicep resource definition
The servers/jobAgents/jobs/steps resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/jobAgents/jobs/steps resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
action: {
source: 'Inline'
type: 'TSql'
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: 'SqlDatabase'
}
stepId: int
targetGroup: 'string'
}
}
Property values
servers/jobAgents/jobs/steps
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: jobs |
| properties | Resource properties. | JobStepProperties |
JobStepProperties
| Name | Description | Value |
|---|---|---|
| action | The action payload of the job step. | JobStepAction (required) |
| credential | The resource ID of the job credential that will be used to connect to the targets. | string |
| executionOptions | Execution options for the job step. | JobStepExecutionOptions |
| output | Output destination properties of the 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 |
| 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 Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tableName | The output destination table. | string (required) |
| type | The output destination type. | 'SqlDatabase' |
ARM template resource definition
The servers/jobAgents/jobs/steps resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/jobAgents/jobs/steps resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"action": {
"source": "Inline",
"type": "TSql",
"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": "SqlDatabase"
},
"stepId": "int",
"targetGroup": "string"
}
}
Property values
servers/jobAgents/jobs/steps
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/servers/jobAgents/jobs/steps' |
| apiVersion | The resource api version | '2023-05-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Resource properties. | JobStepProperties |
JobStepProperties
| Name | Description | Value |
|---|---|---|
| action | The action payload of the job step. | JobStepAction (required) |
| credential | The resource ID of the job credential that will be used to connect to the targets. | string |
| executionOptions | Execution options for the job step. | JobStepExecutionOptions |
| output | Output destination properties of the 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 |
| 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 Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tableName | The output destination table. | string (required) |
| type | The output destination type. | 'SqlDatabase' |
Terraform (AzAPI provider) resource definition
The servers/jobAgents/jobs/steps resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/jobAgents/jobs/steps resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/jobAgents/jobs/steps@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
action = {
source = "Inline"
type = "TSql"
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 = "SqlDatabase"
}
stepId = int
targetGroup = "string"
}
})
}
Property values
servers/jobAgents/jobs/steps
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/servers/jobAgents/jobs/steps@2023-05-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: jobs |
| properties | Resource properties. | JobStepProperties |
JobStepProperties
| Name | Description | Value |
|---|---|---|
| action | The action payload of the job step. | JobStepAction (required) |
| credential | The resource ID of the job credential that will be used to connect to the targets. | string |
| executionOptions | Execution options for the job step. | JobStepExecutionOptions |
| output | Output destination properties of the 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 |
| 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 Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tableName | The output destination table. | string (required) |
| type | The output destination type. | "SqlDatabase" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for