{ "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": "SensitivityLabels" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels": { "get": { "operationId": "SensitivityLabels_ListCurrentByDatabase", "tags": [ "SensitivityLabels" ], "description": "Gets the sensitivity labels of a given database", "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": "$skipToken", "in": "query", "required": false, "type": "string" }, { "name": "$count", "in": "query", "required": false, "type": "boolean" }, { "name": "$filter", "in": "query", "description": "An OData filter expression that filters elements in the collection.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/SensitivityLabelListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the current sensitivity labels of a given database": { "$ref": "./examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "patch": { "operationId": "SensitivityLabels_Update", "tags": [ "SensitivityLabels" ], "description": "Update sensitivity labels of a given database using an operations batch.", "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": "parameters", "in": "body", "description": "", "required": true, "schema": { "$ref": "./common.json#/definitions/SensitivityLabelUpdateList" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update sensitivity labels of a given database using an operations batch.": { "$ref": "./examples/SensitivityLabelsCurrentUpdate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels": { "get": { "operationId": "SensitivityLabels_ListRecommendedByDatabase", "tags": [ "SensitivityLabels" ], "description": "Gets the sensitivity labels of a given database", "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": "$skipToken", "in": "query", "required": false, "type": "string" }, { "name": "includeDisabledRecommendations", "in": "query", "description": "Specifies whether to include disabled recommendations or not.", "required": false, "type": "boolean" }, { "name": "$filter", "in": "query", "description": "An OData filter expression that filters elements in the collection.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/SensitivityLabelListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the recommended sensitivity labels of a given database": { "$ref": "./examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "patch": { "operationId": "RecommendedSensitivityLabels_Update", "tags": [ "SensitivityLabels" ], "description": "Update recommended sensitivity labels states of a given database using an operations batch.", "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": "parameters", "in": "body", "description": "", "required": true, "schema": { "$ref": "./common.json#/definitions/RecommendedSensitivityLabelUpdateList" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update recommended sensitivity labels of a given database using an operations batch.": { "$ref": "./examples/SensitivityLabelsRecommendedUpdate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}": { "get": { "operationId": "SensitivityLabels_Get", "tags": [ "SensitivityLabels" ], "description": "Gets the sensitivity label of a given column", "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": "schemaName", "in": "path", "description": "The name of the schema.", "required": true, "type": "string" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string" }, { "name": "columnName", "in": "path", "description": "The name of the column.", "required": true, "type": "string" }, { "name": "sensitivityLabelSource", "in": "path", "description": "The source of the sensitivity label.", "required": true, "type": "string", "enum": [ "current", "recommended" ], "x-ms-enum": { "name": "SensitivityLabelSource", "modelAsString": false, "values": [ { "name": "current", "value": "current", "description": "current" }, { "name": "recommended", "value": "recommended", "description": "recommended" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/SensitivityLabel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the sensitivity label of a given column": { "$ref": "./examples/ColumnSensitivityLabelGet.json" } } }, "put": { "operationId": "SensitivityLabels_CreateOrUpdate", "tags": [ "SensitivityLabels" ], "description": "Creates or updates the sensitivity label of a given column", "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": "schemaName", "in": "path", "description": "The name of the schema.", "required": true, "type": "string" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string" }, { "name": "columnName", "in": "path", "description": "The name of the column.", "required": true, "type": "string" }, { "name": "sensitivityLabelSource", "in": "path", "description": "The source of the sensitivity label.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "CurrentSensitivityLabelSource", "modelAsString": false, "values": [ { "name": "current", "value": "current", "description": "current" } ] } }, { "name": "parameters", "in": "body", "description": "The column sensitivity label resource.", "required": true, "schema": { "$ref": "./common.json#/definitions/SensitivityLabel" } } ], "responses": { "200": { "description": "Resource 'SensitivityLabel' update operation succeeded", "schema": { "$ref": "./common.json#/definitions/SensitivityLabel" } }, "201": { "description": "Resource 'SensitivityLabel' create operation succeeded", "schema": { "$ref": "./common.json#/definitions/SensitivityLabel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Updates the sensitivity label of a given column with all parameters": { "$ref": "./examples/ColumnSensitivityLabelCreateMax.json" } } }, "delete": { "operationId": "SensitivityLabels_Delete", "tags": [ "SensitivityLabels" ], "description": "Deletes the sensitivity label of a given column", "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": "schemaName", "in": "path", "description": "The name of the schema.", "required": true, "type": "string" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string" }, { "name": "columnName", "in": "path", "description": "The name of the column.", "required": true, "type": "string" }, { "name": "sensitivityLabelSource", "in": "path", "description": "The source of the sensitivity label.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "CurrentSensitivityLabelSource", "modelAsString": false, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes the sensitivity label of a given column": { "$ref": "./examples/ColumnSensitivityLabelDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/disable": { "post": { "operationId": "SensitivityLabels_DisableRecommendation", "tags": [ "SensitivityLabels" ], "description": "Disables sensitivity recommendations on a given column", "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": "schemaName", "in": "path", "description": "The name of the schema.", "required": true, "type": "string" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string" }, { "name": "columnName", "in": "path", "description": "The name of the column.", "required": true, "type": "string" }, { "name": "sensitivityLabelSource", "in": "path", "description": "The source of the sensitivity label.", "required": true, "type": "string", "enum": [ "recommended" ], "x-ms-enum": { "name": "RecommendedSensitivityLabelSource", "modelAsString": false, "values": [ { "name": "recommended", "value": "recommended", "description": "recommended" } ] } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Disables sensitivity recommendations on a given column": { "$ref": "./examples/RecommendedColumnSensitivityLabelDisable.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/enable": { "post": { "operationId": "SensitivityLabels_EnableRecommendation", "tags": [ "SensitivityLabels" ], "description": "Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)", "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": "schemaName", "in": "path", "description": "The name of the schema.", "required": true, "type": "string" }, { "name": "tableName", "in": "path", "description": "The name of the table.", "required": true, "type": "string" }, { "name": "columnName", "in": "path", "description": "The name of the column.", "required": true, "type": "string" }, { "name": "sensitivityLabelSource", "in": "path", "description": "The source of the sensitivity label.", "required": true, "type": "string", "enum": [ "recommended" ], "x-ms-enum": { "name": "RecommendedSensitivityLabelSource", "modelAsString": false, "values": [ { "name": "recommended", "value": "recommended", "description": "recommended" } ] } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Enables sensitivity recommendations on a given column": { "$ref": "./examples/RecommendedColumnSensitivityLabelEnable.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels": { "get": { "operationId": "SensitivityLabels_ListByDatabase", "tags": [ "SensitivityLabels" ], "description": "Gets the sensitivity labels of a given database", "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": "$filter", "in": "query", "description": "An OData filter expression that filters elements in the collection.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/SensitivityLabelListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the current and recommended sensitivity labels of a given database": { "$ref": "./examples/SensitivityLabelsListByDatabase.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": {}, "parameters": {} }