Share via

Job Target Executions - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a target execution.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets/{targetId}?api-version=2021-11-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.
targetId
 path True

string (uuid)

The target id.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

JobExecution

Successfully retrieved the target execution.
Other Status Codes

*** Error Responses: ***

  • 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.

  • 404 ResourceNotFound - The requested resource was not found.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 ResourceNotFound - The requested resource was not found.

Examples

Get a job step target execution

Sample request

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/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee?api-version=2021-11-01

Sample response

Status code:
200 
{
  "properties": {
    "jobVersion": 1,
    "stepName": "step1",
    "stepId": 1,
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    "lifecycle": "Succeeded",
    "provisioningState": "Succeeded",
    "createTime": "2017-11-05T04:33:17.5133333Z",
    "startTime": "2017-11-05T04:33:18.1230403Z",
    "endTime": "2017-11-05T04:33:18.7031029Z",
    "currentAttempts": 1,
    "currentAttemptStartTime": "2017-11-05T04:33:18.2391013Z",
    "lastMessage": "Step 1 succeeded execution on target (server 'server1', database 'database1').",
    "target": {
      "type": "SqlDatabase",
      "serverName": "server1",
      "databaseName": "database1"
    }
  },
  "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/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets"
}

Definitions

Name Description
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.

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
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

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
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeration

The ARM provisioning state of the job execution.

Value Description
Canceled
Created
Failed
InProgress
Succeeded