Job Steps - Create Or Update

Service:: SQL Database

API Version:: 2023-08-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
jobAgentName	path	True	string	The name of the job agent.
jobName	path	True	string	The name of the job.
resourceGroupName	path	True	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	path	True	string	The name of the server.
stepName	path	True	string	The name of the job step.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Required	Type	Description
properties.action	True	JobStepAction	The action payload of the job step.
properties.targetGroup	True	string	The resource ID of the target group that the job step will be executed on.
properties.credential		string	The resource ID of the job credential that will be used to connect to the targets.
properties.executionOptions		JobStepExecutionOptions	Execution options for the job step.
properties.output		JobStepOutput	Output destination properties of the job step.
properties.stepId		integer (int32)	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.

Responses

Name	Type	Description
200 OK	JobStep	Successfully updated the job step.
201 Created	JobStep	Successfully added the job step.
Other Status Codes	ErrorResponse	* Error Responses: * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 400 JobStepIdMismatch - Step Id in the specified Job Step URI does not match step id in provided Job Step Resource. 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid. 400 InvalidResourceId - Invalid resource identifier. 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url. 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url. 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url. 400 MismatchingJobAccountNameWithUrl - The provided job account name did not match the name in the Url. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server. 404 ResourceNotFound - The requested resource was not found. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found

Name

Type

Description

200 OK

JobStep

Successfully updated the job step.

201 Created

JobStep

Successfully added the job step.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
400 JobStepIdMismatch - Step Id in the specified Job Step URI does not match step id in provided Job Step Resource.
400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.
400 InvalidResourceId - Invalid resource identifier.
400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.
400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.
400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.
400 MismatchingJobAccountNameWithUrl - The provided job account name did not match the name in the Url.
400 ElasticJobsOperationFailed - Elastic jobs management operation failed.
400 ElasticJobsOperationFailed - Elastic jobs management operation failed.
400 ElasticJobsOperationFailed - Elastic jobs management operation failed.
404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.
404 ResourceNotFound - The requested resource was not found.
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found

Examples

Create or update a job step with all properties specified.

Create or update a job step with minimal properties specified.

Create or update a job step with all properties specified.

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1?api-version=2023-08-01

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "output": {
      "type": "SqlDatabase",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "resourceGroupName": "group3",
      "serverName": "server3",
      "databaseName": "database3",
      "schemaName": "myschema1234",
      "tableName": "mytable5678",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
    },
    "executionOptions": {
      "timeoutSeconds": 1234,
      "retryAttempts": 42,
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryIntervalBackoffMultiplier": 3
    }
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobStepMax.json
// this example is just showing the usage of "JobSteps_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobStepResource created on azure
// for more information of creating SqlServerJobStepResource, please refer to the document of SqlServerJobStepResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
string stepName = "step1";
ResourceIdentifier sqlServerJobStepResourceId = SqlServerJobStepResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName, stepName);
SqlServerJobStepResource sqlServerJobStep = client.GetSqlServerJobStepResource(sqlServerJobStepResourceId);

// invoke the operation
SqlServerJobStepData data = new SqlServerJobStepData
{
    StepId = 1,
    TargetGroup = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    Credential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    Action = new JobStepAction("select 2")
    {
        ActionType = JobStepActionType.TSql,
        Source = JobStepActionSource.Inline,
    },
    Output = new JobStepOutput("server3", "database3", "mytable5678")
    {
        OutputType = JobStepOutputType.SqlDatabase,
        SubscriptionId = Guid.Parse("3501b905-a848-4b5d-96e8-b253f62d735a"),
        ResourceGroupName = "group3",
        SchemaName = "myschema1234",
        Credential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    },
    ExecutionOptions = new JobStepExecutionOptions
    {
        TimeoutSeconds = 1234,
        RetryAttempts = 42,
        InitialRetryIntervalSeconds = 11,
        MaximumRetryIntervalSeconds = 222,
        RetryIntervalBackoffMultiplier = 3,
    },
};
ArmOperation<SqlServerJobStepResource> lro = await sqlServerJobStep.UpdateAsync(WaitUntil.Completed, data);
SqlServerJobStepResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobStepData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "output": {
      "type": "SqlDatabase",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "resourceGroupName": "group3",
      "serverName": "server3",
      "databaseName": "database3",
      "schemaName": "myschema1234",
      "tableName": "mytable5678",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
    },
    "executionOptions": {
      "timeoutSeconds": 1234,
      "retryAttempts": 42,
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryIntervalBackoffMultiplier": 3
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Status code:: 201

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "output": {
      "type": "SqlDatabase",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "resourceGroupName": "group3",
      "serverName": "server3",
      "databaseName": "database3",
      "schemaName": "myschema1234",
      "tableName": "mytable5678",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
    },
    "executionOptions": {
      "timeoutSeconds": 1234,
      "retryAttempts": 42,
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryIntervalBackoffMultiplier": 3
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Create or update a job step with minimal properties specified.

Sample request

HTTP
dotnet

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1?api-version=2023-08-01

{
  "properties": {
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "action": {
      "value": "select 1"
    }
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobStepMin.json
// this example is just showing the usage of "JobSteps_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobStepResource created on azure
// for more information of creating SqlServerJobStepResource, please refer to the document of SqlServerJobStepResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
string stepName = "step1";
ResourceIdentifier sqlServerJobStepResourceId = SqlServerJobStepResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName, stepName);
SqlServerJobStepResource sqlServerJobStep = client.GetSqlServerJobStepResource(sqlServerJobStepResourceId);

// invoke the operation
SqlServerJobStepData data = new SqlServerJobStepData
{
    TargetGroup = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    Action = new JobStepAction("select 1"),
};
ArmOperation<SqlServerJobStepResource> lro = await sqlServerJobStep.UpdateAsync(WaitUntil.Completed, data);
SqlServerJobStepResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobStepData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Status code:: 201

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
JobStep	A job step.
JobStepAction	The action to be executed by a job step.
JobStepActionSource	The source of the action to execute.
JobStepActionType	Type of action being executed by the job step.
JobStepExecutionOptions	The execution options of a job step.
JobStepOutput	The output configuration of a job step.
JobStepOutputType	The output destination type.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

JobStep

Object

A job step.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.action	JobStepAction	The action payload of the job step.
properties.credential	string	The resource ID of the job credential that will be used to connect to the targets.
properties.executionOptions	JobStepExecutionOptions	Execution options for the job step.
properties.output	JobStepOutput	Output destination properties of the job step.
properties.stepId	integer (int32)	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.
properties.targetGroup	string	The resource ID of the target group that the job step will be executed on.
type	string	Resource type.

JobStepAction

Object

The action to be executed by a job step.

Name	Type	Default value	Description
source	JobStepActionSource	Inline	The source of the action to execute.
type	JobStepActionType	TSql	Type of action being executed by the job step.
value	string		The action value, for example the text of the T-SQL script to execute.

JobStepActionSource

Enumeration

The source of the action to execute.

Value	Description
Inline

JobStepActionType

Enumeration

Type of action being executed by the job step.

Value	Description
TSql

JobStepExecutionOptions

Object

The execution options of a job step.

Name	Type	Default value	Description
initialRetryIntervalSeconds	integer (int32)	1	Initial delay between retries for job step execution.
maximumRetryIntervalSeconds	integer (int32)	120	The maximum amount of time to wait between retries for job step execution.
retryAttempts	integer (int32)	10	Maximum number of times the job step will be reattempted if the first attempt fails.
retryIntervalBackoffMultiplier	number (float)	2	The backoff multiplier for the time between retries.
timeoutSeconds	integer (int32)	43200	Execution timeout for the job step.

JobStepOutput

Object

The output configuration of a job step.

Name	Type	Default value	Description
credential	string		The resource ID of the credential to use to connect to the output destination.
databaseName	string		The output destination database.
resourceGroupName	string		The output destination resource group.
schemaName	string	dbo	The output destination schema.
serverName	string		The output destination server name.
subscriptionId	string (uuid)		The output destination subscription id.
tableName	string		The output destination table.
type	JobStepOutputType	SqlDatabase	The output destination type.

JobStepOutputType

Enumeration

The output destination type.

Value	Description
SqlDatabase

Share via

Job Steps - Create Or Update

URI Parameters

Request Body

Responses

Examples

Create or update a job step with all properties specified.

Sample request

Sample response

Create or update a job step with minimal properties specified.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepOutput

JobStepOutputType