Job Target Groups - List By Agent

Service:

SQL Database

API Version:

2021-11-01

Získá všechny cílové skupiny v agentu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
jobAgentName	path	True	string	Název agenta úloh.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager nebo z portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	JobTargetGroupListResult	Seznam cílových skupin se úspěšně načetl.
Other Status Codes		Chybové odpovědi: *** 404 JobAgentNotFound – Zadaný agent úlohy na zadaném logickém serveru neexistuje. 404 SubscriptionDoesNotHaveServer – požadovaný server nebyl nalezen. 404 ServerNotInSubscriptionResourceGroup – zadaný server neexistuje v zadané skupině prostředků a předplatném.

Příklady

Get all target groups in an agent.

Sample Request

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

import com.azure.core.util.Context;

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

Definice

Name	Description
JobTarget	Cíl úlohy, například konkrétní databáze nebo kontejner databází, který se vyhodnocuje během provádění úlohy.
JobTargetGroup	Skupina cílů úloh.
JobTargetGroupListResult	Seznam cílových skupin.
JobTargetGroupMembershipType	Určuje, jestli je cíl zahrnutý nebo vyloučený ze skupiny.
JobTargetType	Typ cíle.

JobTarget

Cíl úlohy, například konkrétní databáze nebo kontejner databází, který se vyhodnocuje během provádění úlohy.

Name	Typ	Výchozí hodnota	Description
databaseName	string		Název cílové databáze.
elasticPoolName	string		Název cílového elastického fondu.
membershipType	JobTargetGroupMembershipType	Include	Určuje, jestli je cíl zahrnutý nebo vyloučený ze skupiny.
refreshCredential	string		ID prostředku přihlašovacích údajů, které se používají při provádění úlohy pro připojení k cíli a určení seznamu databází v rámci cíle.
serverName	string		Název cílového serveru.
shardMapName	string		Mapa cílových horizontálních oddílů.
type	JobTargetType		Typ cíle.

JobTargetGroup

Skupina cílů úloh.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
properties.members	JobTarget[]	Členové cílové skupiny.
type	string	Typ prostředku.

JobTargetGroupListResult

Seznam cílových skupin.

Name	Typ	Description
nextLink	string	Odkaz na načtení další stránky výsledků
value	JobTargetGroup[]	Pole výsledků

JobTargetGroupMembershipType

Určuje, jestli je cíl zahrnutý nebo vyloučený ze skupiny.

Name	Typ	Description
Exclude	string
Include	string

JobTargetType

Typ cíle.

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