Recover Deleted Key - Recover Deleted Key

Service:: Key Vault

Version d'API:: 2025-07-01

Récupère la clé supprimée dans sa dernière version.
L’opération Récupérer la clé supprimée s’applique aux clés supprimées dans les coffres-forts activés pour la suppression réversible. Elle récupère la clé supprimée vers sa dernière version sous /keys. Une tentative de récupération d’une clé non supprimée retourne une erreur. Considérez cela comme l’inverse de l’opération de suppression sur les coffres-forts activés pour la suppression réversible. Cette opération nécessite l’autorisation clés/récupération.

POST {vaultBaseUrl}/deletedkeys/{key-name}/recover?api-version=2025-07-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
key-name	path	True	string	Nom de la clé supprimée.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	KeyBundle	La demande a réussi.
Other Status Codes	KeyVaultError	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://vault.azure.net/.default

Exemples

RecoverDeletedKey

Exemple de requête

HTTP

POST https://myvault.vault.azure.net//deletedkeys/CreateDeleteRecoverPurgeTest/recover?api-version=2025-07-01

Exemple de réponse

Code d’état:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493938342,
    "updated": 1493938342,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateDeleteRecoverPurgeTest"
  }
}

Définitions

Nom	Description
DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgable », le certificat peut être définitivement supprimé par un utilisateur privilégié ; Dans le cas contraire, seul le système peut purger le certificat, à la fin de l’intervalle de rétention.
Error
JsonWebKey	À compter du http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.
JsonWebKeyType	Type de clé JsonWebKey (kty), tel que défini dans .https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40
KeyAttestation	Les informations clés de l’attestation.
KeyAttributes	Attributs d’une clé gérée par le service de coffre de clés.
KeyBundle	KeyBundle composé d’une WebKey et de ses attributs.
KeyReleasePolicy	Règles de stratégie selon lesquelles la clé peut être exportée.
KeyVaultError	Exception d’erreur du coffre de clés.

DeletionRecoveryLevel

Énumération

Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgable », le certificat peut être définitivement supprimé par un utilisateur privilégié ; Dans le cas contraire, seul le système peut purger le certificat, à la fin de l’intervalle de rétention.

Valeur	Description
Purgeable	Désigne un état de coffre-fort dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection 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 supérieur (coffre-fort, groupe de ressources, abonnement, etc.)
Recoverable+Purgeable	Désigne un état de coffre-fort dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et permanente (c’est-à-dire la purge). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de purge est demandée ou si l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable	Désigne un état de coffre-fort dans lequel la suppression est récupérable sans possibilité de suppression immédiate et permanente (c’est-à-dire la purge). Ce niveau garantit la récupérabilité 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	Désigne un état de coffre-fort et d’abonnement dans lequel la suppression est récupérable dans un intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la purge) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé de manière permanente. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
CustomizedRecoverable+Purgeable	Désigne un état de coffre-fort dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et permanente (c’est-à-dire la purge lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de purge est demandée ou si l’abonnement est annulé.
CustomizedRecoverable	Désigne un état de coffre-fort dans lequel la suppression est récupérable sans possibilité de suppression immédiate et permanente (c’est-à-dire purge lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupérabilité de l’entité supprimée pendant l’intervalle de rétention et pendant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription	Désigne un état de coffre-fort et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et permanente (c’est-à-dire la purge) 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érabilité 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é.

Error

Object

Nom	Type	Description
code	string	Code d’erreur.
innererror	Error	Erreur de serveur Key Vault.
message	string	Message d’erreur.

JsonWebKey

Object

À compter du http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Nom	Type	Description
crv	JsonWebKeyCurveName	Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.
d	string (base64url)	Exposant privé RSA, ou composant D d’une clé privée EC.
dp	string (base64url)	Paramètre de clé privée RSA.
dq	string (base64url)	Paramètre de clé privée RSA.
e	string (base64url)	Exposant public RSA.
k	string (base64url)	Clé symétrique.
key_hsm	string (base64url)	Clé protégée, utilisée avec « Bring Your Own Key ».
key_ops	string[]	Opérations de clé Web Json. Pour plus d’informations sur les opérations de clé possibles, consultez JsonWebKeyOperation.
kid	string	Identificateur de clé.
kty	JsonWebKeyType	Type de clé JsonWebKey (kty), tel que défini dans .https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40
n	string (base64url)	Module RSA.
p	string (base64url)	Clé secrète RSA.
q	string (base64url)	Secret prime RSA, avec p < q.
qi	string (base64url)	Paramètre de clé privée RSA.
x	string (base64url)	X d’une clé publique EC.
y	string (base64url)	Composant Y d’une clé publique EC.

JsonWebKeyCurveName

Énumération

Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.

Valeur	Description
P-256	La courbe elliptique NIST P-256, alias courbe SECG SECP256R1.
P-384	La courbe elliptique NIST P-384, alias courbe SECG SECP384R1.
P-521	La courbe elliptique NIST P-521, alias courbe SECG SECP521R1.
P-256K	Le SECG SECP256K1 courbe elliptique.

JsonWebKeyType

Énumération

Type de clé JsonWebKey (kty), tel que défini dans .https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40

Valeur	Description
EC	Courbe elliptique.
EC-HSM	Courbe elliptique avec une clé privée stockée dans le HSM.
RSA	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	RSA avec une clé privée qui est stockée dans le HSM.
oct	Séquence d’octets (utilisée pour représenter les clés symétriques)
oct-HSM	Séquence d’octets (utilisée pour représenter les clés symétriques) qui est stockée dans le HSM.

KeyAttestation

Object

Les informations clés de l’attestation.

Nom	Type	Description
certificatePemFile	string (base64url)	Chaîne encodée en base64url contenant des certificats au format PEM, utilisée pour la validation de l’attestation.
privateKeyAttestation	string (base64url)	Les octets blob d’attestation encodés en tant que chaîne base64url correspondant à une clé privée.
publicKeyAttestation	string (base64url)	Les octets blob d’attestation encodés en tant que chaîne base64url correspondant à une clé publique en cas de clé asymétrique.
version	string	La version de l’attestation.

KeyAttributes

Object

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

Nom	Type	Description
attestation	KeyAttestation	Informations d’attestation de clé ou de version de clé.
created	integer (unixtime)	Heure de création en UTC.
enabled	boolean	Détermine si l’objet est activé.
exp	integer (unixtime)	Date d’expiration en UTC.
exportable	boolean	Indique si la clé privée peut être exportée. La politique de mise en production doit être fournie lors de la création de la première version d’une clé exportable.
hsmPlatform	string	La plate-forme HSM sous-jacente.
nbf	integer (unixtime)	Pas avant la date en UTC.
recoverableDays	integer (int32)	Jours de conservation des données softDelete. La valeur doit être >=7 et <=90 lorsque la suppression douce est activée, sinon 0.
recoveryLevel	DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés du coffre actuel. S’il contient 'Purgeable', la clé peut être définitivement supprimée par un utilisateur privilégié ; Dans le cas contraire, seul le système peut purger la clé, à la fin de l’intervalle de rétention.
updated	integer (unixtime)	Dernière mise à jour de l’heure en UTC.

KeyBundle

Object

KeyBundle composé d’une WebKey et de ses attributs.

Nom	Type	Description
attributes	KeyAttributes	Les principaux attributs de gestion.
key	JsonWebKey	La clé Web Json.
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é soutenant un certificat, alors managed sera true.
release_policy	KeyReleasePolicy	Règles de stratégie selon lesquelles la clé peut être exportée.
tags	object	Métadonnées spécifiques à l’application sous la forme de paires clé-valeur.

KeyReleasePolicy

Object

Règles de stratégie selon lesquelles la clé peut être exportée.

Nom	Type	Valeur par défaut	Description
contentType	string	application/json; charset=utf-8	Type de contenu et version de la stratégie de mise en production de clé
data	string (base64url)		Encodage d’objets blob des règles de stratégie sous lesquelles la clé peut être libérée. L’objet blob doit être encodé en URL en base64.
immutable	boolean		Définit l’état de mutabilité de la stratégie. Une fois marqué immuable, cet indicateur ne peut pas être réinitialisé et la stratégie ne peut pas être modifiée dans des circonstances quelconques.

KeyVaultError

Object

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur de serveur Key Vault.