Sync Groups - List By Database
Lists sync groups under a hub database.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups?api-version=2021-11-01
Name | In | Required | Type | Description |
---|---|---|---|---|
database
|
path | True |
string |
The name of the database on which the sync group is hosted. |
resource
|
path | True |
string |
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server
|
path | True |
string |
The name of the server. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
api-version
|
query | True |
string |
The API version to use for the request. |
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved the list of sync groups. |
|
Other Status Codes |
*** Error Responses: ***
|
Sample request
Sample response
{
"value": [
{
"properties": {
"interval": -1,
"lastSyncTime": "0001-01-01T08:00:00Z",
"conflictResolutionPolicy": "HubWin",
"syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
"hubDatabaseUserName": "hubUser",
"syncState": "NotReady",
"usePrivateLinkConnection": true,
"privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
"name": "syncgroupcrud-3187",
"type": "Microsoft.Sql/servers/databases/syncGroups"
},
{
"properties": {
"interval": -1,
"lastSyncTime": "0001-01-01T08:00:00Z",
"conflictResolutionPolicy": "HubWin",
"syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
"hubDatabaseUserName": "hubUser",
"syncState": "NotReady",
"usePrivateLinkConnection": true,
"privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-5374"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-5374",
"name": "syncgroupcrud-5374",
"type": "Microsoft.Sql/servers/databases/syncGroups"
}
]
}
Name | Description |
---|---|
Sku |
An ARM Resource SKU. |
Sync |
Conflict resolution policy of the sync group. |
Sync |
An Azure SQL Database sync group. |
Sync |
A list of sync groups. |
Sync |
Properties of sync group schema. |
Sync |
Properties of table in sync group schema. |
Sync |
Properties of column in sync group table. |
Sync |
Sync state of the sync group. |
An ARM Resource SKU.
Name | Type | Description |
---|---|---|
capacity |
integer |
Capacity of the particular SKU. |
family |
string |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
name |
string |
The name of the SKU, typically, a letter + Number code, e.g. P3. |
size |
string |
Size of the particular SKU |
tier |
string |
The tier or edition of the particular SKU, e.g. Basic, Premium. |
Conflict resolution policy of the sync group.
Name | Type | Description |
---|---|---|
HubWin |
string |
|
MemberWin |
string |
An Azure SQL Database sync group.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
name |
string |
Resource name. |
properties.conflictLoggingRetentionInDays |
integer |
Conflict logging retention period. |
properties.conflictResolutionPolicy |
Conflict resolution policy of the sync group. |
|
properties.enableConflictLogging |
boolean |
If conflict logging is enabled. |
properties.hubDatabasePassword |
string |
Password for the sync group hub database credential. |
properties.hubDatabaseUserName |
string |
User name for the sync group hub database credential. |
properties.interval |
integer |
Sync interval of the sync group. |
properties.lastSyncTime |
string |
Last sync time of the sync group. |
properties.privateEndpointName |
string |
Private endpoint name of the sync group if use private link connection is enabled. |
properties.schema |
Sync schema of the sync group. |
|
properties.syncDatabaseId |
string |
ARM resource id of the sync database in the sync group. |
properties.syncState |
Sync state of the sync group. |
|
properties.usePrivateLinkConnection |
boolean |
If use private link connection is enabled. |
sku |
The name and capacity of the SKU. |
|
type |
string |
Resource type. |
A list of sync groups.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
Array of results. |
Properties of sync group schema.
Name | Type | Description |
---|---|---|
masterSyncMemberName |
string |
Name of master sync member where the schema is from. |
tables |
List of tables in sync group schema. |
Properties of table in sync group schema.
Name | Type | Description |
---|---|---|
columns |
List of columns in sync group schema. |
|
quotedName |
string |
Quoted name of sync group schema table. |
Properties of column in sync group table.
Name | Type | Description |
---|---|---|
dataSize |
string |
Data size of the column. |
dataType |
string |
Data type of the column. |
quotedName |
string |
Quoted name of sync group table column. |
Sync state of the sync group.
Name | Type | Description |
---|---|---|
Error |
string |
|
Good |
string |
|
NotReady |
string |
|
Progressing |
string |
|
Warning |
string |