Job Executions - List By Agent

Reference

Service:: SQL Database

API Version:: 2021-11-01

Lists all executions in a job agent.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
jobAgentName	path	True	string	The name of the job agent.
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.
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.
$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.
createTimeMax	query		string date-time	If specified, only job executions created before the specified time are included.
createTimeMin	query		string date-time	If specified, only job executions created at or after the specified time are included.
endTimeMax	query		string date-time	If specified, only job executions completed before the specified time are included.
endTimeMin	query		string date-time	If specified, only job executions completed at or after the specified time are included.
isActive	query		boolean	If specified, only active or only completed job executions are included.

Responses

Name	Type	Description
200 OK	JobExecutionListResult	Successfully retrieved job executions.
Other Status Codes		* Error Responses: * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

Name

Type

Description

200 OK

JobExecutionListResult

Successfully retrieved job executions.

Other Status Codes

*** Error Responses: ***

404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

Examples

List all job executions in a job agent with filtering.

List all job executions in a job agent.

List all job executions in a job agent with filtering.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?createTimeMin=2017-03-21T19:00:00Z&createTimeMax=2017-03-21T19:05:00Z&endTimeMin=2017-03-21T19:20:00Z&endTimeMax=2017-03-21T19:25:00Z&isActive=False&api-version=2021-11-01


import java.time.OffsetDateTime;

/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgentWithFilter.
     * json
     */
    /**
     * Sample code: List all job executions in a job agent with filtering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listAllJobExecutionsInAJobAgentWithFiltering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1",
            OffsetDateTime.parse("2017-03-21T19:00:00Z"), OffsetDateTime.parse("2017-03-21T19:05:00Z"),
            OffsetDateTime.parse("2017-03-21T19:20:00Z"), OffsetDateTime.parse("2017-03-21T19:25:00Z"), false, null,
            null, com.azure.core.util.Context.NONE);
    }
}

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

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2"
}

List all job executions in a job agent.

Sample request

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?api-version=2021-11-01


/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgent.json
     */
    /**
     * Sample code: List all job executions in a job agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllJobExecutionsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1", null,
            null, null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

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

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2"
}

Definitions

Name	Description
JobExecution	An execution of a job
JobExecutionLifecycle	The detailed state of the job execution.
JobExecutionListResult	A list of job executions.
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

An execution of a job

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.createTime	string	The time that the job execution was created.
properties.currentAttemptStartTime	string	Start time of the current attempt.
properties.currentAttempts	integer	Number of times the job execution has been attempted.
properties.endTime	string	The time that the job execution completed.
properties.jobExecutionId	string	The unique identifier of the job execution.
properties.jobVersion	integer	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	The time that the job execution started.
properties.stepId	integer	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

The detailed state of the job execution.

Name	Type	Description
Canceled	string
Created	string
Failed	string
InProgress	string
Skipped	string
Succeeded	string
SucceededWithSkipped	string
TimedOut	string
WaitingForChildJobExecutions	string
WaitingForRetry	string

JobExecutionListResult

A list of job executions.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	JobExecution[]	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	JobTargetType	The type of the target.

JobTargetType

The type of the target.

Name	Type	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

ProvisioningState

The ARM provisioning state of the job execution.

Name	Type	Description
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	string

Share via

Job Executions - List By Agent

URI Parameters

Responses

Examples

List all job executions in a job agent with filtering.

Sample request

Sample response

List all job executions in a job agent.

Sample request

Sample response

Definitions

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Additional resources