{ "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": "ManagedInstanceEncryptionProtectors" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector": { "get": { "operationId": "ManagedInstanceEncryptionProtectors_ListByInstance", "tags": [ "ManagedInstanceEncryptionProtectors" ], "description": "Gets a list of managed instance encryption protectors", "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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedInstanceEncryptionProtectorListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List encryption protectors by managed instance": { "$ref": "./examples/ManagedInstanceEncryptionProtectorList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}": { "get": { "operationId": "ManagedInstanceEncryptionProtectors_Get", "tags": [ "ManagedInstanceEncryptionProtectors" ], "description": "Gets a managed instance encryption protector.", "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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" }, { "name": "encryptionProtectorName", "in": "path", "description": "The name of the encryption protector to be retrieved.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "EncryptionProtectorName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedInstanceEncryptionProtector" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the encryption protector": { "$ref": "./examples/ManagedInstanceEncryptionProtectorGet.json" } } }, "put": { "operationId": "ManagedInstanceEncryptionProtectors_CreateOrUpdate", "tags": [ "ManagedInstanceEncryptionProtectors" ], "description": "Updates an existing encryption protector.", "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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" }, { "name": "encryptionProtectorName", "in": "path", "description": "The name of the encryption protector to be retrieved.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "EncryptionProtectorName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } }, { "name": "parameters", "in": "body", "description": "The requested encryption protector resource state.", "required": true, "schema": { "$ref": "#/definitions/ManagedInstanceEncryptionProtector" } } ], "responses": { "200": { "description": "Resource 'ManagedInstanceEncryptionProtector' update operation succeeded", "schema": { "$ref": "#/definitions/ManagedInstanceEncryptionProtector" } }, "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 the encryption protector to key vault": { "$ref": "./examples/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json" }, "Update the encryption protector to service managed": { "$ref": "./examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ManagedInstanceEncryptionProtector" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}/revalidate": { "post": { "operationId": "ManagedInstanceEncryptionProtectors_Revalidate", "tags": [ "ManagedInstanceEncryptionProtectors" ], "description": "Revalidates an existing encryption protector.", "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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" }, { "name": "encryptionProtectorName", "in": "path", "description": "The name of the encryption protector to be retrieved.", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "EncryptionProtectorName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "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": { "Revalidates the encryption protector": { "$ref": "./examples/ManagedInstanceEncryptionProtectorRevalidate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "ManagedInstanceEncryptionProtector": { "type": "object", "description": "The managed instance encryption protector.", "properties": { "properties": { "$ref": "#/definitions/ManagedInstanceEncryptionProtectorProperties", "description": "Resource properties.", "x-ms-client-flatten": true }, "kind": { "type": "string", "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ManagedInstanceEncryptionProtectorListResult": { "type": "object", "description": "The response of a ManagedInstanceEncryptionProtector list operation.", "properties": { "value": { "type": "array", "description": "The ManagedInstanceEncryptionProtector items on this page", "items": { "$ref": "#/definitions/ManagedInstanceEncryptionProtector" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ManagedInstanceEncryptionProtectorProperties": { "type": "object", "description": "Properties for an encryption protector execution.", "properties": { "serverKeyName": { "type": "string", "description": "The name of the managed instance key." }, "serverKeyType": { "$ref": "./common.json#/definitions/ServerKeyType", "description": "The encryption protector type like 'ServiceManaged', 'AzureKeyVault'." }, "uri": { "type": "string", "description": "The URI of the server key.", "readOnly": true }, "thumbprint": { "type": "string", "description": "Thumbprint of the server key.", "readOnly": true }, "autoRotationEnabled": { "type": "boolean", "description": "Key auto rotation opt-in flag. Either true or false." } }, "required": [ "serverKeyType" ] } }, "parameters": {} }