Jobs - List By Agent

Service:

SQL Database

API Version:

2021-11-01

Obtient une liste de travaux.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
jobAgentName	path	True	string	Nom de l’agent de travail.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	JobListResult	La liste des travaux a été récupérée avec succès.
Other Status Codes		Réponses d’erreur : *** 404 JobAgentNotFound : l’agent de travail spécifié n’existe pas dans le serveur logique spécifié. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Exemples

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

import com.azure.core.util.Context;

/** 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", 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
        }
      }
    }
  ]
}

Définitions

Nom	Description
Job	Un travail.
JobListResult	Liste des travaux.
JobSchedule	Propriétés de planification d’un travail.
JobScheduleType	Type d’intervalle de planification

Job

Un travail.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.description	string	Description définie par l’utilisateur du travail.
properties.schedule	JobSchedule	Planifier les propriétés du travail.
properties.version	integer	Numéro de version du travail.
type	string	Type de ressource.

JobListResult

Liste des travaux.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	Job[]	Tableau de résultats.

JobSchedule

Propriétés de planification d’un travail.

Nom	Type	Valeur par défaut	Description
enabled	boolean		Indique si la planification est activée ou non.
endTime	string	9999-12-31T11:59:59+00:00	Planifiez l’heure de fin.
interval	string		Valeur de l’intervalle périodique de la planification, si scheduleType est périodique. ISO8601 format de durée.
startTime	string	0001-01-01T00:00:00+00:00	Planifier l’heure de début.
type	JobScheduleType	Once	Type d’intervalle de planification

JobScheduleType

Type d’intervalle de planification

Nom	Type	Description
Once	string
Recurring	string