Job Step Executions - Get

Service:

SQL Database

API Version:

2023-08-01

Gets a step execution of a job execution.

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

URI Parameters

Name	In	Required	Type	Description
jobAgentName	path	True	string	The name of the job agent.
jobExecutionId	path	True	string (uuid)	The unique id of the job execution
jobName	path	True	string	The name of the job to get.
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 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.

Responses

Name	Type	Description
200 OK	JobExecution	Successfully retrieved the step execution.
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 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 404 ResourceNotFound - The requested resource was not found.

Examples

Get a job step execution

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5A86BF65-43AC-F258-2524-9E92992F97CA/steps/step1?api-version=2023-08-01

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetJobExecutionStep.json
// this example is just showing the usage of "JobStepExecutions_Get" 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 SqlServerJobExecutionStepResource created on azure
// for more information of creating SqlServerJobExecutionStepResource, please refer to the document of SqlServerJobExecutionStepResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
Guid jobExecutionId = Guid.Parse("5A86BF65-43AC-F258-2524-9E92992F97CA");
string stepName = "step1";
ResourceIdentifier sqlServerJobExecutionStepResourceId = SqlServerJobExecutionStepResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName, jobExecutionId, stepName);
SqlServerJobExecutionStepResource sqlServerJobExecutionStep = client.GetSqlServerJobExecutionStepResource(sqlServerJobExecutionStepResourceId);

// invoke the operation
SqlServerJobExecutionStepResource result = await sqlServerJobExecutionStep.GetAsync();

// 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
SqlServerJobExecutionData 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": {
    "jobVersion": 1,
    "stepName": "step1",
    "stepId": 1,
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    "lifecycle": "Succeeded",
    "provisioningState": "Succeeded",
    "createTime": "2017-12-27T04:33:15.7189151Z",
    "startTime": "2017-12-27T04:33:16.176937Z",
    "endTime": "2017-12-27T04:33:19.0600862Z",
    "currentAttempts": 1,
    "currentAttemptStartTime": "2017-12-27T04:33:17.4840068Z",
    "lastMessage": "Step 1 succeeded."
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
JobExecution	An execution of a job
JobExecutionLifecycle	The detailed state of the job execution.
JobExecutionTarget	The target that a job execution is executed on.
JobTargetType	The type of the target.
ProvisioningState	The ARM provisioning state of the job execution.

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.

JobExecution

Object

An execution of a job

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.createTime	string (date-time)	The time that the job execution was created.
properties.currentAttemptStartTime	string (date-time)	Start time of the current attempt.
properties.currentAttempts	integer (int32)	Number of times the job execution has been attempted.
properties.endTime	string (date-time)	The time that the job execution completed.
properties.jobExecutionId	string (uuid)	The unique identifier of the job execution.
properties.jobVersion	integer (int32)	The job version number.
properties.lastMessage	string	The last status or error message.
properties.lifecycle	JobExecutionLifecycle	The detailed state of the job execution.
properties.provisioningState	ProvisioningState	The ARM provisioning state of the job execution.
properties.startTime	string (date-time)	The time that the job execution started.
properties.stepId	integer (int32)	The job step id.
properties.stepName	string	The job step name.
properties.target	JobExecutionTarget	The target that this execution is executed on.
type	string	Resource type.

JobExecutionLifecycle

Enumeration

The detailed state of the job execution.

Value	Description
Created
InProgress
WaitingForChildJobExecutions
WaitingForRetry
Succeeded
SucceededWithSkipped
Failed
TimedOut
Canceled
Skipped

JobExecutionTarget

Object

The target that a job execution is executed on.

Name	Type	Description
databaseName	string	The database name.
serverName	string	The server name.
type	JobTargetType	The type of the target.

JobTargetType

Enumeration

The type of the target.

Value	Description
TargetGroup
SqlDatabase
SqlElasticPool
SqlShardMap
SqlServer

ProvisioningState

Enumeration

The ARM provisioning state of the job execution.

Value	Description
Created
InProgress
Succeeded
Failed
Canceled