Job Target Groups - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Creates or updates a target group.

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

Request Body

Name	Required	Type	Description
properties.members	True	JobTarget[]	Members of the target group.

Responses

Name	Type	Description
200 OK	JobTargetGroup	Successfully updated the target group.
201 Created	JobTargetGroup	Successfully created the target group.
Other Status Codes		*** Error Responses: *** 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid. 400 InvalidResourceId - Invalid resource identifier. 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url. 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url. 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url. 400 MismatchingJobAccountNameWithUrl - The provided job account name did not match the name in the Url. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 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.

Examples

Create or update a target group with all properties.

Create or update a target group with minimal properties.

Create or update a target group with all properties.

Sample Request

HTTP

PUT 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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.JobTargetGroupInner;
import com.azure.resourcemanager.sql.models.JobTarget;
import com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType;
import com.azure.resourcemanager.sql.models.JobTargetType;
import java.util.Arrays;

/** Samples for JobTargetGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobTargetGroupMax.json
     */
    /**
     * Sample code: Create or update a target group with all properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateATargetGroupWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetGroups().createOrUpdateWithResponse("group1",
            "server1", "agent1", "targetGroup1",
            new JobTargetGroupInner().withMembers(Arrays.asList(
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.EXCLUDE)
                    .withType(JobTargetType.SQL_DATABASE).withServerName("server1").withDatabaseName("database1"),
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.INCLUDE)
                    .withType(JobTargetType.SQL_SERVER).withServerName("server1")
                    .withRefreshCredential("fakeTokenPlaceholder"),
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.INCLUDE)
                    .withType(JobTargetType.SQL_ELASTIC_POOL).withServerName("server2").withElasticPoolName("pool1")
                    .withRefreshCredential("fakeTokenPlaceholder"),
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.INCLUDE)
                    .withType(JobTargetType.SQL_SHARD_MAP).withServerName("server3").withShardMapName("shardMap1")
                    .withRefreshCredential("fakeTokenPlaceholder"))),
            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"
}

Status code:

201

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

Create or update a target group with minimal properties.

Sample Request

HTTP

PUT 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

{
  "properties": {
    "members": []
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.JobTargetGroupInner;
import java.util.Arrays;

/** Samples for JobTargetGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobTargetGroupMin.json
     */
    /**
     * Sample code: Create or update a target group with minimal properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateATargetGroupWithMinimalProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetGroups().createOrUpdateWithResponse("group1",
            "server1", "agent1", "targetGroup1", new JobTargetGroupInner().withMembers(Arrays.asList()), 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": []
  },
  "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"
}

Status code:

201

{
  "properties": {
    "members": []
  },
  "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