{ "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": "TransparentDataEncryptions" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption": { "get": { "operationId": "TransparentDataEncryptions_ListByDatabase", "tags": [ "TransparentDataEncryptions" ], "description": "Gets a list of the logical database's transparent data encryption.", "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" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of the database's transparent data encryption": { "$ref": "./examples/TransparentDataEncryptionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}": { "get": { "operationId": "TransparentDataEncryptions_Get", "tags": [ "TransparentDataEncryptions" ], "description": "Gets a logical database's transparent data encryption.", "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": "tdeName", "in": "path", "description": "The name of the transparent data encryption configuration.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "TransparentDataEncryptionName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a database's transparent data encryption": { "$ref": "./examples/TransparentDataEncryptionGet.json" } } }, "put": { "operationId": "TransparentDataEncryptions_CreateOrUpdate", "tags": [ "TransparentDataEncryptions" ], "description": "Updates a logical database's transparent data encryption configuration.", "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": "tdeName", "in": "path", "description": "The name of the transparent data encryption configuration.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "TransparentDataEncryptionName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } }, { "name": "parameters", "in": "body", "description": "The database transparent data encryption.", "required": true, "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" } } ], "responses": { "200": { "description": "Resource 'LogicalDatabaseTransparentDataEncryption' update operation succeeded", "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" } }, "201": { "description": "Resource 'LogicalDatabaseTransparentDataEncryption' create operation succeeded", "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" } } }, "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": { "Update a database's Transparent Data Encryption state with minimal parameters": { "$ref": "./examples/TransparentDataEncryptionUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/LogicalDatabaseTransparentDataEncryption" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}/resume": { "post": { "operationId": "TransparentDataEncryptions_Resume", "tags": [ "TransparentDataEncryptions" ], "description": "Resume ongoing logical database's Transparent Data Encryption scan configuration.", "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": "tdeName", "in": "path", "description": "The name of the transparent data encryption configuration.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "TransparentDataEncryptionName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" } }, "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": { "Resume database's Transparent Data Encryption scan state with minimal parameters": { "$ref": "./examples/ResumeTransparentDataEncryptionUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LogicalDatabaseTransparentDataEncryption" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}/suspend": { "post": { "operationId": "TransparentDataEncryptions_Suspend", "tags": [ "TransparentDataEncryptions" ], "description": "Suspend ongoing logical database's Transparent Data Encryption scan configuration.", "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": "tdeName", "in": "path", "description": "The name of the transparent data encryption configuration.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "TransparentDataEncryptionName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" } }, "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": { "Suspend database's Transparent Data Encryption scan state with minimal parameters": { "$ref": "./examples/SuspendTransparentDataEncryptionUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LogicalDatabaseTransparentDataEncryption" }, "x-ms-long-running-operation": true } } }, "definitions": { "LogicalDatabaseTransparentDataEncryption": { "type": "object", "description": "A logical database transparent data encryption scan state.", "properties": { "properties": { "$ref": "#/definitions/TransparentDataEncryptionProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "LogicalDatabaseTransparentDataEncryptionListResult": { "type": "object", "description": "The response of a LogicalDatabaseTransparentDataEncryption list operation.", "properties": { "value": { "type": "array", "description": "The LogicalDatabaseTransparentDataEncryption items on this page", "items": { "$ref": "#/definitions/LogicalDatabaseTransparentDataEncryption" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TransparentDataEncryptionProperties": { "type": "object", "description": "Properties of a transparent data encryption scan.", "properties": { "state": { "$ref": "./common.json#/definitions/TransparentDataEncryptionState", "description": "Specifies the state of the transparent data encryption." }, "scanState": { "$ref": "./common.json#/definitions/TransparentDataEncryptionScanState", "description": "Specifies the encryption scan state of the transparent data encryption." } }, "required": [ "state" ] } }, "parameters": {} }