Microsoft.Sql servers/syncAgents

ARM template resource definition

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

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

Property values

servers/syncAgents

Name Description Value
type The resource type 'Microsoft.Sql/servers/syncAgents'
apiVersion The resource api version '2023-05-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Resource properties. SyncAgentProperties

SyncAgentProperties

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