Job Step Executions - List By Job Execution
Lists the step executions 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?api-version=2023-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2023-08-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
job
|
path | True |
string |
The name of the job agent. |
|
job
|
path | True |
string (uuid) |
The id of the job execution |
|
job
|
path | True |
string |
The name of the job to get. |
|
resource
|
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. |
|
server
|
path | True |
string |
The name of the server. |
|
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
|
api-version
|
query | True |
string |
The API version to use for the request. |
|
$skip
|
query |
integer (int64) |
The number of elements in the collection to skip. |
|
|
$top
|
query |
integer (int64) |
The number of elements to return from the collection. |
|
|
create
|
query |
string (date-time) |
If specified, only job executions created before the specified time are included. |
|
|
create
|
query |
string (date-time) |
If specified, only job executions created at or after the specified time are included. |
|
|
end
|
query |
string (date-time) |
If specified, only job executions completed before the specified time are included. |
|
|
end
|
query |
string (date-time) |
If specified, only job executions completed at or after the specified time are included. |
|
|
is
|
query |
boolean |
If specified, only active or only completed job executions are included. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Successfully retrieved the step executions. |
|
| Other Status Codes |
*** Error Responses: ***
|
Examples
List job step executions
Sample request
Sample response
{
"value": [
{
"properties": {
"jobVersion": 1,
"stepName": "step1",
"stepId": 1,
"jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
"lifecycle": "Succeeded",
"provisioningState": "Succeeded",
"createTime": "2017-12-03T04:33:15.7189151Z",
"startTime": "2017-12-03T04:33:16.176937Z",
"endTime": "2017-12-03T04:33:19.0600862Z",
"currentAttempts": 1,
"currentAttemptStartTime": "2017-12-03T04: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 |
|---|---|
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Job |
An execution of a job |
|
Job |
The detailed state of the job execution. |
|
Job |
A list of job executions. |
|
Job |
The target that a job execution is executed on. |
|
Job |
The type of the target. |
|
Provisioning |
The ARM provisioning state of the job execution. |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info |
object |
The additional info. |
| type |
string |
The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
JobExecution
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 |
The detailed state of the job execution. |
|
| properties.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 |
The target that this execution is executed on. |
|
| type |
string |
Resource type. |
JobExecutionLifecycle
The detailed state of the job execution.
| Value | Description |
|---|---|
| Created | |
| InProgress | |
| WaitingForChildJobExecutions | |
| WaitingForRetry | |
| Succeeded | |
| SucceededWithSkipped | |
| Failed | |
| TimedOut | |
| Canceled | |
| Skipped |
JobExecutionListResult
A list of job executions.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
Link to retrieve next page of results. |
| value |
Array of results. |
JobExecutionTarget
The target that a job execution is executed on.
| Name | Type | Description |
|---|---|---|
| databaseName |
string |
The database name. |
| serverName |
string |
The server name. |
| type |
The type of the target. |
JobTargetType
The type of the target.
| Value | Description |
|---|---|
| TargetGroup | |
| SqlDatabase | |
| SqlElasticPool | |
| SqlShardMap | |
| SqlServer |
ProvisioningState
The ARM provisioning state of the job execution.
| Value | Description |
|---|---|
| Created | |
| InProgress | |
| Succeeded | |
| Failed | |
| Canceled |