Microsoft.Sql servers/databases/syncGroups 2021-11-01
- Latest
- 2023-05-01-preview
- 2023-02-01-preview
- 2022-11-01-preview
- 2022-08-01-preview
- 2022-05-01-preview
- 2022-02-01-preview
- 2021-11-01
- 2021-11-01-preview
- 2021-08-01-preview
- 2021-05-01-preview
- 2021-02-01-preview
- 2020-11-01-preview
- 2020-08-01-preview
- 2020-02-02-preview
- 2019-06-01-preview
- 2015-05-01-preview
Bicep resource definition
The servers/databases/syncGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/databases/syncGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/databases/syncGroups@2021-11-01' = {
name: 'string'
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
conflictLoggingRetentionInDays: int
conflictResolutionPolicy: 'string'
enableConflictLogging: bool
hubDatabasePassword: 'string'
hubDatabaseUserName: 'string'
interval: int
schema: {
masterSyncMemberName: 'string'
tables: [
{
columns: [
{
dataSize: 'string'
dataType: 'string'
quotedName: 'string'
}
]
quotedName: 'string'
}
]
}
syncDatabaseId: 'string'
usePrivateLinkConnection: bool
}
}
Property values
servers/databases/syncGroups
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-150 Valid characters: Alphanumerics, hyphens, and underscores. |
| sku | The name and capacity of the SKU. | Sku |
| 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: databases |
| properties | Resource properties. | SyncGroupProperties |
SyncGroupProperties
| Name | Description | Value |
|---|---|---|
| conflictLoggingRetentionInDays | Conflict logging retention period. | int |
| conflictResolutionPolicy | Conflict resolution policy of the sync group. | 'HubWin' 'MemberWin' |
| enableConflictLogging | If conflict logging is enabled. | bool |
| hubDatabasePassword | Password for the sync group hub database credential. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| hubDatabaseUserName | User name for the sync group hub database credential. | string |
| interval | Sync interval of the sync group. | int |
| schema | Sync schema of the sync group. | SyncGroupSchema |
| syncDatabaseId | ARM resource id of the sync database in the sync group. | string |
| usePrivateLinkConnection | If use private link connection is enabled. | bool |
SyncGroupSchema
| Name | Description | Value |
|---|---|---|
| masterSyncMemberName | Name of master sync member where the schema is from. | string |
| tables | List of tables in sync group schema. | SyncGroupSchemaTable[] |
SyncGroupSchemaTable
| Name | Description | Value |
|---|---|---|
| columns | List of columns in sync group schema. | SyncGroupSchemaTableColumn[] |
| quotedName | Quoted name of sync group schema table. | string |
SyncGroupSchemaTableColumn
| Name | Description | Value |
|---|---|---|
| dataSize | Data size of the column. | string |
| dataType | Data type of the column. | string |
| quotedName | Quoted name of sync group table column. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Capacity of the particular SKU. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
| size | Size of the particular SKU | string |
| tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | string |
ARM template resource definition
The servers/databases/syncGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/databases/syncGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/databases/syncGroups",
"apiVersion": "2021-11-01",
"name": "string",
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"properties": {
"conflictLoggingRetentionInDays": "int",
"conflictResolutionPolicy": "string",
"enableConflictLogging": "bool",
"hubDatabasePassword": "string",
"hubDatabaseUserName": "string",
"interval": "int",
"schema": {
"masterSyncMemberName": "string",
"tables": [
{
"columns": [
{
"dataSize": "string",
"dataType": "string",
"quotedName": "string"
}
],
"quotedName": "string"
}
]
},
"syncDatabaseId": "string",
"usePrivateLinkConnection": "bool"
}
}
Property values
servers/databases/syncGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/servers/databases/syncGroups' |
| apiVersion | The resource api version | '2021-11-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-150 Valid characters: Alphanumerics, hyphens, and underscores. |
| sku | The name and capacity of the SKU. | Sku |
| properties | Resource properties. | SyncGroupProperties |
SyncGroupProperties
| Name | Description | Value |
|---|---|---|
| conflictLoggingRetentionInDays | Conflict logging retention period. | int |
| conflictResolutionPolicy | Conflict resolution policy of the sync group. | 'HubWin' 'MemberWin' |
| enableConflictLogging | If conflict logging is enabled. | bool |
| hubDatabasePassword | Password for the sync group hub database credential. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| hubDatabaseUserName | User name for the sync group hub database credential. | string |
| interval | Sync interval of the sync group. | int |
| schema | Sync schema of the sync group. | SyncGroupSchema |
| syncDatabaseId | ARM resource id of the sync database in the sync group. | string |
| usePrivateLinkConnection | If use private link connection is enabled. | bool |
SyncGroupSchema
| Name | Description | Value |
|---|---|---|
| masterSyncMemberName | Name of master sync member where the schema is from. | string |
| tables | List of tables in sync group schema. | SyncGroupSchemaTable[] |
SyncGroupSchemaTable
| Name | Description | Value |
|---|---|---|
| columns | List of columns in sync group schema. | SyncGroupSchemaTableColumn[] |
| quotedName | Quoted name of sync group schema table. | string |
SyncGroupSchemaTableColumn
| Name | Description | Value |
|---|---|---|
| dataSize | Data size of the column. | string |
| dataType | Data type of the column. | string |
| quotedName | Quoted name of sync group table column. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Capacity of the particular SKU. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
| size | Size of the particular SKU | string |
| tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | string |
Terraform (AzAPI provider) resource definition
The servers/databases/syncGroups 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/databases/syncGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/databases/syncGroups@2021-11-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
conflictLoggingRetentionInDays = int
conflictResolutionPolicy = "string"
enableConflictLogging = bool
hubDatabasePassword = "string"
hubDatabaseUserName = "string"
interval = int
schema = {
masterSyncMemberName = "string"
tables = [
{
columns = [
{
dataSize = "string"
dataType = "string"
quotedName = "string"
}
]
quotedName = "string"
}
]
}
syncDatabaseId = "string"
usePrivateLinkConnection = bool
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
})
}
Property values
servers/databases/syncGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/servers/databases/syncGroups@2021-11-01" |
| name | The resource name | string (required) Character limit: 1-150 Valid characters: Alphanumerics, hyphens, and underscores. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: databases |
| sku | The name and capacity of the SKU. | Sku |
| properties | Resource properties. | SyncGroupProperties |
SyncGroupProperties
| Name | Description | Value |
|---|---|---|
| conflictLoggingRetentionInDays | Conflict logging retention period. | int |
| conflictResolutionPolicy | Conflict resolution policy of the sync group. | "HubWin" "MemberWin" |
| enableConflictLogging | If conflict logging is enabled. | bool |
| hubDatabasePassword | Password for the sync group hub database credential. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| hubDatabaseUserName | User name for the sync group hub database credential. | string |
| interval | Sync interval of the sync group. | int |
| schema | Sync schema of the sync group. | SyncGroupSchema |
| syncDatabaseId | ARM resource id of the sync database in the sync group. | string |
| usePrivateLinkConnection | If use private link connection is enabled. | bool |
SyncGroupSchema
| Name | Description | Value |
|---|---|---|
| masterSyncMemberName | Name of master sync member where the schema is from. | string |
| tables | List of tables in sync group schema. | SyncGroupSchemaTable[] |
SyncGroupSchemaTable
| Name | Description | Value |
|---|---|---|
| columns | List of columns in sync group schema. | SyncGroupSchemaTableColumn[] |
| quotedName | Quoted name of sync group schema table. | string |
SyncGroupSchemaTableColumn
| Name | Description | Value |
|---|---|---|
| dataSize | Data size of the column. | string |
| dataType | Data type of the column. | string |
| quotedName | Quoted name of sync group table column. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Capacity of the particular SKU. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
| size | Size of the particular SKU | string |
| tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | string |