Job Target Groups - List By Agent

Servizio:

SQL Database

Versione API:

2021-11-01

Ottiene tutti i gruppi di destinazione in un agente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
jobAgentName	path	True	string	Nome dell'agente di processo.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	JobTargetGroupListResult	È stato recuperato correttamente l'elenco dei gruppi di destinazione.
Other Status Codes		Risposte di errore: 404 JobAgentNotFound- L'agente di processo specificato non esiste nel server logico specificato. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.

Esempio

Get all target groups in an agent.

Esempio di richiesta

HTTP

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

Java

/**
 * Samples for JobTargetGroups ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobTargetGroups.json
     */
    /**
     * Sample code: Get all target groups in an agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAllTargetGroupsInAnAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetGroups().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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "properties": {
        "members": [
          {
            "membershipType": "Exclude",
            "type": "SqlDatabase",
            "serverName": "server1",
            "databaseName": "database1"
          },
          {
            "membershipType": "Include",
            "type": "SqlServer",
            "serverName": "server1",
            "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
          },
          {
            "membershipType": "Include",
            "type": "SqlElasticPool",
            "serverName": "server2",
            "elasticPoolName": "pool1",
            "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
          },
          {
            "membershipType": "Include",
            "type": "SqlShardMap",
            "serverName": "server3",
            "shardMapName": "shardMap1",
            "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
          }
        ]
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
      "name": "targetGroup1",
      "type": "Microsoft.Sql/servers/jobAgents/targetGroups"
    }
  ]
}

Definizioni

Nome	Descrizione
JobTarget	Destinazione di un processo, ad esempio un database specifico o un contenitore di database che viene valutato durante l'esecuzione del processo.
JobTargetGroup	Gruppo di destinazioni di processo.
JobTargetGroupListResult	Elenco di gruppi di destinazione.
JobTargetGroupMembershipType	Indica se la destinazione è inclusa o esclusa dal gruppo.
JobTargetType	Tipo di destinazione.

JobTarget

Object

Destinazione di un processo, ad esempio un database specifico o un contenitore di database che viene valutato durante l'esecuzione del processo.

Nome	Tipo	Valore predefinito	Descrizione
databaseName	string		Nome del database di destinazione.
elasticPoolName	string		Nome del pool elastico di destinazione.
membershipType	JobTargetGroupMembershipType	Include	Indica se la destinazione è inclusa o esclusa dal gruppo.
refreshCredential	string		ID risorsa delle credenziali usate durante l'esecuzione del processo per connettersi alla destinazione e determinare l'elenco di database all'interno della destinazione.
serverName	string		Nome del server di destinazione.
shardMapName	string		Mappa partizioni di destinazione.
type	JobTargetType		Tipo di destinazione.

JobTargetGroup

Object

Gruppo di destinazioni di processo.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.members	JobTarget[]	Membri del gruppo di destinazione.
type	string	Tipo di risorsa.

JobTargetGroupListResult

Object

Elenco di gruppi di destinazione.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per recuperare la pagina successiva dei risultati.
value	JobTargetGroup[]	Matrice di risultati.

JobTargetGroupMembershipType

Enumerazione

Indica se la destinazione è inclusa o esclusa dal gruppo.

Valore	Descrizione
Exclude
Include

JobTargetType

Enumerazione

Tipo di destinazione.

Valore	Descrizione
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup