Job Target Groups - Create Or Update

Service:: SQL Database

API Version:: 2023-08-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=2023-08-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	ErrorResponse	* Error Responses: * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 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. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found

Name

Type

Description

200 OK

JobTargetGroup

Successfully updated the target group.

201 Created

JobTargetGroup

Successfully created the target group.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
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.
400 ElasticJobsOperationFailed - Elastic jobs management operation failed.
404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found

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.

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1?api-version=2023-08-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"
      }
    ]
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobTargetGroupMax.json
// this example is just showing the usage of "JobTargetGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobAgentResource created on azure
// for more information of creating SqlServerJobAgentResource, please refer to the document of SqlServerJobAgentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
ResourceIdentifier sqlServerJobAgentResourceId = SqlServerJobAgentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName);
SqlServerJobAgentResource sqlServerJobAgent = client.GetSqlServerJobAgentResource(sqlServerJobAgentResourceId);

// get the collection of this SqlServerJobTargetGroupResource
SqlServerJobTargetGroupCollection collection = sqlServerJobAgent.GetSqlServerJobTargetGroups();

// invoke the operation
string targetGroupName = "targetGroup1";
SqlServerJobTargetGroupData data = new SqlServerJobTargetGroupData
{
    Members = {new JobTarget(JobTargetType.SqlDatabase)
    {
    MembershipType = JobTargetGroupMembershipType.Exclude,
    ServerName = "server1",
    DatabaseName = "database1",
    }, new JobTarget(JobTargetType.SqlServer)
    {
    MembershipType = JobTargetGroupMembershipType.Include,
    ServerName = "server1",
    RefreshCredential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential",
    }, new JobTarget(JobTargetType.SqlElasticPool)
    {
    MembershipType = JobTargetGroupMembershipType.Include,
    ServerName = "server2",
    ElasticPoolName = "pool1",
    RefreshCredential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential",
    }, new JobTarget(JobTargetType.SqlShardMap)
    {
    MembershipType = JobTargetGroupMembershipType.Include,
    ServerName = "server3",
    ShardMapName = "shardMap1",
    RefreshCredential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential",
    }},
};
ArmOperation<SqlServerJobTargetGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, targetGroupName, data);
SqlServerJobTargetGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobTargetGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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
dotnet

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1?api-version=2023-08-01

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobTargetGroupMin.json
// this example is just showing the usage of "JobTargetGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobAgentResource created on azure
// for more information of creating SqlServerJobAgentResource, please refer to the document of SqlServerJobAgentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
ResourceIdentifier sqlServerJobAgentResourceId = SqlServerJobAgentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName);
SqlServerJobAgentResource sqlServerJobAgent = client.GetSqlServerJobAgentResource(sqlServerJobAgentResourceId);

// get the collection of this SqlServerJobTargetGroupResource
SqlServerJobTargetGroupCollection collection = sqlServerJobAgent.GetSqlServerJobTargetGroups();

// invoke the operation
string targetGroupName = "targetGroup1";
SqlServerJobTargetGroupData data = new SqlServerJobTargetGroupData
{
    Members = { },
};
ArmOperation<SqlServerJobTargetGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, targetGroupName, data);
SqlServerJobTargetGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobTargetGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
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.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

JobTarget

Object

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

Object

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

Enumeration

Whether the target is included or excluded from the group.

Value	Description
Include
Exclude

JobTargetType

Enumeration

The target type.

Value	Description
TargetGroup
SqlDatabase
SqlElasticPool
SqlShardMap
SqlServer

Share via

Job Target Groups - Create Or Update

URI Parameters

Request Body

Responses

Examples

Create or update a target group with all properties.

Sample request

Sample response

Create or update a target group with minimal properties.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobTarget

JobTargetGroup

JobTargetGroupMembershipType

JobTargetType