Share via

Managed Instance Encryption Protectors - Get

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

Gets a managed instance encryption protector.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/current?api-version=2021-11-01

URI Parameters

Name In Required Type Description
encryptionProtectorName
 path True

EncryptionProtectorName

The name of the encryption protector to be retrieved.
managedInstanceName
 path True

string

The name of the managed instance.
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.
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

ManagedInstanceEncryptionProtector

Successfully retrieved the specified managed instance 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.

  • 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/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2021-11-01

Sample response

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

Definitions

Name Description
EncryptionProtectorName

The name of the encryption protector to be retrieved.
ManagedInstanceEncryptionProtector

The managed instance encryption protector.
ServerKeyType

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

EncryptionProtectorName

The name of the encryption protector to be retrieved.

Name Type Description
current

string

ManagedInstanceEncryptionProtector

The managed instance encryption protector.

Name Type Description
id

string

Resource ID.
kind

string

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

string

Resource name.
properties.autoRotationEnabled

boolean

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

string

The name of the managed instance key.
properties.serverKeyType

ServerKeyType

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

string

Thumbprint of the server key.
properties.uri

string

The URI of the server key.
type

string

Resource type.

ServerKeyType

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

Name Type Description
AzureKeyVault

string

ServiceManaged

string