Get Certificates - Get Certificates
Répertorier les certificats dans un coffre de clés spécifié
L’opération GetCertificates retourne l’ensemble de ressources de certificats dans le coffre de clés spécifié. Cette opération nécessite l’autorisation certificats/liste.
GET {vaultBaseUrl}/certificates?api-version=7.4
GET {vaultBaseUrl}/certificates?maxresults={maxresults}&includePending={includePending}&api-version=7.4
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
vault
|
path | True |
string |
Nom du coffre, par exemple https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Version d’API client. |
include
|
query |
boolean |
Spécifie s’il faut inclure des certificats qui ne sont pas entièrement 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 |
Message de réponse contenant une liste de certificats ainsi qu’un lien vers la page suivante des certificats. |
|
Other Status Codes |
Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération. |
Exemples
GetCertificates
Sample Request
GET https://myvault.vault.azure.net//certificates?api-version=7.4
Sample Response
{
"value": [
{
"id": "https://myvault.vault.azure.net/certificates/listCert01",
"x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
"attributes": {
"enabled": true,
"nbf": 1430344421,
"exp": 2208988799,
"created": 1482188987,
"updated": 1482188987
}
},
{
"id": "https://myvault.vault.azure.net/certificates/listCert02",
"x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
"attributes": {
"enabled": true,
"nbf": 1430344421,
"exp": 2208988799,
"created": 1482188988,
"updated": 1482188988
}
}
],
"nextLink": null
}
Définitions
Nom | Description |
---|---|
Certificate |
Attributs de gestion des certificats. |
Certificate |
Élément de certificat contenant les métadonnées de certificat. |
Certificate |
Résultat de la liste de certificats. |
Deletion |
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. |
Key |
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 |
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 en UTC. |
CertificateItem
Élément de certificat contenant les métadonnées de certificat.
Nom | Type | Description |
---|---|---|
attributes |
Attributs de gestion des certificats. |
|
id |
string |
Identificateur du certificat. |
tags |
object |
Métadonnées spécifiques d’application sous la forme de paires clé/valeur. |
x5t |
string |
Empreinte numérique du certificat. |
CertificateListResult
Résultat de la liste de certificats.
Nom | Type | Description |
---|---|---|
nextLink |
string |
URL pour obtenir l’ensemble de certificats suivant. |
value |
Message de réponse contenant une liste de certificats dans le coffre de clés ainsi qu’un lien vers la page suivante des certificats. |
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, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant 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 permanente (c’est-à-dire la purge) n’est pas autorisée et dans laquelle 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, purge 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 purge est demandée ou si l’abonnement est annulé. |
Purgeable |
string |
Désigne 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 (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant 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 |
Désigne 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 la purge) 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 une suppression immédiate et définitive (c’est-à-dire une purge). 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 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é |
Error
Erreur du serveur du coffre de clés.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur. |
innererror |
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 |
Erreur du serveur du coffre de clés. |