Microsoft.Sql servers/databases/syncGroups

The servers/databases/syncGroups resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Sql/servers/databases/syncGroups resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/syncGroups@2021-11-01-preview' = {
  name: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    conflictLoggingRetentionInDays: int
    conflictResolutionPolicy: 'string'
    enableConflictLogging: bool
    hubDatabasePassword: 'string'
    hubDatabaseUserName: 'string'
    interval: int
    schema: {
      masterSyncMemberName: 'string'
      tables: [
        {
          columns: [
            {
              dataSize: 'string'
              dataType: 'string'
              quotedName: 'string'
            }
          ]
          quotedName: 'string'
        }
      ]
    }
    syncDatabaseId: 'string'
    usePrivateLinkConnection: bool
  }
}

Property values

servers/databases/syncGroups

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Sql/servers/databases/syncGroups'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-11-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)

Character limit: 1-150

Valid characters:
Alphanumerics, hyphens, and underscores.
sku An ARM Resource SKU. Sku
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: databases
properties Properties of a sync group. SyncGroupProperties

SyncGroupProperties

Name Description Value
conflictLoggingRetentionInDays Conflict logging retention period. int
conflictResolutionPolicy Conflict resolution policy of the sync group. 'HubWin'
'MemberWin'
enableConflictLogging If conflict logging is enabled. bool
hubDatabasePassword Password for the sync group hub database credential. string
hubDatabaseUserName User name for the sync group hub database credential. string
interval Sync interval of the sync group. int
schema Properties of sync group schema. SyncGroupSchema
syncDatabaseId ARM resource id of the sync database in the sync group. string
usePrivateLinkConnection If use private link connection is enabled. bool

SyncGroupSchema

Name Description Value
masterSyncMemberName Name of master sync member where the schema is from. string
tables List of tables in sync group schema. SyncGroupSchemaTable[]

SyncGroupSchemaTable

Name Description Value
columns List of columns in sync group schema. SyncGroupSchemaTableColumn[]
quotedName Quoted name of sync group schema table. string

SyncGroupSchemaTableColumn

Name Description Value
dataSize Data size of the column. string
dataType Data type of the column. string
quotedName Quoted name of sync group table column. string

Sku

Name Description Value
capacity Capacity of the particular SKU. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU, typically, a letter + Number code, e.g. P3. string (required)
size Size of the particular SKU string
tier The tier or edition of the particular SKU, e.g. Basic, Premium. string