Job Target Groups - List By Agent

Servicio:

SQL Database

Versión de la API:

2021-11-01

Obtiene todos los grupos de destino de un 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 identificador URI

Nombre	En	Requerido	Tipo	Description
jobAgentName	path	True	string	Nombre del agente de trabajo.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	JobTargetGroupListResult	Recuperó correctamente la lista de grupos de destino.
Other Status Codes		Respuestas de error: *** 404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Ejemplos

Get all target groups in an agent.

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
JobTarget	Un destino de trabajo, por ejemplo, una base de datos específica o un contenedor de bases de datos que se evalúan durante la ejecución del trabajo.
JobTargetGroup	Un grupo de destinos de trabajo.
JobTargetGroupListResult	Lista de grupos de destino.
JobTargetGroupMembershipType	Si el destino está incluido o excluido del grupo.
JobTargetType	Tipo de destino.

JobTarget

Un destino de trabajo, por ejemplo, una base de datos específica o un contenedor de bases de datos que se evalúan durante la ejecución del trabajo.

Nombre	Tipo	Valor predeterminado	Description
databaseName	string		Nombre de la base de datos de destino.
elasticPoolName	string		Nombre del grupo elástico de destino.
membershipType	JobTargetGroupMembershipType	Include	Si el destino está incluido o excluido del grupo.
refreshCredential	string		Identificador de recurso de la credencial que se usa durante la ejecución del trabajo para conectarse al destino y determinar la lista de bases de datos dentro del destino.
serverName	string		Nombre del servidor de destino.
shardMapName	string		Mapa de particiones de destino.
type	JobTargetType		Tipo de destino.

JobTargetGroup

Un grupo de destinos de trabajo.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.members	JobTarget[]	Miembros del grupo de destino.
type	string	Tipo de recurso.

JobTargetGroupListResult

Lista de grupos de destino.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	JobTargetGroup[]	Matriz de resultados.

JobTargetGroupMembershipType

Si el destino está incluido o excluido del grupo.

Nombre	Tipo	Description
Exclude	string
Include	string

JobTargetType

Tipo de destino.

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