Microsoft.Sql servers/syncAgents 2021-02-01-preview

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

resource symbolicname 'Microsoft.Sql/servers/syncAgents@2021-02-01-preview' = {
  name: 'string'
  properties: {
    syncDatabaseId: 'string'
  }
}

Property values

servers/syncAgents

Name Description Value
type The resource type

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

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

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Properties of an Azure SQL Database sync agent. SyncAgentProperties

SyncAgentProperties

Name Description Value
syncDatabaseId ARM resource id of the sync database in the sync agent. string