Get Deleted Secrets - Get Deleted Secrets

Referencia

Service:: Key Vault

API Version:: 7.4

Listas secretos eliminados para el almacén especificado.
La operación Obtener secretos eliminados devuelve los secretos que se han eliminado para un almacén habilitado para la eliminación temporal. Esta operación requiere el permiso secrets/list.

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

With optional parameters:

GET {vaultBaseUrl}/deletedsecrets?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	DeletedSecretListResult	Mensaje de respuesta que contiene una lista de secretos eliminados en el almacén, junto con un vínculo a la página siguiente de secretos eliminados.
Other Status Codes	KeyVaultError	Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

GetDeletedSecrets

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/listdeletedsecrettest0",
      "deletedDate": 1493937855,
      "scheduledPurgeDate": 1501713855,
      "contentType": "plainText",
      "id": "https://myvault.vault.azure.net/secrets/listdeletedsecrettest0",
      "attributes": {
        "enabled": true,
        "created": 1493937855,
        "updated": 1493937855,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedsecrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3THpZMU16ZERSRVJGTlRJNU5qUkRSa1pDTVRkQ1JVWXhORGszUXpSQ1JEZEVJVEF3TURBeU9DRXlNREUzTFRBMUxUQTBWREl5T2pRME9qUXdMamsxTnpZeE1UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

Definiciones

Nombre	Description
DeletedSecretItem	Elemento secreto eliminado que contiene metadatos sobre el secreto eliminado.
DeletedSecretListResult	Resultado de la lista de secretos eliminados
DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; de lo contrario, solo el sistema puede purgar el secreto al final del intervalo de retención.
Error	Error del servidor del almacén de claves.
KeyVaultError	Excepción de error del almacén de claves.
SecretAttributes	Atributos de administración de secretos.

DeletedSecretItem

Elemento secreto eliminado que contiene metadatos sobre el secreto eliminado.

Nombre	Tipo	Description
attributes	SecretAttributes	Atributos de administración de secretos.
contentType	string	Tipo del valor del secreto, como una contraseña.
deletedDate	integer	Hora a la que se eliminó el secreto, en UTC
id	string	Identificador de secreto.
managed	boolean	True si el almacén de claves administra la duración del secreto. Si se trata de una clave que respalda un certificado, la administración será true.
recoveryId	string	Dirección URL del objeto de recuperación, que se usa para identificar y recuperar el secreto eliminado.
scheduledPurgeDate	integer	Hora a la que se programa la purga del secreto, en UTC
tags	object	Metadatos específicos de la aplicación en forma de pares clave-valor.

DeletedSecretListResult

Resultado de la lista de secretos eliminados

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

DeletionRecoveryLevel

Refleja el nivel de recuperación de eliminación actualmente en vigor para los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; de lo contrario, solo el sistema puede purgar el secreto 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.

KeyVaultError

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

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

SecretAttributes

Atributos de administración de secretos.

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.
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 los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; de lo contrario, solo el sistema puede purgar el secreto al final del intervalo de retención.
updated	integer	Hora de la última actualización en UTC.

Share via