Microsoft.Sql servers/jobAgents/targetGroups

ARM template resource definition

The servers/jobAgents/targetGroups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/jobAgents/targetGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/jobAgents/targetGroups",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "members": [
      {
        "databaseName": "string",
        "elasticPoolName": "string",
        "membershipType": "string",
        "refreshCredential": "string",
        "serverName": "string",
        "shardMapName": "string",
        "type": "string"
      }
    ]
  }
}

Property values

servers/jobAgents/targetGroups

Name Description Value
type The resource type 'Microsoft.Sql/servers/jobAgents/targetGroups'
apiVersion The resource api version '2023-05-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Resource properties. JobTargetGroupProperties

JobTargetGroupProperties

Name Description Value
members Members of the target group. JobTarget[] (required)

JobTarget

Name Description Value
databaseName The target database name. string
elasticPoolName The target elastic pool name. string
membershipType Whether the target is included or excluded from the group. 'Exclude'
'Include'
refreshCredential 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. string
serverName The target server name. string
shardMapName The target shard map. string
type The target type. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (required)