Job Target Groups - Get

Service:

SQL Database

API Version:

2021-11-01

Возвращает целевую группу.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
jobAgentName	path	True	string	Имя агента задания.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
targetGroupName	path	True	string	Имя целевой группы.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	JobTargetGroup	Целевая группа успешно получена.
Other Status Codes		Ответы на ошибки: *** 404 JobAgentNotFound — указанный агент задания не существует на указанном логическом сервере. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

Get a target group.

Sample Request

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

import com.azure.core.util.Context;

/** 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", 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

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

Определения

Имя	Описание
JobTarget	Целевой объект задания, например конкретная база данных или контейнер баз данных, который вычисляется во время выполнения задания.
JobTargetGroup	Группа целевых объектов заданий.
JobTargetGroupMembershipType	Указывает, включен ли целевой объект в группу или исключен из нее.
JobTargetType	Тип целевого объекта.

JobTarget

Целевой объект задания, например конкретная база данных или контейнер баз данных, который вычисляется во время выполнения задания.

Имя	Тип	Значение по умолчанию	Описание
databaseName	string		Имя целевой базы данных.
elasticPoolName	string		Имя целевого эластичного пула.
membershipType	JobTargetGroupMembershipType	Include	Указывает, включен ли целевой объект в группу или исключен из нее.
refreshCredential	string		Идентификатор ресурса учетных данных, используемых во время выполнения задания для подключения к целевому объекту и определения списка баз данных в целевом объекте.
serverName	string		Имя целевого сервера.
shardMapName	string		Карта целевого сегмента.
type	JobTargetType		Тип целевого объекта.

JobTargetGroup

Группа целевых объектов заданий.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.members	JobTarget[]	Члены целевой группы.
type	string	Тип ресурса.

JobTargetGroupMembershipType

Указывает, включен ли целевой объект в группу или исключен из нее.

Имя	Тип	Описание
Exclude	string
Include	string

JobTargetType

Тип целевого объекта.

Имя	Тип	Описание
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string