Microsoft.Sql servers/syncAgents

Template format

To create a Microsoft.Sql/servers/syncAgents resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.Sql/servers/syncAgents",
  "apiVersion": "2015-05-01-preview",
  "properties": {
    "syncDatabaseId": "string"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Sql/servers/syncAgents object

Name Type Required Value
name string Yes The name of the sync agent.
type enum Yes syncAgents

See Set name and type for child resources.
apiVersion enum Yes 2015-05-01-preview
properties object Yes Resource properties. - SyncAgentProperties object

SyncAgentProperties object

Name Type Required Value
syncDatabaseId string No ARM resource id of the sync database in the sync agent.