Partager via

Get Deleted Certificates - Get Deleted Certificates

  • Référence
Service:
Key Vault
API Version:
7.4

Listes les certificats supprimés dans le coffre spécifié actuellement disponibles pour la récupération.
L’opération GetDeletedCertificates récupère les certificats dans le coffre actuel qui sont dans un état supprimé et prêts pour la récupération ou le vidage. Cette opération inclut des informations spécifiques à la suppression. Cette opération nécessite l’autorisation certificats/get/list. Cette opération ne peut être activée que sur les coffres avec suppression réversible.

GET {vaultBaseUrl}/deletedcertificates?api-version=7.4
With optional parameters: 
GET {vaultBaseUrl}/deletedcertificates?maxresults={maxresults}&includePending={includePending}&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.
includePending
 query

boolean

Spécifie s’il faut inclure des certificats qui ne sont pas complètement provisionnés.
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

DeletedCertificateListResult

Message de réponse contenant une liste de certificats supprimés dans le coffre, ainsi qu’un lien vers la page suivante de certificats supprimés
Other Status Codes

KeyVaultError

Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

GetDeletedCertificates

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0",
      "deletedDate": 1493937659,
      "scheduledPurgeDate": 1501713659,
      "id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1493937658,
        "updated": 1493937658,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Définitions

Nom Description
CertificateAttributes

Attributs de gestion des certificats.
DeletedCertificateItem

Élément de certificat supprimé contenant les métadonnées relatives au certificat supprimé.
DeletedCertificateListResult

Liste des certificats qui ont été supprimés dans ce coffre.
DeletionRecoveryLevel

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

Erreur du serveur du coffre de clés.
KeyVaultError

Exception d’erreur du coffre de clés.

CertificateAttributes

Attributs de gestion des certificats.

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.
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 certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à la fin de l’intervalle de rétention.
updated

integer

Heure de la dernière mise à jour au format UTC.

DeletedCertificateItem

Élément de certificat supprimé contenant les métadonnées relatives au certificat supprimé.

Nom Type Description
attributes

CertificateAttributes

Attributs de gestion des certificats.
deletedDate

integer

Heure à laquelle le certificat a été supprimé, en UTC
id

string

Identificateur du certificat.
recoveryId

string

URL de l’objet de récupération, utilisée pour identifier et récupérer le certificat supprimé.
scheduledPurgeDate

integer

Heure à laquelle le vidage du certificat est planifié, en UTC
tags

object

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.
x5t

string

Empreinte numérique du certificat.

DeletedCertificateListResult

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

Nom Type Description
nextLink

string

URL permettant d’obtenir l’ensemble suivant de certificats supprimés.
value

DeletedCertificateItem[]

Message de réponse contenant une liste de certificats supprimés dans le coffre, ainsi qu’un lien vers la page suivante de certificats supprimés

DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à 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.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom Type Description
error

Error

Erreur du serveur du coffre de clés.