Server Keys - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a server key.

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

URI Parameters

Name In Required Type Description
keyName
 path True

string

The name of the server key to be retrieved.
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

ServerKey

Successfully retrieved the specified server key.
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.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

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

  • 404 ResourceNotFound - The requested resource was not found.

Examples

Get the server key

Sample request

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Definitions

Name Description
ServerKey

A server key.
ServerKeyType

The server key type like 'ServiceManaged', 'AzureKeyVault'.

ServerKey

A server key.

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.creationDate

string

The server key creation date.
properties.serverKeyType

ServerKeyType

The server key type like 'ServiceManaged', 'AzureKeyVault'.
properties.subregion

string

Subregion of the server key.
properties.thumbprint

string

Thumbprint of the server key.
properties.uri

string

The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type

string

Resource type.

ServerKeyType

The server key type like 'ServiceManaged', 'AzureKeyVault'.

Name Type Description
AzureKeyVault

string

ServiceManaged

string