Get Deleted Certificate - Get Deleted Certificate
Ruft Informationen zum angegebenen gelöschten Zertifikat ab.
Der GetDeletedCertificate-Vorgang ruft die gelöschten Zertifikatinformationen sowie seine Attribute ab, z. B. Aufbewahrungsintervall, geplantes dauerhaftes Löschen und die aktuelle Löschwiederherstellungsstufe. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.
GET {vaultBaseUrl}/deletedcertificates/{certificate-name}?api-version=7.4
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
certificate-name
|
path | True |
string |
Der Name des Zertifikats |
vault
|
path | True |
string |
Der Tresorname, z. B. |
api-version
|
query | True |
string |
Client-API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Ein Zertifikatbundle des Zertifikats und seiner Attribute |
|
Other Status Codes |
Key Vault-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Beispiele
GetDeletedCertificate
Beispielanforderung
GET https://myvault.vault.azure.net//deletedcertificates/getDeletedCert?api-version=7.4
Beispiel für eine Antwort
{
"recoveryId": "https://myvault.vault.azure.net/deletedcertificates/getDeletedCert",
"deletedDate": 1493938292,
"scheduledPurgeDate": 1501714292,
"id": "https://myvault.vault.azure.net/certificates/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769",
"kid": "https://myvault.vault.azure.net/keys/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769",
"sid": "https://myvault.vault.azure.net/secrets/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769",
"x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
"cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
"attributes": {
"enabled": true,
"nbf": 1430344421,
"exp": 2208988799,
"created": 1493938289,
"updated": 1493938291,
"recoveryLevel": "Recoverable+Purgeable"
},
"policy": {
"id": "https://myvault.vault.azure.net/certificates/getDeletedCert/policy",
"key_props": {
"exportable": true,
"kty": "RSA",
"key_size": 2048,
"reuse_key": false
},
"secret_props": {
"contentType": "application/x-pkcs12"
},
"x509_props": {
"subject": "CN=KeyVaultTest",
"ekus": [],
"key_usage": [],
"validity_months": 297
},
"lifetime_actions": [
{
"trigger": {
"lifetime_percentage": 80
},
"action": {
"action_type": "EmailContacts"
}
}
],
"issuer": {
"name": "Unknown"
},
"attributes": {
"enabled": true,
"created": 1493938289,
"updated": 1493938291
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Action |
Die Aktion, die ausgeführt wird. |
Certificate |
Die Zertifikatverwaltungsattribute. |
Certificate |
Verwaltungsrichtlinie für ein Zertifikat. |
Certificate |
Der Typ der Aktion. |
Deleted |
Ein gelöschtes Zertifikat, das aus der vorherigen ID, den Attributen und den Tags besteht, sowie Informationen dazu, wann es gelöscht wird. |
Deletion |
Gibt die Löschwiederherstellungsebene wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen. |
Error |
Der Schlüsseltresorserverfehler. |
Issuer |
Parameter für den Aussteller der X509-Komponente eines Zertifikats. |
Json |
Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
Json |
Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll. |
Key |
Eigenschaften des Schlüsselpaars, das ein Zertifikat sichert. |
Key |
Definiert, wie der Schlüssel des Zertifikats verwendet werden kann. |
Key |
Ausnahme des Schlüsseltresorfehlers. |
Lifetime |
Aktion und deren Auslöser, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden. |
Secret |
Eigenschaften des Schlüssels, der ein Zertifikat sichert. |
Subject |
Die alternativen Antragstellernamen eines X509-Objekts. |
Trigger |
Eine Bedingung, die erfüllt werden soll, damit eine Aktion ausgeführt wird. |
X509Certificate |
Eigenschaften der X509-Komponente eines Zertifikats. |
Action
Die Aktion, die ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
action_type |
Der Typ der Aktion. |
CertificateAttributes
Die Zertifikatverwaltungsattribute.
Name | Typ | Beschreibung |
---|---|---|
created |
integer (unixtime) |
Erstellungszeit in UTC. |
enabled |
boolean |
Bestimmt, ob das Objekt aktiviert ist. |
exp |
integer (unixtime) |
Ablaufdatum in UTC. |
nbf |
integer (unixtime) |
Nicht vor dem Datum in UTC. |
recoverableDays |
integer (int32) |
SoftDelete-Datenaufbewahrungstage. Der Wert sollte >=7 und <=90 sein, wenn "softDelete" aktiviert ist, andernfalls 0. |
recoveryLevel |
Gibt die Löschwiederherstellungsebene wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen. |
|
updated |
integer (unixtime) |
Uhrzeit der letzten Aktualisierung in UTC. |
CertificatePolicy
Verwaltungsrichtlinie für ein Zertifikat.
Name | Typ | Beschreibung |
---|---|---|
attributes |
Die Zertifikatattribute. |
|
id |
string |
Die Zertifikat-ID. |
issuer |
Parameter für den Aussteller der X509-Komponente eines Zertifikats. |
|
key_props |
Eigenschaften des Schlüssels, der ein Zertifikat sichert. |
|
lifetime_actions |
Aktionen, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden. |
|
secret_props |
Eigenschaften des geheimen Schlüssels, der ein Zertifikat sichert. |
|
x509_props |
Eigenschaften der X509-Komponente eines Zertifikats. |
CertificatePolicyAction
Der Typ der Aktion.
Wert | Beschreibung |
---|---|
AutoRenew | |
EmailContacts |
DeletedCertificateBundle
Ein gelöschtes Zertifikat, das aus der vorherigen ID, den Attributen und den Tags besteht, sowie Informationen dazu, wann es gelöscht wird.
Name | Typ | Beschreibung |
---|---|---|
attributes |
Die Zertifikatattribute. |
|
cer |
string (byte) |
CER-Inhalt des x509-Zertifikats. |
contentType |
string |
Der Inhaltstyp des geheimen Schlüssels. Zb. "application/x-pem-file" oder "application/x-pkcs12", |
deletedDate |
integer (unixtime) |
Der Zeitpunkt, zu dem das Zertifikat gelöscht wurde, in UTC |
id |
string |
Die Zertifikat-ID. |
kid |
string |
Die Schlüssel-ID. |
policy |
Die Verwaltungsrichtlinie. |
|
recoveryId |
string |
Die URL des Wiederherstellungsobjekts, das zum Identifizieren und Wiederherstellen des gelöschten Zertifikats verwendet wird. |
scheduledPurgeDate |
integer (unixtime) |
Der Zeitpunkt, zu dem das Zertifikat gelöscht werden soll, in UTC |
sid |
string |
Die geheime ID. |
tags |
object |
Anwendungsspezifische Metadaten in Form von Schlüsselwertpaaren |
x5t |
string (base64url) |
Fingerabdruck des Zertifikats. |
DeletionRecoveryLevel
Gibt die Löschwiederherstellungsebene wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen.
Wert | Beschreibung |
---|---|
CustomizedRecoverable |
Gibt einen Tresorstatus an, in dem die Löschung ohne sofortige und dauerhafte Löschung wiederhergestellt werden kann (d. h. löschen, wenn 7<= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und während der Verfügbarkeit des Abonnements. |
CustomizedRecoverable+ProtectedSubscription |
Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederherstellbar, sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht storniert werden kann. |
CustomizedRecoverable+Purgeable |
Gibt einen Tresorstatus an, in dem die Löschung wiederhergestellt werden kann und die auch sofortige und dauerhafte Löschung ermöglicht (d. h. Löschvorgang bei 7<= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, ein Löschvorgang wird angefordert, oder das Abonnement wird gekündigt. |
Purgeable |
Gibt einen Tresorstatus an, in dem das Löschen ein unumkehrbarer Vorgang ist, ohne dass die Wiederherstellung möglich ist. Diese Stufe entspricht keinem Schutz vor einem Löschvorgang; die Daten werden unwiderruflich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher akzeptieren (Tresor, Ressourcengruppe, Abonnement usw.) |
Recoverable |
Gibt einen Tresorstatus an, in dem die Löschung ohne die Möglichkeit zum sofortigen und dauerhaften Löschen (d. h. Löschen) wiederhergestellt werden kann. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und während das Abonnement noch verfügbar ist. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt. |
Recoverable+ProtectedSubscription |
Gibt einen Tresor- und Abonnementstatus an, in dem die Löschung innerhalb des Aufbewahrungsintervalls (90 Tage), sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft storniert werden kann. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt. |
Recoverable+Purgeable |
Gibt einen Tresorstatus an, in dem die Löschung wiederhergestellt werden kann und die auch sofortige und dauerhafte Löschung (d. h. Löschvorgang) zulässt. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, ein Bereinigungsvorgang wird angefordert, oder das Abonnement wird gekündigt. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt. |
Error
Der Schlüsseltresorserverfehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
innererror |
Der Schlüsseltresorserverfehler. |
|
message |
string |
Die Fehlermeldung. |
IssuerParameters
Parameter für den Aussteller der X509-Komponente eines Zertifikats.
Name | Typ | Beschreibung |
---|---|---|
cert_transparency |
boolean |
Gibt an, ob die unter dieser Richtlinie generierten Zertifikate in Zertifikattransparenzprotokollen veröffentlicht werden sollen. |
cty |
string |
Zertifikattyp, der vom Anbieter unterstützt wird (optional); Zum Beispiel "OV-SSL", "EV-SSL" |
name |
string |
Name des referenzierten Ausstellerobjekts oder reservierter Namen; Beispiel: "Selbst" oder "Unbekannt". |
JsonWebKeyCurveName
Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName.
Wert | Beschreibung |
---|---|
P-256 | |
P-256K | |
P-384 | |
P-521 |
JsonWebKeyType
Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.
Wert | Beschreibung |
---|---|
EC | |
EC-HSM | |
RSA | |
RSA-HSM | |
oct | |
oct-HSM |
KeyProperties
Eigenschaften des Schlüsselpaars, das ein Zertifikat sichert.
Name | Typ | Beschreibung |
---|---|---|
crv |
Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
|
exportable |
boolean |
Gibt an, ob der private Schlüssel exportiert werden kann. Die Releaserichtlinie muss beim Erstellen der ersten Version eines exportierbaren Schlüssels bereitgestellt werden. |
key_size |
integer (int32) |
Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA. |
kty |
Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll. |
|
reuse_key |
boolean |
Gibt an, ob dasselbe Schlüsselpaar bei der Zertifikatverlängerung verwendet wird. |
KeyUsageType
Definiert, wie der Schlüssel des Zertifikats verwendet werden kann.
Wert | Beschreibung |
---|---|
cRLSign | |
dataEncipherment | |
decipherOnly | |
digitalSignature | |
encipherOnly | |
keyAgreement | |
keyCertSign | |
keyEncipherment | |
nonRepudiation |
KeyVaultError
Ausnahme des Schlüsseltresorfehlers.
Name | Typ | Beschreibung |
---|---|---|
error |
Der Schlüsseltresorserverfehler. |
LifetimeAction
Aktion und deren Auslöser, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden.
Name | Typ | Beschreibung |
---|---|---|
action |
Die Aktion, die ausgeführt wird. |
|
trigger |
Die Bedingung, die die Aktion ausführt. |
SecretProperties
Eigenschaften des Schlüssels, der ein Zertifikat sichert.
Name | Typ | Beschreibung |
---|---|---|
contentType |
string |
Der Medientyp (MIME-Typ). |
SubjectAlternativeNames
Die alternativen Antragstellernamen eines X509-Objekts.
Name | Typ | Beschreibung |
---|---|---|
dns_names |
string[] |
Domänennamen. |
emails |
string[] |
E-Mail-Adressen. |
upns |
string[] |
Benutzerprinzipalnamen. |
Trigger
Eine Bedingung, die erfüllt werden soll, damit eine Aktion ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
days_before_expiry |
integer (int32) |
Tage vor Ablauf, um die Verlängerung zu versuchen. Der Wert sollte zwischen 1 und validity_in_months mit 27 multipliziert sein. Wenn validity_in_months 36 ist, sollte der Wert zwischen 1 und 972 (36 * 27) betragen. |
lifetime_percentage |
integer (int32) minimum: 1maximum: 99 |
Prozentsatz der Lebensdauer, für die ausgelöst werden soll. Der Wert sollte zwischen 1 und 99 sein. |
X509CertificateProperties
Eigenschaften der X509-Komponente eines Zertifikats.
Name | Typ | Beschreibung |
---|---|---|
ekus |
string[] |
Die erweiterte Schlüsselverwendung. |
key_usage |
Definiert, wie der Schlüssel des Zertifikats verwendet werden kann. |
|
sans |
Die alternativen Antragstellernamen. |
|
subject |
string |
Der Antragstellername. Sollte ein gültiger X509-Distinguished Name sein. |
validity_months |
integer (int32) minimum: 0 |
Die Dauer, die das Zertifikat in Monaten gültig ist. |