Encryption Protectors - List By Server

  • Reference
Service:
SQL Database
API Version:
2021-02-01-preview

Gets a list of server encryption protectors

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

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

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

*** Error Responses: ***

  • 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 SubscriptionDoesNotHaveServer - The requested server was not found

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

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=2021-02-01-preview

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

EncryptionProtector

The server encryption protector.
EncryptionProtectorListResult

A list of server encryption protectors.
ServerKeyType

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

EncryptionProtector

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

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

A list of server encryption protectors.

Name Type Description
nextLink
  • string

Link to retrieve next page of results.
value

Array of results.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string