Job Agents - List By Server

Service:

SQL Database

API Version:

2021-11-01

Obtient une liste d’agents de travail dans un serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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	JobAgentListResult	La liste des agents de travail a été récupérée.
Other Status Codes		Réponses d’erreur : *** 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. 409 ServerDisabled : le serveur est désactivé.

Exemples

List job agents in a server

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for JobAgents ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobAgentsByServer.json
     */
    /**
     * Sample code: List job agents in a server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobAgentsInAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobAgents().listByServer("group1", "server1", 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",
      "name": "agent1",
      "type": "Microsoft.Sql/servers/jobAgents",
      "location": "southeastasia",
      "sku": {
        "name": "Agent",
        "capacity": 200
      },
      "properties": {
        "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/jobAgent2",
      "name": "jobAgent2",
      "type": "Microsoft.Sql/servers/jobAgents",
      "location": "southeastasia",
      "sku": {
        "name": "Agent",
        "capacity": 400
      },
      "properties": {
        "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db12"
      }
    }
  ]
}

Définitions

Nom	Description
JobAgent	Agent de travail Azure SQL.
JobAgentListResult	Liste des agents de travail Azure SQL.
JobAgentState	État de l’agent de travail.
Sku	Référence SKU de ressource ARM.

JobAgent

Agent de travail Azure SQL.

Nom	Type	Description
id	string	ID de la ressource
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.databaseId	string	ID de ressource de la base de données dans laquelle stocker les métadonnées de travail.
properties.state	JobAgentState	État de l’agent de travail.
sku	Sku	Nom et niveau de la référence SKU.
tags	object	Balises de ressource.
type	string	Type de ressource.

JobAgentListResult

Liste des agents de travail Azure SQL.

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

JobAgentState

État de l’agent de travail.

Nom	Type	Description
Creating	string
Deleting	string
Disabled	string
Ready	string
Updating	string

Sku

Référence SKU de ressource ARM.

Nom	Type	Description
capacity	integer	Capacité de la référence SKU particulière.
family	string	Si le service a différentes générations de matériel, pour la même référence SKU, cela peut être capturé ici.
name	string	Nom de la référence SKU, généralement une lettre + un code numérique, par exemple P3.
size	string	Taille de la référence SKU particulière
tier	string	Niveau ou édition de la référence SKU particulière, par exemple De base, Premium.