{ "swagger": "2.0", "info": { "version": "2015-05-01-preview", "title": "SqlManagementClient", "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/syncDatabaseIds": { "get": { "tags": [ "SyncGroups" ], "description": "Gets a collection of sync database ids.", "operationId": "SyncGroups_ListSyncDatabaseIds", "parameters": [ { "name": "locationName", "in": "path", "description": "The name of the region where the resource is located.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved collection of sync database ids.", "schema": { "$ref": "#/definitions/SyncDatabaseIdListResult" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Get a sync database ID": { "$ref": "./examples/SyncGroupGetSyncDatabaseId.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/refreshHubSchema": { "post": { "tags": [ "SyncGroups" ], "description": "Refreshes a hub database schema.", "operationId": "SyncGroups_RefreshHubSchema", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully refreshed a sync hub schema." }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." }, "202": { "description": "The sync hub schema refresh operation is on going." } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Refresh a hub database schema.": { "$ref": "./examples/SyncGroupRefreshHubSchema.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas": { "get": { "tags": [ "SyncGroups" ], "description": "Gets a collection of hub database schemas.", "operationId": "SyncGroups_ListHubSchemas", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully get a sync group hub database schema.", "schema": { "$ref": "#/definitions/SyncFullSchemaPropertiesListResult" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Get a hub database schema.": { "$ref": "./examples/SyncGroupGetHubSchema.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/logs": { "get": { "tags": [ "SyncGroups" ], "description": "Gets a collection of sync group logs.", "operationId": "SyncGroups_ListLogs", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "startTime", "in": "query", "description": "Get logs generated after this time.", "required": true, "type": "string" }, { "name": "endTime", "in": "query", "description": "Get logs generated before this time.", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The types of logs to retrieve.", "required": true, "type": "string", "enum": [ "All", "Error", "Warning", "Success" ] }, { "name": "continuationToken", "in": "query", "description": "The continuation token for this operation.", "required": false, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved sync group logs.", "schema": { "$ref": "#/definitions/SyncGroupLogListResult" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Get sync group logs": { "$ref": "./examples/SyncGroupGetLog.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/cancelSync": { "post": { "tags": [ "SyncGroups" ], "description": "Cancels a sync group synchronization.", "operationId": "SyncGroups_CancelSync", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully cancel a sync group synchronization." }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." } }, "x-ms-examples": { "Cancel a sync group synchronization": { "$ref": "./examples/SyncGroupCancelSync.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/triggerSync": { "post": { "tags": [ "SyncGroups" ], "description": "Triggers a sync group synchronization.", "operationId": "SyncGroups_TriggerSync", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully triggered a sync group synchronization." }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." } }, "x-ms-examples": { "Trigger a sync group synchronization.": { "$ref": "./examples/SyncGroupTriggerSync.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}": { "get": { "tags": [ "SyncGroups" ], "description": "Gets a sync group.", "operationId": "SyncGroups_Get", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the specified sync group.", "schema": { "$ref": "#/definitions/SyncGroup" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." } }, "x-ms-examples": { "Get a sync group": { "$ref": "./examples/SyncGroupGet.json" } } }, "put": { "tags": [ "SyncGroups" ], "description": "Creates or updates a sync group.", "operationId": "SyncGroups_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The requested sync group resource state.", "required": true, "schema": { "$ref": "#/definitions/SyncGroup" } }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the sync group.", "schema": { "$ref": "#/definitions/SyncGroup" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." }, "202": { "description": "Creating or updating the sync group is in progress." }, "201": { "description": "Successfully created the sync group.", "schema": { "$ref": "#/definitions/SyncGroup" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create a sync group": { "$ref": "./examples/SyncGroupCreate.json" }, "Update a sync group": { "$ref": "./examples/SyncGroupUpdate.json" } } }, "delete": { "tags": [ "SyncGroups" ], "description": "Deletes a sync group.", "operationId": "SyncGroups_Delete", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the sync group." }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." }, "202": { "description": "Deleting the sync group is in progress." }, "204": { "description": "The specified sync group does not exist." } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete a sync group": { "$ref": "./examples/SyncGroupDelete.json" } } }, "patch": { "tags": [ "SyncGroups" ], "description": "Updates a sync group.", "operationId": "SyncGroups_Update", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The requested sync group resource state.", "required": true, "schema": { "$ref": "#/definitions/SyncGroup" } }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the sync group.", "schema": { "$ref": "#/definitions/SyncGroup" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." }, "202": { "description": "Updating the sync group is in progress." } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Update a sync group": { "$ref": "./examples/SyncGroupPatch.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups": { "get": { "tags": [ "SyncGroups" ], "description": "Lists sync groups under a hub database.", "operationId": "SyncGroups_ListByDatabase", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "databaseName", "in": "path", "description": "The name of the database on which the sync group is hosted.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of sync groups.", "schema": { "$ref": "#/definitions/SyncGroupListResult" } }, "default": { "description": "*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncGroup - Sync group is invalid.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded." } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List sync groups under a given database": { "$ref": "./examples/SyncGroupListByDatabase.json" } } } } }, "definitions": { "SyncDatabaseIdListResult": { "description": "A list of sync database ID properties.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/SyncDatabaseIdProperties" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } }, "SyncDatabaseIdProperties": { "description": "Properties of the sync database id.", "type": "object", "properties": { "id": { "description": "ARM resource id of sync database.", "type": "string", "readOnly": true } } }, "SyncFullSchemaPropertiesListResult": { "description": "A list of sync schema properties.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/SyncFullSchemaProperties" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } }, "SyncFullSchemaProperties": { "description": "Properties of the database full schema.", "type": "object", "properties": { "tables": { "description": "List of tables in the database full schema.", "type": "array", "items": { "$ref": "#/definitions/SyncFullSchemaTable" }, "readOnly": true }, "lastUpdateTime": { "format": "date-time", "description": "Last update time of the database schema.", "type": "string", "readOnly": true } } }, "SyncFullSchemaTable": { "description": "Properties of the table in the database full schema.", "type": "object", "properties": { "columns": { "description": "List of columns in the table of database full schema.", "type": "array", "items": { "$ref": "#/definitions/SyncFullSchemaTableColumn" }, "readOnly": true }, "errorId": { "description": "Error id of the table.", "type": "string", "readOnly": true }, "hasError": { "description": "If there is error in the table.", "type": "boolean", "readOnly": true }, "name": { "description": "Name of the table.", "type": "string", "readOnly": true }, "quotedName": { "description": "Quoted name of the table.", "type": "string", "readOnly": true } } }, "SyncFullSchemaTableColumn": { "description": "Properties of the column in the table of database full schema.", "type": "object", "properties": { "dataSize": { "description": "Data size of the column.", "type": "string", "readOnly": true }, "dataType": { "description": "Data type of the column.", "type": "string", "readOnly": true }, "errorId": { "description": "Error id of the column.", "type": "string", "readOnly": true }, "hasError": { "description": "If there is error in the table.", "type": "boolean", "readOnly": true }, "isPrimaryKey": { "description": "If it is the primary key of the table.", "type": "boolean", "readOnly": true }, "name": { "description": "Name of the column.", "type": "string", "readOnly": true }, "quotedName": { "description": "Quoted name of the column.", "type": "string", "readOnly": true } } }, "SyncGroupLogListResult": { "description": "A list of sync group log properties.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/SyncGroupLogProperties" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } }, "SyncGroupLogProperties": { "description": "Properties of an Azure SQL Database sync group log.", "type": "object", "properties": { "timestamp": { "format": "date-time", "description": "Timestamp of the sync group log.", "type": "string", "readOnly": true }, "type": { "description": "Type of the sync group log.", "enum": [ "All", "Error", "Warning", "Success" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "SyncGroupLogType", "modelAsString": true } }, "source": { "description": "Source of the sync group log.", "type": "string", "readOnly": true }, "details": { "description": "Details of the sync group log.", "type": "string", "readOnly": true }, "tracingId": { "format": "uuid", "description": "TracingId of the sync group log.", "type": "string", "readOnly": true }, "operationStatus": { "description": "OperationStatus of the sync group log.", "type": "string", "readOnly": true } } }, "SyncGroupProperties": { "description": "Properties of a sync group.", "type": "object", "properties": { "interval": { "format": "int32", "description": "Sync interval of the sync group.", "type": "integer" }, "lastSyncTime": { "format": "date-time", "description": "Last sync time of the sync group.", "type": "string", "readOnly": true }, "conflictResolutionPolicy": { "description": "Conflict resolution policy of the sync group.", "enum": [ "HubWin", "MemberWin" ], "type": "string", "x-ms-enum": { "name": "SyncConflictResolutionPolicy", "modelAsString": true } }, "syncDatabaseId": { "description": "ARM resource id of the sync database in the sync group.", "type": "string" }, "hubDatabaseUserName": { "description": "User name for the sync group hub database credential.", "type": "string" }, "hubDatabasePassword": { "description": "Password for the sync group hub database credential.", "type": "string", "x-ms-mutability": [ "create", "update" ] }, "syncState": { "description": "Sync state of the sync group.", "enum": [ "NotReady", "Error", "Warning", "Progressing", "Good" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "SyncGroupState", "modelAsString": true } }, "schema": { "$ref": "#/definitions/SyncGroupSchema", "description": "Sync schema of the sync group." } } }, "SyncGroupSchema": { "description": "Properties of sync group schema.", "type": "object", "properties": { "tables": { "description": "List of tables in sync group schema.", "type": "array", "items": { "$ref": "#/definitions/SyncGroupSchemaTable" } }, "masterSyncMemberName": { "description": "Name of master sync member where the schema is from.", "type": "string" } } }, "SyncGroupSchemaTable": { "description": "Properties of table in sync group schema.", "type": "object", "properties": { "columns": { "description": "List of columns in sync group schema.", "type": "array", "items": { "$ref": "#/definitions/SyncGroupSchemaTableColumn" } }, "quotedName": { "description": "Quoted name of sync group schema table.", "type": "string" } } }, "SyncGroupSchemaTableColumn": { "description": "Properties of column in sync group table.", "type": "object", "properties": { "quotedName": { "description": "Quoted name of sync group table column.", "type": "string" }, "dataSize": { "description": "Data size of the column.", "type": "string" }, "dataType": { "description": "Data type of the column.", "type": "string" } } }, "SyncGroup": { "description": "An Azure SQL Database sync group.", "type": "object", "allOf": [ { "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/SyncGroupProperties", "description": "Resource properties.", "x-ms-client-flatten": true } } }, "SyncGroupListResult": { "description": "A list of sync groups.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/SyncGroup" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "description": "The subscription ID that identifies an Azure subscription.", "required": true, "type": "string", "x-ms-parameter-location": "client" }, "ApiVersionParameter": { "name": "api-version", "in": "query", "description": "The API version to use for the request.", "required": true, "type": "string", "x-ms-parameter-location": "client" }, "ResourceGroupParameter": { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "ServerNameParameter": { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "DatabaseNameParameter": { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } } }