Microsoft.Sql servers/databases/syncGroups/syncMembers

The servers/databases/syncGroups/syncMembers 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/syncMembers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-05-01-preview' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    databaseName: 'string'
    databaseType: 'string'
    password: 'string'
    serverName: 'string'
    sqlServerDatabaseId: 'string'
    syncAgentId: 'string'
    syncDirection: 'string'
    syncMemberAzureDatabaseResourceId: 'string'
    usePrivateLinkConnection: bool
    userName: 'string'
  }
}

Property values

servers/databases/syncGroups/syncMembers

Name Description Value
type The resource type

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

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

See how to set names and types for child resources in Bicep or JSON ARM templates.
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.
parentSymbolicName
properties Properties of a sync member. SyncMemberProperties

SyncMemberProperties

Name Description Value
databaseName Database name of the member database in the sync member. string
databaseType Type of the sync agent linked database. 'AzureSqlDatabase'
'SqlServerDatabase'
password Password of the member database in the sync member. string
serverName Server name of the member database in the sync member string
sqlServerDatabaseId SQL Server database id of the sync member. string
syncAgentId ARM resource id of the sync agent in the sync member. string
syncDirection Sync direction of the sync member. 'Bidirectional'
'OneWayHubToMember'
'OneWayMemberToHub'
syncMemberAzureDatabaseResourceId ARM resource id of the sync member logical database, for sync members in Azure. string
usePrivateLinkConnection Whether to use private link connection. bool
userName User name of the member database in the sync member. string