|
156 | 156 | } |
157 | 157 | } |
158 | 158 | } |
| 159 | + }, |
| 160 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/transparentDataEncryption": { |
| 161 | + "get": { |
| 162 | + "tags": [ |
| 163 | + "ManagedDatabaseTransparentDataEncryption" |
| 164 | + ], |
| 165 | + "description": "Gets a list of managed database's transparent data encryptions.", |
| 166 | + "operationId": "ManagedDatabaseTransparentDataEncryption_ListByDatabase", |
| 167 | + "parameters": [ |
| 168 | + { |
| 169 | + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" |
| 170 | + }, |
| 171 | + { |
| 172 | + "name": "managedInstanceName", |
| 173 | + "in": "path", |
| 174 | + "description": "The name of the managed instance.", |
| 175 | + "required": true, |
| 176 | + "type": "string" |
| 177 | + }, |
| 178 | + { |
| 179 | + "name": "databaseName", |
| 180 | + "in": "path", |
| 181 | + "description": "The name of the managed database for which the transparent data encryption is defined.", |
| 182 | + "required": true, |
| 183 | + "type": "string" |
| 184 | + }, |
| 185 | + { |
| 186 | + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" |
| 187 | + }, |
| 188 | + { |
| 189 | + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" |
| 190 | + } |
| 191 | + ], |
| 192 | + "responses": { |
| 193 | + "200": { |
| 194 | + "description": "Successfully retrieved the list of managed database transparent data encryptions.", |
| 195 | + "schema": { |
| 196 | + "$ref": "#/definitions/ManagedTransparentDataEncryptionListResult" |
| 197 | + } |
| 198 | + }, |
| 199 | + "default": { |
| 200 | + "description": "*** Error Responses: ***\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 ReadOnly - Cannot enable or modify database encryption on a database that is read-only, has read-only files or is not recovered.\n\n * 400 CanNotDropAlterOnMirror - Please modify Transparent Data Encryption on the primary databases.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 401 CanNotChangeReadOnlyDuringTdeScan - Cannot modify filegroup read-only/read-write state while an encryption transition is in progress.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 NeedsLogBackup - Please wait several minutes for a log backup to occur. \n\n * 409 EncryptionInProgress - Cannot modify encryption while an encryption scan in progress.\n\n * 409 KeyChangeInProgress - Cannot change database encryption key while an encryption, decryption, or key change scan is in progress.\n\n * 409 NoBulkOperationLock - CREATE/ALTER/DROP DATABASE ENCRYPTION KEY failed because a lock could not be placed on database. Try again later.\n\n * 409 AltStateConflict - The operation cannot be performed on database because it is involved in a database mirroring session or an availability group. Some operations are not allowed on a database that is participating in a database mirroring session or in an availability group.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 NoDekLock - CREATE/ALTER/DROP DATABASE ENCRYPTION KEY failed because a lock could not be placed on the database. Try again later." |
| 201 | + } |
| 202 | + }, |
| 203 | + "x-ms-pageable": { |
| 204 | + "nextLinkName": "nextLink" |
| 205 | + }, |
| 206 | + "x-ms-examples": { |
| 207 | + "Get a list of the database's transparent data encryptions": { |
| 208 | + "$ref": "./examples/ManagedTransparentDataEncryptionList.json" |
| 209 | + } |
| 210 | + } |
| 211 | + } |
159 | 212 | } |
160 | 213 | }, |
161 | 214 | "definitions": { |
|
195 | 248 | "x-ms-client-flatten": true |
196 | 249 | } |
197 | 250 | } |
| 251 | + }, |
| 252 | + "ManagedTransparentDataEncryptionListResult": { |
| 253 | + "description": "A list of managed transparent data encryptions", |
| 254 | + "type": "object", |
| 255 | + "properties": { |
| 256 | + "value": { |
| 257 | + "description": "Array of results.", |
| 258 | + "type": "array", |
| 259 | + "items": { |
| 260 | + "$ref": "#/definitions/ManagedTransparentDataEncryption" |
| 261 | + }, |
| 262 | + "readOnly": true |
| 263 | + }, |
| 264 | + "nextLink": { |
| 265 | + "description": "Link to retrieve next page of results.", |
| 266 | + "type": "string", |
| 267 | + "readOnly": true |
| 268 | + } |
| 269 | + } |
198 | 270 | } |
199 | 271 | }, |
200 | 272 | "parameters": {}, |
|
0 commit comments