Encryption Protectors - List By Server

Servicio:

SQL Database

Versión de la API:

2023-08-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=2023-08-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 desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a 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	ErrorResponse	Respuestas de error: *** 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio 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 de servidor no existe o no tiene ningún objeto properties. 400 InvalidEncryptionProtectorName: no se admite el nombre de la clave del protector de cifrado. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

Ejemplos

List encryption protectors by server

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector?api-version=2023-08-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.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Object

Protector de cifrado del servidor.

Nombre	Tipo	Description
id	string	Identificador de 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. 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	Subdivisión del protector de cifrado.
properties.thumbprint	string	Huella digital de la clave del servidor.
properties.uri	string	Identificador URI de la clave del servidor.
type	string	Tipo de recurso.

EncryptionProtectorListResult

Object

Lista de protectores de cifrado de servidor.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	EncryptionProtector[]	Matriz de resultados.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ServerKeyType

Enumeración

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

Valor	Description
AzureKeyVault
ServiceManaged