Sync Members - List Member Schemas
Gets a sync member database schema.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/schemas?api-version=2021-11-01
URI Parameters
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. |
sync
|
path | True |
string |
The name of the sync group on which the sync member is hosted. |
sync
|
path | True |
string |
The name of the sync member. |
api-version
|
query | True |
string |
The API version to use for the request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully get a sync member schema. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Get a sync member schema
Sample request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879/schemas?api-version=2021-11-01
Sample response
{
"value": [
{
"tables": [
{
"columns": [
{
"dataSize": "4",
"dataType": "int",
"hasError": false,
"isPrimaryKey": false,
"name": "intField",
"quotedName": "[intField]"
},
{
"dataSize": "100",
"dataType": "nvarchar",
"hasError": false,
"isPrimaryKey": false,
"name": "charField",
"quotedName": "[charField]"
}
],
"errorId": "Schema_TableHasNoPrimaryKey",
"hasError": true,
"name": "dbo.myTable",
"quotedName": "[dbo].[myTable]"
}
],
"lastUpdateTime": "2017-05-30T07:16:08.21Z"
}
]
}
Definitions
Name | Description |
---|---|
Sync |
Properties of the database full schema. |
Sync |
A list of sync schema properties. |
Sync |
Properties of the table in the database full schema. |
Sync |
Properties of the column in the table of database full schema. |
SyncFullSchemaProperties
Properties of the database full schema.
Name | Type | Description |
---|---|---|
lastUpdateTime |
string |
Last update time of the database schema. |
tables |
List of tables in the database full schema. |
SyncFullSchemaPropertiesListResult
A list of sync schema properties.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
Array of results. |
SyncFullSchemaTable
Properties of the table in the database full schema.
Name | Type | Description |
---|---|---|
columns |
List of columns in the table of database full schema. |
|
errorId |
string |
Error id of the table. |
hasError |
boolean |
If there is error in the table. |
name |
string |
Name of the table. |
quotedName |
string |
Quoted name of the table. |
SyncFullSchemaTableColumn
Properties of the column in the table of database full schema.
Name | Type | Description |
---|---|---|
dataSize |
string |
Data size of the column. |
dataType |
string |
Data type of the column. |
errorId |
string |
Error id of the column. |
hasError |
boolean |
If there is error in the table. |
isPrimaryKey |
boolean |
If it is the primary key of the table. |
name |
string |
Name of the column. |
quotedName |
string |
Quoted name of the column. |