Job Target Groups - List By Agent

Dienst:

SQL Database

API-Version:

2021-11-01

Ruft alle Zielgruppen in einem Agent ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobAgentName	path	True	string	Der Name des Auftrags-Agents.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	JobTargetGroupListResult	Die Liste der Zielgruppen wurde erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 404 JobAgentNotFound: Der angegebene Auftrags-Agent ist auf dem angegebenen logischen Server nicht vorhanden. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden. 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

Beispiele

Get all target groups in an agent.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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"
    }
  ]
}

Definitionen

Name	Beschreibung
JobTarget	Ein Auftragsziel, z. B. eine bestimmte Datenbank oder ein Container mit Datenbanken, die während der Auftragsausführung ausgewertet werden.
JobTargetGroup	Eine Gruppe von Auftragszielen.
JobTargetGroupListResult	Eine Liste der Zielgruppen.
JobTargetGroupMembershipType	Gibt an, ob das Ziel in die Gruppe eingeschlossen oder ausgeschlossen wird.
JobTargetType	Der Zieltyp.

JobTarget

Ein Auftragsziel, z. B. eine bestimmte Datenbank oder ein Container mit Datenbanken, die während der Auftragsausführung ausgewertet werden.

Name	Typ	Standardwert	Beschreibung
databaseName	string		Der Name der Zieldatenbank.
elasticPoolName	string		Der Name des Zielpools für elastische Datenbanken.
membershipType	JobTargetGroupMembershipType	Include	Gibt an, ob das Ziel in die Gruppe eingeschlossen oder ausgeschlossen wird.
refreshCredential	string		Die Ressourcen-ID der Anmeldeinformationen, die während der Auftragsausführung verwendet werden, um eine Verbindung mit dem Ziel herzustellen und die Liste der Datenbanken innerhalb des Ziels zu ermitteln.
serverName	string		Der Name des Zielservers.
shardMapName	string		Die Zielshardzuordnung.
type	JobTargetType		Der Zieltyp.

JobTargetGroup

Eine Gruppe von Auftragszielen.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.members	JobTarget[]	Mitglieder der Zielgruppe.
type	string	Der Ressourcentyp.

JobTargetGroupListResult

Eine Liste der Zielgruppen.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Ergebnisseite.
value	JobTargetGroup[]	Array von Ergebnissen.

JobTargetGroupMembershipType

Gibt an, ob das Ziel in die Gruppe eingeschlossen oder ausgeschlossen wird.

Name	Typ	Beschreibung
Exclude	string
Include	string

JobTargetType

Der Zieltyp.

Name	Typ	Beschreibung
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string