Get Deleted Keys - Get Deleted Keys

Référence

Service:: Key Vault

API Version:: 7.4

Listes les clés supprimées dans le coffre spécifié.
Récupère une liste des clés dans le Key Vault en tant que structures de clé web JSON qui contiennent la partie publique d’une clé supprimée. Cette opération inclut des informations spécifiques à la suppression. L’opération Obtenir les clés supprimées s’applique aux coffres activés pour la suppression réversible. Bien que l’opération puisse être appelée sur n’importe quel coffre, elle retourne une erreur si elle est appelée sur un coffre non activé pour la suppression réversible. Cette opération nécessite l’autorisation clés/liste.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.
maxresults	query		integer int32	Nombre maximal de résultats à retourner dans une page. S’il n’est pas spécifié, le service retourne jusqu’à 25 résultats.

Réponses

Nom	Type	Description
200 OK	DeletedKeyListResult	Message de réponse contenant une liste de clés supprimées dans le coffre, ainsi qu’un lien vers la page suivante de clés supprimées.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

GetDeletedKeys

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedkeys/listdeletedkeytest0",
      "deletedDate": 1493938031,
      "scheduledPurgeDate": 1501714031,
      "kid": "https://myvault.vault.azure.net/keys/listdeletedkeytest0",
      "attributes": {
        "enabled": true,
        "created": 1493938031,
        "updated": 1493938031,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedkeys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Définitions

Nom	Description
DeletedKeyItem	Élément de clé supprimé contenant les métadonnées de clé supprimées et des informations sur la suppression.
DeletedKeyListResult	Liste des clés qui ont été supprimées dans ce coffre.
DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.
Error	Erreur du serveur du coffre de clés.
KeyAttributes	Attributs d’une clé gérée par le service de coffre de clés.
KeyVaultError	Exception d’erreur du coffre de clés.

DeletedKeyItem

Élément de clé supprimé contenant les métadonnées de clé supprimées et des informations sur la suppression.

Nom	Type	Description
attributes	KeyAttributes	Attributs de gestion des clés.
deletedDate	integer	Heure à laquelle la clé a été supprimée, en UTC
kid	string	Identificateur de clé.
managed	boolean	True si la durée de vie de la clé est gérée par le coffre de clés. S’il s’agit d’une clé qui soutient un certificat, la valeur gérée est true.
recoveryId	string	URL de l’objet de récupération, utilisée pour identifier et récupérer la clé supprimée.
scheduledPurgeDate	integer	Heure à laquelle le vidage de la clé est planifié, en UTC
tags	object	Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

DeletedKeyListResult

Liste des clés qui ont été supprimées dans ce coffre.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble suivant de clés supprimées.
value	DeletedKeyItem[]	Message de réponse contenant une liste de clés supprimées dans le coffre, ainsi qu’un lien vers la page suivante de clés supprimées

DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.

Nom	Type	Description
CustomizedRecoverable	string	Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription	string	Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.
CustomizedRecoverable+Purgeable	string	Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (par exemple, la suppression lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de vidage est demandée ou que l’abonnement est annulé.
Purgeable	string	Indique un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération De suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération De suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Recoverable	string	Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+ProtectedSubscription	string	Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire le vidage) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+Purgeable	string	Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également la suppression immédiate et définitive (c’est-à-dire le vidage). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de vidage est demandée ou que l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

KeyAttributes

Attributs d’une clé gérée par le service de coffre de clés.

Nom	Type	Description
created	integer	Heure de création en UTC.
enabled	boolean	Détermine si l’objet est activé.
exp	integer	Date d’expiration en UTC.
exportable	boolean	Indique si la clé privée peut être exportée. Une stratégie de mise en production doit être fournie lors de la création de la première version d’une clé exportable.
nbf	integer	Date non antérieure en UTC.
recoverableDays	integer	softDelete data retention days. La valeur doit être >=7 et <=90 lorsque softDelete est activé, sinon 0.
recoveryLevel	DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.
updated	integer	Heure de la dernière mise à jour au format UTC.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.