Job Target Groups - Get

Serviço:

SQL Database

Versão da API:

2021-11-01

Obtém um grupo de destino.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
jobAgentName	path	True	string	O nome do agente de tarefas.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
targetGroupName	path	True	string	O nome do grupo de destino.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	JobTargetGroup	O grupo de destino foi obtido com êxito.
Other Status Codes		Respostas de Erro: *** 404 JobAgentNotFound – o agente de tarefa especificado não existe no servidor lógico especificado. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados. 404 ResourceNotFound – o recurso pedido não foi encontrado.

Exemplos

Get a target group.

Pedido de amostra

HTTP

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

Java

/**
 * Samples for JobTargetGroups Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetJobTargetGroup.json
     */
    /**
     * Sample code: Get a target group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getATargetGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetGroups().getWithResponse("group1", "server1", "agent1",
            "targetGroup1", 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

Resposta da amostra

Código de estado:

200

{
  "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

Name	Description
JobTarget	Um destino de tarefa, por exemplo, uma base de dados específica ou um contentor de bases de dados que é avaliado durante a execução da tarefa.
JobTargetGroup	Um grupo de destinos de trabalho.
JobTargetGroupMembershipType	Se o destino está incluído ou excluído do grupo.
JobTargetType	O tipo de destino.

JobTarget

Um destino de tarefa, por exemplo, uma base de dados específica ou um contentor de bases de dados que é avaliado durante a execução da tarefa.

Name	Tipo	Default value	Description
databaseName	string		O nome da base de dados de destino.
elasticPoolName	string		O nome do conjunto elástico de destino.
membershipType	JobTargetGroupMembershipType	Include	Se o destino está incluído ou excluído do grupo.
refreshCredential	string		O ID de recurso da credencial utilizada durante a execução da tarefa para ligar ao destino e determinar a lista de bases de dados dentro do destino.
serverName	string		O nome do servidor de destino.
shardMapName	string		O mapa de partições horizontais de destino.
type	JobTargetType		O tipo de destino.

JobTargetGroup

Um grupo de destinos de trabalho.

Name	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.

JobTargetGroupMembershipType

Se o destino está incluído ou excluído do grupo.

Name	Tipo	Description
Exclude	string
Include	string

JobTargetType

O tipo de destino.

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