Get Keys - Get Keys

Referencia

Service:: Key Vault

API Version:: 7.4

Enumerar claves en el almacén especificado.
Recupera una lista de las claves de Key Vault como estructuras de Clave de web JSON que contienen la parte pública de una clave almacenada. La operación LIST se aplica a todos los tipos de clave, pero solo se proporcionan el identificador de clave base, los atributos y las etiquetas en la respuesta. La respuesta no enumera las versiones individuales de una clave. Esta operación requiere el permiso keys/list.

GET {vaultBaseUrl}/keys?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
vaultBaseUrl	path	True	string	El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versión de API del cliente.
maxresults	query		integer int32	Número máximo de resultados que se van a devolver en una página. Si no se especifica, el servicio devolverá hasta 25 resultados.

Respuestas

Nombre	Tipo	Description
200 OK	KeyListResult	Mensaje de respuesta que contiene una lista de claves en el almacén junto con un vínculo a la página siguiente de claves.
Other Status Codes	KeyVaultError	Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

GetKeys

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Definiciones

Nombre	Description
DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.
Error	Error del servidor del almacén de claves.
KeyAttributes	Atributos de una clave administrada por el servicio del almacén de claves.
KeyItem	Elemento clave que contiene metadatos de clave.
KeyListResult	Resultado de la lista de claves.
KeyVaultError	Excepción de error del almacén de claves.

DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.

Nombre	Tipo	Description
CustomizedRecoverable	string	Indica un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible.
CustomizedRecoverable+ProtectedSubscription	string	Indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, la purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente cuando 7<= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción.
CustomizedRecoverable+Purgeable	string	Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción.
Purgeable	string	Indica un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; los datos se pierden irrecuperablemente al aceptar una operación de eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.).
Recoverable	string	Denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+ProtectedSubscription	string	Indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar dentro del intervalo de retención (90 días), no se permite la eliminación inmediata y permanente (es decir, purga) y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+Purgeable	string	Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera

Error

Error del servidor del almacén de claves.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	Error del servidor del almacén de claves.
message	string	El mensaje de error.

KeyAttributes

Atributos de una clave administrada por el servicio del almacén de claves.

Nombre	Tipo	Description
created	integer	Hora de creación en UTC.
enabled	boolean	Determina si el objeto está habilitado.
exp	integer	Fecha de expiración en UTC.
exportable	boolean	Indica si se puede exportar la clave privada. Se debe proporcionar la directiva de versión al crear la primera versión de una clave exportable.
nbf	integer	No antes de la fecha en UTC.
recoverableDays	integer	días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete está habilitado; en caso contrario, 0.
recoveryLevel	DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.
updated	integer	Hora de la última actualización en UTC.

KeyItem

Elemento clave que contiene metadatos de clave.

Nombre	Tipo	Description
attributes	KeyAttributes	Atributos de administración de claves.
kid	string	Identificador de clave.
managed	boolean	True si el almacén de claves administra la duración de la clave. Si se trata de una clave que respalda un certificado, la administración será true.
tags	object	Metadatos específicos de la aplicación en forma de pares clave-valor.

KeyListResult

Resultado de la lista de claves.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de claves.
value	KeyItem[]	Mensaje de respuesta que contiene una lista de claves en el almacén de claves junto con un vínculo a la página siguiente de claves.

KeyVaultError

Excepción de error del almacén de claves.

Nombre	Tipo	Description
error	Error	Error del servidor del almacén de claves.