The servers/databases/syncGroups/syncMembers resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
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": "2023-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"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Sql/servers/databases/syncGroups/syncMembers' |
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. | 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 |