Share via

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

  • Article

Bicep 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 Bicep to your template.

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

Property values

Microsoft.Sql/servers/syncAgents

Name Description Value
name The resource name 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.		 Symbolic name for resource of type: servers
properties Resource properties. SyncAgentProperties

SyncAgentProperties

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

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": "2021-08-01-preview",
  "name": "string",
  "properties": {
    "syncDatabaseId": "string"
  }
}

Property values

Microsoft.Sql/servers/syncAgents

Name Description Value
apiVersion The api version '2021-08-01-preview'
name The resource name string (required)
properties Resource properties. SyncAgentProperties
type The resource type 'Microsoft.Sql/servers/syncAgents'

SyncAgentProperties

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

Terraform (AzAPI provider) resource definition

The servers/syncAgents resource type can be deployed with operations that target:

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/syncAgents@2021-08-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      syncDatabaseId = "string"
    }
  })
}

Property values

Microsoft.Sql/servers/syncAgents

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
properties Resource properties. SyncAgentProperties
type The resource type "Microsoft.Sql/servers/syncAgents@2021-08-01-preview"

SyncAgentProperties

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