Encryption Protectors - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a server encryption protector.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/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.
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	EncryptionProtector	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 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

HTTP

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

Java

import com.azure.resourcemanager.sql.models.EncryptionProtectorName;

/**
 * Samples for EncryptionProtectors Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/EncryptionProtectorGet.json
     */
    /**
     * Sample code: Get the encryption protector.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getTheEncryptionProtector(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().getWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", EncryptionProtectorName.CURRENT, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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",
    "autoRotationEnabled": false
  }
}

Definitions

Name	Description
EncryptionProtector	The server encryption protector.
EncryptionProtectorName	The name of the encryption protector to be retrieved.
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	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.

EncryptionProtectorName

The name of the encryption protector to be retrieved.

Name	Type	Description
current	string

ServerKeyType

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

Name	Type	Description
AzureKeyVault	string
ServiceManaged	string