Job Target Groups - Get

Servicio:

SQL Database

Versión de la API:

2021-11-01

Obtiene un 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 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.
targetGroupName	path	True	string	Nombre del grupo de destino.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	JobTargetGroup	Recuperó correctamente el grupo 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. 404 ResourceNotFound: no se encontró el recurso solicitado.

Ejemplos

Get a target group.

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/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

Respuesta de muestra

status code:

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

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.
JobTargetGroupMembershipType	Si el destino está incluido o excluido del grupo.
JobTargetType	Tipo de destino.

JobTarget

Object

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

Object

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.

JobTargetGroupMembershipType

Enumeration

Si el destino está incluido o excluido del grupo.

Valor	Description
Exclude
Include

JobTargetType

Enumeration

Tipo de destino.

Valor	Description
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup