Job Target Groups - List By Agent

Usługa:

SQL Database

Wersja interfejsu API:

2021-11-01

Pobiera wszystkie grupy docelowe w agencie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
jobAgentName	path	True	string	Nazwa agenta zadania.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	JobTargetGroupListResult	Pomyślnie pobrano listę grup docelowych.
Other Status Codes		Odpowiedzi na błędy: *** 404 JobAgentNotFound — określony agent zadania nie istnieje na określonym serwerze logicznym. 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

Przykłady

Get all target groups in an agent.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
JobTarget	Obiekt docelowy zadania, na przykład określoną bazę danych lub kontener baz danych, które są oceniane podczas wykonywania zadania.
JobTargetGroup	Grupa obiektów docelowych zadań.
JobTargetGroupListResult	Lista grup docelowych.
JobTargetGroupMembershipType	Określa, czy element docelowy jest uwzględniony, czy wykluczony z grupy.
JobTargetType	Typ docelowy.

JobTarget

Obiekt docelowy zadania, na przykład określoną bazę danych lub kontener baz danych, które są oceniane podczas wykonywania zadania.

Nazwa	Typ	Domyślna wartość	Opis
databaseName	string		Docelowa nazwa bazy danych.
elasticPoolName	string		Docelowa nazwa elastycznej puli.
membershipType	JobTargetGroupMembershipType	Include	Określa, czy element docelowy jest uwzględniony, czy wykluczony z grupy.
refreshCredential	string		Identyfikator zasobu poświadczenia używanego podczas wykonywania zadania w celu nawiązania połączenia z obiektem docelowym i określenia listy baz danych wewnątrz obiektu docelowego.
serverName	string		Nazwa serwera docelowego.
shardMapName	string		Docelowa mapa fragmentów.
type	JobTargetType		Typ docelowy.

JobTargetGroup

Grupa obiektów docelowych zadań.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.members	JobTarget[]	Członkowie grupy docelowej.
type	string	Typ zasobu.

JobTargetGroupListResult

Lista grup docelowych.

Nazwa	Typ	Opis
nextLink	string	Link, aby pobrać następną stronę wyników.
value	JobTargetGroup[]	Tablica wyników.

JobTargetGroupMembershipType

Określa, czy element docelowy jest uwzględniony, czy wykluczony z grupy.

Nazwa	Typ	Opis
Exclude	string
Include	string

JobTargetType

Typ docelowy.

Nazwa	Typ	Opis
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string