Microsoft.Sql servers/databases/syncGroups/syncMembers
- Latest
- 2024-05-01-preview
- 2023-08-01-preview
- 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/syncMembers 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/syncMembers resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/databases/syncGroups/syncMembers@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
databaseName: 'string'
databaseType: 'string'
password: 'string'
serverName: 'string'
sqlServerDatabaseId: 'string'
syncAgentId: 'string'
syncDirection: 'string'
syncMemberAzureDatabaseResourceId: 'string'
usePrivateLinkConnection: bool
userName: 'string'
}
}
Property values
Microsoft.Sql/servers/databases/syncGroups/syncMembers
| 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/databases/syncGroups |
| properties | Resource properties. | SyncMemberProperties |
SyncMemberProperties
| Name | Description | Value |
|---|---|---|
| databaseName | Database name of the member database in the sync member. | string |
| databaseType | Database type of the sync member. | 'AzureSqlDatabase' 'SqlServerDatabase' |
| password | Password of the member database in the sync member. | string |
| serverName | Server name of the member database in the sync member | string |
| sqlServerDatabaseId | SQL Server database id of the sync member. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| syncAgentId | ARM resource id of the sync agent in the sync member. | string |
| syncDirection | Sync direction of the sync member. | 'Bidirectional' 'OneWayHubToMember' 'OneWayMemberToHub' |
| syncMemberAzureDatabaseResourceId | ARM resource id of the sync member logical database, for sync members in Azure. | string |
| usePrivateLinkConnection | Whether to use private link connection. | bool |
| userName | User name of the member database in the sync member. | string |
ARM template resource definition
The servers/databases/syncGroups/syncMembers 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/syncMembers resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"databaseName": "string",
"databaseType": "string",
"password": "string",
"serverName": "string",
"sqlServerDatabaseId": "string",
"syncAgentId": "string",
"syncDirection": "string",
"syncMemberAzureDatabaseResourceId": "string",
"usePrivateLinkConnection": "bool",
"userName": "string"
}
}
Property values
Microsoft.Sql/servers/databases/syncGroups/syncMembers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| name | The resource name | string (required) |
| properties | Resource properties. | SyncMemberProperties |
| type | The resource type | 'Microsoft.Sql/servers/databases/syncGroups/syncMembers' |
SyncMemberProperties
| Name | Description | Value |
|---|---|---|
| databaseName | Database name of the member database in the sync member. | string |
| databaseType | Database type of the sync member. | 'AzureSqlDatabase' 'SqlServerDatabase' |
| password | Password of the member database in the sync member. | string |
| serverName | Server name of the member database in the sync member | string |
| sqlServerDatabaseId | SQL Server database id of the sync member. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| syncAgentId | ARM resource id of the sync agent in the sync member. | string |
| syncDirection | Sync direction of the sync member. | 'Bidirectional' 'OneWayHubToMember' 'OneWayMemberToHub' |
| syncMemberAzureDatabaseResourceId | ARM resource id of the sync member logical database, for sync members in Azure. | string |
| usePrivateLinkConnection | Whether to use private link connection. | bool |
| userName | User name of the member database in the sync member. | string |
Terraform (AzAPI provider) resource definition
The servers/databases/syncGroups/syncMembers 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/syncMembers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/databases/syncGroups/syncMembers@2024-05-01-preview"
name = "string"
body = jsonencode({
properties = {
databaseName = "string"
databaseType = "string"
password = "string"
serverName = "string"
sqlServerDatabaseId = "string"
syncAgentId = "string"
syncDirection = "string"
syncMemberAzureDatabaseResourceId = "string"
usePrivateLinkConnection = bool
userName = "string"
}
})
}
Property values
Microsoft.Sql/servers/databases/syncGroups/syncMembers
| 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/databases/syncGroups |
| properties | Resource properties. | SyncMemberProperties |
| type | The resource type | "Microsoft.Sql/servers/databases/syncGroups/syncMembers@2024-05-01-preview" |
SyncMemberProperties
| Name | Description | Value |
|---|---|---|
| databaseName | Database name of the member database in the sync member. | string |
| databaseType | Database type of the sync member. | 'AzureSqlDatabase' 'SqlServerDatabase' |
| password | Password of the member database in the sync member. | string |
| serverName | Server name of the member database in the sync member | string |
| sqlServerDatabaseId | SQL Server database id of the sync member. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| syncAgentId | ARM resource id of the sync agent in the sync member. | string |
| syncDirection | Sync direction of the sync member. | 'Bidirectional' 'OneWayHubToMember' 'OneWayMemberToHub' |
| syncMemberAzureDatabaseResourceId | ARM resource id of the sync member logical database, for sync members in Azure. | string |
| usePrivateLinkConnection | Whether to use private link connection. | bool |
| userName | User name of the member database in the sync member. | string |