{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "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.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "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" } } }, "tags": [ { "name": "SyncMembers" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers": { "get": { "operationId": "SyncMembers_ListBySyncGroup", "tags": [ "SyncMembers" ], "description": "Lists sync members in the given sync group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SyncMemberListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List sync members under a sync group": { "$ref": "./examples/SyncMemberListBySyncGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}": { "get": { "operationId": "SyncMembers_Get", "tags": [ "SyncMembers" ], "description": "Gets a sync member.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "syncMemberName", "in": "path", "description": "The name of the sync member.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SyncMember" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a sync member": { "$ref": "./examples/SyncMemberGet.json" } } }, "put": { "operationId": "SyncMembers_CreateOrUpdate", "tags": [ "SyncMembers" ], "description": "Creates or updates a sync member.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "syncMemberName", "in": "path", "description": "The name of the sync member.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The requested sync member resource state.", "required": true, "schema": { "$ref": "#/definitions/SyncMember" } } ], "responses": { "200": { "description": "Resource 'SyncMember' update operation succeeded", "schema": { "$ref": "#/definitions/SyncMember" } }, "201": { "description": "Resource 'SyncMember' create operation succeeded", "schema": { "$ref": "#/definitions/SyncMember" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a new sync member": { "$ref": "./examples/SyncMemberCreate.json" }, "Update a sync member": { "$ref": "./examples/SyncMemberUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SyncMember" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "SyncMembers_Update", "tags": [ "SyncMembers" ], "description": "Updates an existing sync member.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "syncMemberName", "in": "path", "description": "The name of the sync member.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The requested sync member resource state.", "required": true, "schema": { "$ref": "#/definitions/SyncMember" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SyncMember" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an existing sync member": { "$ref": "./examples/SyncMemberPatch.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SyncMember" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "SyncMembers_Delete", "tags": [ "SyncMembers" ], "description": "Deletes a sync member.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "syncMemberName", "in": "path", "description": "The name of the sync member.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a sync member": { "$ref": "./examples/SyncMemberDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/refreshSchema": { "post": { "operationId": "SyncMembers_RefreshMemberSchema", "tags": [ "SyncMembers" ], "description": "Refreshes a sync member database schema.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "syncMemberName", "in": "path", "description": "The name of the sync member.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Refresh a sync member database schema": { "$ref": "./examples/SyncMemberRefreshSchema.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/schemas": { "get": { "operationId": "SyncMembers_ListMemberSchemas", "tags": [ "SyncMembers" ], "description": "Gets a sync member database schema.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "syncGroupName", "in": "path", "description": "The name of the sync group.", "required": true, "type": "string" }, { "name": "syncMemberName", "in": "path", "description": "The name of the sync member.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/SyncFullSchemaPropertiesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a sync member schema": { "$ref": "./examples/SyncMemberGetSchema.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "SyncMember": { "type": "object", "description": "An Azure SQL Database sync member.", "properties": { "properties": { "$ref": "#/definitions/SyncMemberProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SyncMemberListResult": { "type": "object", "description": "The response of a SyncMember list operation.", "properties": { "value": { "type": "array", "description": "The SyncMember items on this page", "items": { "$ref": "#/definitions/SyncMember" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SyncMemberProperties": { "type": "object", "description": "Properties of a sync member with support to MI.", "properties": { "databaseType": { "$ref": "./common.json#/definitions/SyncMemberDbType", "description": "Database type of the sync member." }, "syncAgentId": { "type": "string", "description": "ARM resource id of the sync agent in the sync member." }, "sqlServerDatabaseId": { "$ref": "./common.json#/definitions/Azure.Core.uuid", "description": "SQL Server database id of the sync member." }, "syncMemberAzureDatabaseResourceId": { "type": "string", "description": "ARM resource id of the sync member logical database, for sync members in Azure." }, "usePrivateLinkConnection": { "type": "boolean", "description": "Whether to use private link connection." }, "privateEndpointName": { "type": "string", "description": "Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.", "readOnly": true }, "serverName": { "type": "string", "description": "Server name of the member database in the sync member" }, "databaseName": { "type": "string", "description": "Database name of the member database in the sync member." }, "userName": { "type": "string", "description": "User name of the member database in the sync member." }, "password": { "type": "string", "description": "Password of the member database in the sync member.", "x-ms-mutability": [ "update", "create" ] }, "syncDirection": { "$ref": "./common.json#/definitions/SyncDirection", "description": "Sync direction of the sync member." }, "syncState": { "$ref": "./common.json#/definitions/SyncMemberState", "description": "Sync state of the sync member.", "readOnly": true } } } }, "parameters": {} }