Encryption Protectors - List By Server

  • Referencia
Servicio:
SQL Database
Versión de la API:
2021-11-01

Obtiene una lista de protectores de cifrado de servidor.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName
 path True

string

El nombre del servidor.
subscriptionId
 path True

string

El id. de suscripción que identifica una suscripción de Azure.
api-version
 query True

string

La versión de API que se usará para la solicitud.

Respuestas

Nombre Tipo Description
200 OK

EncryptionProtectorListResult

Se recuperó correctamente la lista del protector de cifrado del servidor.
Other Status Codes

Respuestas de error: ***

  • 400 InvalidKeyName: se ha proporcionado un valor no válido para el nombre de clave del servidor.

  • 400 InvalidKeyType: no se admite el tipo de clave de servidor create.

  • 400 InvalidUpsertKeyType: el servicio administra las claves TDE administradas por el servicio. Las claves TDE administradas por el servicio no admiten la creación o actualización por parte del usuario.

  • 400 InvalidKeyUpsertRequest: la solicitud de creación de clave del servidor no existe o no tiene ningún objeto de propiedades.

  • 400 InvalidEncryptionProtectorName: no se admite el nombre de clave del protector de cifrado.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado

  • 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Ejemplos

List encryption protectors by server

Solicitud de ejemplo

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

Respuesta de muestra

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"
      }
    }
  ]
}

Definiciones

Nombre Description
EncryptionProtector

Protector de cifrado del servidor.
EncryptionProtectorListResult

Lista de protectores de cifrado de servidor.
ServerKeyType

El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Protector de cifrado del servidor.

Nombre Tipo Description
id

string

Identificador del recurso.
kind

string

Tipo de protector de cifrado. Estos son los metadatos que se usan para la experiencia de Azure Portal.
location

string

Ubicación del recurso
name

string

Nombre del recurso.
properties.autoRotationEnabled

boolean

Marca de participación de rotación automática de claves. Puede ser true o false.
properties.serverKeyName

string

Nombre de la clave de servidor.
properties.serverKeyType

ServerKeyType

El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".
properties.subregion

string

Subregión del protector de cifrado.
properties.thumbprint

string

Huella digital de la clave del servidor.
properties.uri

string

URI de la clave de servidor.
type

string

Tipo de recurso.

EncryptionProtectorListResult

Lista de protectores de cifrado de servidor.

Nombre Tipo Description
nextLink

string

Vínculo para recuperar la página siguiente de resultados.
value

EncryptionProtector[]

Matriz de resultados.

ServerKeyType

El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".

Nombre Tipo Description
AzureKeyVault

string

ServiceManaged

string