Job Target Groups - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a target group.

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

URI Parameters

Name	In	Required	Type	Description
jobAgentName	path	True	string	The name of the job agent.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
targetGroupName	path	True	string	The name of the target group.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	JobTargetGroup	Successfully retrieved the target group.
Other Status Codes		*** Error Responses: *** 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

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

Definitions

Name	Description
JobTarget	A job target, for example a specific database or a container of databases that is evaluated during job execution.
JobTargetGroup	A group of job targets.
JobTargetGroupMembershipType	Whether the target is included or excluded from the group.
JobTargetType	The target type.

JobTarget

A job target, for example a specific database or a container of databases that is evaluated during job execution.

Name	Type	Default Value	Description
databaseName	string		The target database name.
elasticPoolName	string		The target elastic pool name.
membershipType	JobTargetGroupMembershipType	Include	Whether the target is included or excluded from the group.
refreshCredential	string		The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target.
serverName	string		The target server name.
shardMapName	string		The target shard map.
type	JobTargetType		The target type.

JobTargetGroup

A group of job targets.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.members	JobTarget[]	Members of the target group.
type	string	Resource type.

JobTargetGroupMembershipType

Whether the target is included or excluded from the group.

Name	Type	Description
Exclude	string
Include	string

JobTargetType

The target type.

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