Get Key - Get Key
Ruft den öffentlichen Teil eines gespeicherten Schlüssels ab.
Der Vorgang zum Abrufen von Schlüsseln gilt für alle Schlüsseltypen. Wenn der angeforderte Schlüssel symmetrisch ist, wird in der Antwort kein Schlüsselmaterial freigegeben. Dieser Vorgang erfordert die Schlüssel-/Get-Berechtigung.
GET {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
key-name
|
path | True |
string |
Der Name des abzurufenden Schlüssels. |
key-version
|
path | True |
string |
Durch hinzufügen des Versionsparameters wird eine bestimmte Version eines Schlüssels abgerufen. Dieses URI-Fragment ist optional. Wenn nicht angegeben, wird die neueste Version des Schlüssels zurückgegeben. |
vault
|
path | True |
string |
Der Tresorname, z. B https://myvault.vault.azure.net. . |
api-version
|
query | True |
string |
Client-API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Ein Schlüsselbundle, das den Schlüssel und seine Attribute enthält. |
|
Other Status Codes |
Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Beispiele
Get key
Sample Request
GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?api-version=7.4
Sample Response
{
"key": {
"kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
"kty": "RSA",
"key_ops": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey"
],
"n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
"e": "AQAB"
},
"attributes": {
"enabled": true,
"created": 1493942451,
"updated": 1493942451,
"recoveryLevel": "Recoverable+Purgeable"
},
"tags": {
"purpose": "unit test",
"test name ": "CreateGetDeleteKeyTest"
}
}
Definitionen
Name | Beschreibung |
---|---|
Deletion |
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 dauerhaft gelöscht werden. Andernfalls kann nur das System den Schlüssel am Ende des Aufbewahrungsintervalls bereinigen. |
Error |
Der Schlüsseltresorserverfehler. |
Json |
Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
Json |
JsonWebKey-Schlüsseltyp (kty), wie in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40definiert. |
Key |
Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird. |
Key |
Ein KeyBundle, das aus einem WebKey und seinen Attributen besteht. |
Key |
Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann. |
Key |
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 dauerhaft 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 wiederhergestellt werden kann, ohne die Möglichkeit einer sofortigen und dauerhaften Löschung zu haben (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 das sofortige und dauerhafte Löschen 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 Bereinigungsvorgang angefordert oder das Abonnement gekündigt. |
Purgeable |
string |
Gibt einen Tresorzustand an, bei dem das Löschen ein irreversibler Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Ebene entspricht keinem Schutz vor einem 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 wiederhergestellt werden kann, ohne die Möglichkeit einer sofortigen und dauerhaften Löschung (d. h. Löschen) zu haben. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und solange das Abonnement noch verfügbar ist. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird |
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. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird |
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, ein Bereinigungsvorgang wird angefordert oder das Abonnement wird gekündigt. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird |
Error
Der Schlüsseltresorserverfehler.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
innererror |
Der Schlüsseltresorserverfehler. |
|
message |
string |
Die Fehlermeldung. |
JsonWebKey
Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Name | Typ | Beschreibung |
---|---|---|
crv |
Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
|
d |
string |
Privater RSA-Exponent oder die D-Komponente eines privaten EC-Schlüssels. |
dp |
string |
Parameter für privaten RSA-Schlüssel. |
dq |
string |
Parameter für privaten RSA-Schlüssel. |
e |
string |
Öffentlicher RSA-Exponent. |
k |
string |
Symmetrischer Schlüssel. |
key_hsm |
string |
Geschützter Schlüssel, der mit "Bring Your Own Key" verwendet wird. |
key_ops |
string[] |
Unterstützte Schlüsselvorgänge. |
kid |
string |
Schlüsselbezeichner. |
kty |
JsonWebKey-Schlüsseltyp (kty), wie in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40definiert. |
|
n |
string |
RSA-Modul. |
p |
string |
RSA Secret Prime. |
q |
string |
RSA secret prime, mit p < q. |
qi |
string |
Parameter für privaten RSA-Schlüssel. |
x |
string |
X-Komponente eines öffentlichen EC-Schlüssels. |
y |
string |
Y-Komponente eines öffentlichen EC-Schlüssels. |
JsonWebKeyCurveName
Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
Name | Typ | Beschreibung |
---|---|---|
P-256 |
string |
Die elliptische NIST P-256-Kurve, AKA SECG-Kurve SECP256R1. |
P-256K |
string |
Die SECG SECP256K1 elliptische Kurve. |
P-384 |
string |
Die elliptische NIST P-384-Kurve, AKA SECG-Kurve SECP384R1. |
P-521 |
string |
Die elliptische NIST P-521-Kurve, AKA SECG-Kurve SECP521R1. |
JsonWebKeyType
JsonWebKey-Schlüsseltyp (kty), wie in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40definiert.
Name | Typ | Beschreibung |
---|---|---|
EC |
string |
Elliptische Kurve. |
EC-HSM |
string |
Elliptische Kurve mit einem privaten Schlüssel, der im HSM gespeichert ist. |
RSA |
string |
|
RSA-HSM |
string |
RSA mit einem privaten Schlüssel, der im HSM gespeichert ist. |
oct |
string |
Oktettsequenz (zur Darstellung symmetrischer Schlüssel) |
oct-HSM |
string |
Oktettsequenz (zur Darstellung symmetrischer Schlüssel), die im HSM gespeichert wird. |
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 |
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 dauerhaft gelöscht werden. Andernfalls kann nur das System den Schlüssel am Ende des Aufbewahrungsintervalls bereinigen. |
|
updated |
integer |
Uhrzeit der letzten Aktualisierung in UTC. |
KeyBundle
Ein KeyBundle, das aus einem WebKey und seinen Attributen besteht.
Name | Typ | Beschreibung |
---|---|---|
attributes |
Die Schlüsselverwaltungsattribute. |
|
key |
Der JSON-Webschlüssel. |
|
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. |
release_policy |
Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann. |
|
tags |
object |
Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren. |
KeyReleasePolicy
Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
contentType |
string |
application/json; charset=utf-8 |
Inhaltstyp und Version der Schlüsselfreigaberichtlinie |
data |
string |
Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann. Das Blob muss base64-URL-codiert sein. |
|
immutable |
boolean |
Definiert den Veränderlichkeitsstatus der Richtlinie. Sobald sie als unveränderlich markiert ist, kann dieses Flag nicht zurückgesetzt werden, und die Richtlinie kann unter keinen Umständen geändert werden. |
KeyVaultError
Die Schlüsseltresorfehler-Ausnahme.
Name | Typ | Beschreibung |
---|---|---|
error |
Der Schlüsseltresorserverfehler. |