Encryption Protectors - Get

Gets a server encryption protector.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

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.

encryptionProtectorName
path True

The name of the encryption protector to be retrieved.

api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

Successfully retrieved the specified 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 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 ResourceNotFound - The requested resource was not found.

Examples

Get the encryption protector

Sample Request

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

Sample Response

{
  "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
EncryptionProtectorName

The name of the encryption protector to be retrieved.

ServerKeyType

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

Name Type Description
kind
  • string

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

location
  • string

Resource location.

serverKeyName
  • string

The name of the server key.

serverKeyType

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

subregion
  • string

Subregion of the encryption protector.

thumbprint
  • string

Thumbprint of the server key.

uri
  • string

The URI of the server key.

The name of the encryption protector to be retrieved.

Name Description
current

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

Name Description
AzureKeyVault
ServiceManaged