Share via

Microsoft.Sql servers/jobAgents/targetGroups 2022-11-01-preview

  • Article

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/jobAgents/targetGroups@2022-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    members: [
      {
        databaseName: 'string'
        elasticPoolName: 'string'
        membershipType: 'string'
        refreshCredential: 'string'
        serverName: 'string'
        shardMapName: 'string'
        type: 'string'
      }
    ]
  }
}

Property values

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)

JobTargetGroupProperties

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

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: servers/jobAgents
properties Resource properties. JobTargetGroupProperties

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": "2022-11-01-preview",
  "name": "string",
  "properties": {
    "members": [
      {
        "databaseName": "string",
        "elasticPoolName": "string",
        "membershipType": "string",
        "refreshCredential": "string",
        "serverName": "string",
        "shardMapName": "string",
        "type": "string"
      }
    ]
  }
}

Property values

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)

JobTargetGroupProperties

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

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
apiVersion The api version '2022-11-01-preview'
name The resource name string (required)
properties Resource properties. JobTargetGroupProperties
type The resource type 'Microsoft.Sql/servers/jobAgents/targetGroups'

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents/targetGroups@2022-11-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      members = [
        {
          databaseName = "string"
          elasticPoolName = "string"
          membershipType = "string"
          refreshCredential = "string"
          serverName = "string"
          shardMapName = "string"
          type = "string"
        }
      ]
    }
  })
}

Property values

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)

JobTargetGroupProperties

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

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers/jobAgents
properties Resource properties. JobTargetGroupProperties
type The resource type "Microsoft.Sql/servers/jobAgents/targetGroups@2022-11-01-preview"