Get Key Versions - Get Key Versions

Referenz

Service:: Key Vault

API Version:: 7.4

Ruft eine Liste der einzelnen Schlüsselversionen mit demselben Schlüsselnamen ab.
In der Antwort werden der vollständige Schlüsselbezeichner, Attribute und Tags bereitgestellt. Für diesen Vorgang ist die Schlüssel-/Listenberechtigung erforderlich.

GET {vaultBaseUrl}/keys/{key-name}/versions?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/keys/{key-name}/versions?maxresults={maxresults}&api-version=7.4

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
key-name	path	True	string	Der Name des Schlüssels.
vaultBaseUrl	path	True	string	Der Tresorname, z. B https://myvault.vault.azure.net. .
api-version	query	True	string	Client-API-Version.
maxresults	query		integer int32	Maximale Anzahl von Ergebnissen, die auf einer Seite zurückgegeben werden sollen. Wenn nicht angegeben, gibt der Dienst bis zu 25 Ergebnisse zurück.

Antworten

Name	Typ	Beschreibung
200 OK	KeyListResult	Eine Antwortnachricht, die eine Liste von Schlüsseln sowie einen Link zur nächsten Seite der Schlüssel enthält.
Other Status Codes	KeyVaultError	Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

GetKeyVersions

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/listkeyversionstest/7c9dc6775d0e4177827c4f98f482fc12",
      "attributes": {
        "enabled": true,
        "created": 1493937851,
        "updated": 1493937851,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys/listkeyversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUwwRXdPRUZDUVVVNE1UZ3pNalF5TVRsQ05EUXpPREZFTWpoRVJURkdSVEJESVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Definitionen

Name	Beschreibung
DeletionRecoveryLevel	Gibt die Löschwiederherstellungsebene an, die derzeit für Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. Andernfalls kann nur das System den Schlüssel am Ende des Aufbewahrungsintervalls bereinigen.
Error	Der Schlüsseltresorserverfehler.
KeyAttributes	Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird.
KeyItem	Das Schlüsselelement, das Schlüsselmetadaten enthält.
KeyListResult	Das Ergebnis der Schlüsselliste.
KeyVaultError	Die Schlüsseltresorfehler-Ausnahme.

DeletionRecoveryLevel

Gibt die Löschwiederherstellungsebene an, die derzeit für Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. Andernfalls kann nur das System den Schlüssel am Ende des Aufbewahrungsintervalls bereinigen.

Name	Typ	Beschreibung
CustomizedRecoverable	string	Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist.
CustomizedRecoverable+ProtectedSubscription	string	Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht gekündigt werden kann.
CustomizedRecoverable+Purgeable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch eine sofortige und dauerhafte Löschung zulässt (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, es wird ein Löschvorgang angefordert oder das Abonnement gekündigt.
Purgeable	string	Gibt einen Tresorzustand an, in dem das Löschen ein irreversibler Vorgang ist, ohne dass die Möglichkeit zur Wiederherstellung besteht. Diese Ebene entspricht keinem Schutz gegen einen Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren.
Recoverable	string	Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen (d. h. löschen) wiederhergestellt werden kann. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungszeitraums (90 Tage) und solange das Abonnement noch verfügbar ist. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
Recoverable+ProtectedSubscription	string	Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb eines Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
Recoverable+Purgeable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch das sofortige und dauerhafte Löschen (d. h. Löschen) zulässt. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, es wird ein Löschvorgang angefordert oder das Abonnement gekündigt. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde

Error

Der Schlüsseltresorserverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der Schlüsseltresorserverfehler.
message	string	Die Fehlermeldung.

KeyAttributes

Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird.

Name	Typ	Beschreibung
created	integer	Erstellungszeit in UTC.
enabled	boolean	Bestimmt, ob das Objekt aktiviert ist.
exp	integer	Ablaufdatum in UTC.
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.
nbf	integer	Nicht vor Datum in UTC.
recoverableDays	integer	softDelete Datenaufbewahrungstage. Der Wert sollte =7 und <=90 sein>, wenn softDelete aktiviert ist, andernfalls 0.
recoveryLevel	DeletionRecoveryLevel	Gibt die Löschwiederherstellungsebene an, die derzeit für Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. Andernfalls kann nur das System den Schlüssel am Ende des Aufbewahrungsintervalls bereinigen.
updated	integer	Uhrzeit der letzten Aktualisierung in UTC.

KeyItem

Das Schlüsselelement, das Schlüsselmetadaten enthält.

Name	Typ	Beschreibung
attributes	KeyAttributes	Die Schlüsselverwaltungsattribute.
kid	string	Schlüsselbezeichner.
managed	boolean	True, wenn die Lebensdauer des Schlüssels vom Schlüsseltresor verwaltet wird. Wenn dies ein Schlüssel ist, der ein Zertifikat sichert, ist verwaltet true.
tags	object	Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

KeyListResult

Das Ergebnis der Schlüsselliste.

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen des nächsten Schlüsselsatzes.
value	KeyItem[]	Eine Antwortnachricht, die eine Liste der Schlüssel im Schlüsseltresor sowie einen Link zur nächsten Seite der Schlüssel enthält.

KeyVaultError

Die Schlüsseltresorfehler-Ausnahme.

Name	Typ	Beschreibung
error	Error	Der Schlüsseltresorserverfehler.

Freigeben über