Job Target Groups - List By Agent

Service:

SQL Database

API Version:

2021-11-01

Obtém todos os grupos de destino em um agente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
jobAgentName	path	True	string	O nome do agente de trabalho.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	JobTargetGroupListResult	Recuperou com êxito a lista de grupos de destino.
Other Status Codes		Respostas de erro: *** 404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.

Exemplos

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

Definições

Nome	Description
JobTarget	Um destino de trabalho, por exemplo, um banco de dados específico ou um contêiner de bancos de dados que é avaliado durante a execução do trabalho.
JobTargetGroup	Um grupo de destinos de trabalho.
JobTargetGroupListResult	Uma lista de grupos de destino.
JobTargetGroupMembershipType	Se o destino é incluído ou excluído do grupo.
JobTargetType	O tipo de destino.

JobTarget

Um destino de trabalho, por exemplo, um banco de dados específico ou um contêiner de bancos de dados que é avaliado durante a execução do trabalho.

Nome	Tipo	Valor padrão	Description
databaseName	string		O nome do banco de dados de destino.
elasticPoolName	string		O nome do pool elástico de destino.
membershipType	JobTargetGroupMembershipType	Include	Se o destino é incluído ou excluído do grupo.
refreshCredential	string		A ID do recurso da credencial usada durante a execução do trabalho para se conectar ao destino e determinar a lista de bancos de dados dentro do destino.
serverName	string		O nome do servidor de destino.
shardMapName	string		O mapa de fragmentos de destino.
type	JobTargetType		O tipo de destino.

JobTargetGroup

Um grupo de destinos de trabalho.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.members	JobTarget[]	Membros do grupo de destino.
type	string	Tipo de recurso.

JobTargetGroupListResult

Uma lista de grupos de destino.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	JobTargetGroup[]	Matriz de resultados.

JobTargetGroupMembershipType

Se o destino é incluído ou excluído do grupo.

Nome	Tipo	Description
Exclude	string
Include	string

JobTargetType

O tipo de destino.

Nome	Tipo	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string