Jobs - List By Agent

Service:

SQL Database

API Version:

2021-11-01

Gets a list of jobs.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs?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.

Responses

Name	Type	Description
200 OK	JobListResult	Successfully retrieved the list of jobs.
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 jobs in a job agent

Sample request

HTTP

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

Java

/**
 * Samples for Jobs ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobsByAgent.json
     */
    /**
     * Sample code: List jobs in a job agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobs().listByAgent("group1", "server1", "agent1",
            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": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
      "name": "job1",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "my favourite job",
        "version": 0,
        "schedule": {
          "startTime": "2015-09-24T18:30:01Z",
          "endTime": "2015-09-24T23:59:59Z",
          "type": "Recurring",
          "interval": "PT5M",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job3",
      "name": "job3",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will be scheduled once",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will never be automatically scheduled",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": false
        }
      }
    }
  ]
}

Definitions

Name	Description
Job	A job.
JobListResult	A list of jobs.
JobSchedule	Scheduling properties of a job.
JobScheduleType	Schedule interval type

Job

A job.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.description	string	User-defined description of the job.
properties.schedule	JobSchedule	Schedule properties of the job.
properties.version	integer	The job version number.
type	string	Resource type.

JobListResult

A list of jobs.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	Job[]	Array of results.

JobSchedule

Scheduling properties of a job.

Name	Type	Default value	Description
enabled	boolean		Whether or not the schedule is enabled.
endTime	string	9999-12-31T11:59:59+00:00	Schedule end time.
interval	string		Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
startTime	string	0001-01-01T00:00:00+00:00	Schedule start time.
type	JobScheduleType	Once	Schedule interval type

JobScheduleType

Schedule interval type

Name	Type	Description
Once	string
Recurring	string