Share via

Encryption Protectors - List By Server

  • Reference
Service:
SQL Database
API Version:
2023-08-01

Gets a list of server encryption protectors

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector?api-version=2023-08-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
 path True

string

The name of the server.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

EncryptionProtectorListResult

Successfully retrieved the list of server encryption protector.
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state

  • 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state

  • 400 InvalidKeyName - An invalid value was given for the server key name.

  • 400 InvalidKeyType - The create server key type is not supported.

  • 400 InvalidUpsertKeyType - Service-managed TDE keys are managed by the service. Service-managed TDE keys don't support Create or Update by the user.

  • 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.

  • 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

Examples

List encryption protectors by server

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector?api-version=2023-08-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
      "name": "current",
      "type": "Microsoft.Sql/servers/encryptionProtector",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
        "serverKeyType": "AzureKeyVault",
        "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
      }
    }
  ]
}

Definitions

Name Description
EncryptionProtector

The server encryption protector.
EncryptionProtectorListResult

A list of server encryption protectors.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ServerKeyType

The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.

EncryptionProtector

Object

The server encryption protector.

Name Type Description
id

string

Resource ID.
kind

string

Kind of encryption protector. This is metadata used for the Azure portal experience.
location

string

Resource location.
name

string

Resource name.
properties.autoRotationEnabled

boolean

Key auto rotation opt-in flag. Either true or false.
properties.serverKeyName

string

The name of the server key.
properties.serverKeyType

ServerKeyType

The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
properties.subregion

string

Subregion of the encryption protector.
properties.thumbprint

string

Thumbprint of the server key.
properties.uri

string

The URI of the server key.
type

string

Resource type.

EncryptionProtectorListResult

Object

A list of server encryption protectors.

Name Type Description
nextLink

string

Link to retrieve next page of results.
value

EncryptionProtector[]

Array of results.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

ServerKeyType

Enumeration

The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.

Value Description
AzureKeyVault
ServiceManaged