Import Key - Import Key

Referenz

Service:: Key Vault

API Version:: 7.4

Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück.
Der Schlüsselimportvorgang kann verwendet werden, um einen beliebigen Schlüsseltyp in eine Azure-Key Vault zu importieren. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang ist die Schlüssel-/Importberechtigung erforderlich.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
key-name	path	True	string	Name für den importierten Schlüssel. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der bereitgestellte Wert sollte keine persönlich identifizierbaren oder sensiblen Informationen enthalten. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Der Tresorname, z. B https://myvault.vault.azure.net. .
api-version	query	True	string	Client-API-Version.

key-name

path

True

string

Name für den importierten Schlüssel. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der bereitgestellte Wert sollte keine persönlich identifizierbaren oder sensiblen Informationen enthalten.

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

Der Tresorname, z. B https://myvault.vault.azure.net. .

api-version

query

True

string

Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
key	True	JsonWebKey	Der JSON-Webschlüssel
Hsm		boolean	Ob als Hardwareschlüssel (HSM) oder Softwareschlüssel importiert werden soll.
attributes		KeyAttributes	Die Schlüsselverwaltungsattribute.
release_policy		KeyReleasePolicy	Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.
tags		object	Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

Antworten

Name	Typ	Beschreibung
200 OK	KeyBundle	Importiertes Schlüsselbundle in den Tresor.
Other Status Codes	KeyVaultError	Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

Import key

Sample Request

HTTP

PUT https://myvault.vault.azure.net//keys/ImportSoftKeyTest?api-version=7.4

{
  "key": {
    "kty": "RSA",
    "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw",
    "e": "AQAB",
    "d": "GeT1_D5LAZa7qlC7WZ0DKJnOth8kcPrN0urTEFtWCbmHQWkAad_px_VUpGp0BWDDzENbXbQcu4QCCdf4crve5eXt8dVI86OSah-RpEdBq8OFsETIhg2Tmq8MbYTJexoynRcIC62xAaCmkFMmu931gQSvWnYWTEuOPgmD2oE_F-bP9TFlGRc69a6MSbtcSRyFTsd5KsUr40QS4zf2W4kZCOWejyLuxk88SXgUqcJx86Ulc1Ol1KkTBLadvReAZCyCMwKBlNRGw46BU_iK0vK7rTD9fmEd639Gjti6eLpnyQYpnVe8uGgwVU1fHBkAKyapWoEG6VMhMntcrvgukKLIsQ",
    "dp": "ZGnmWx-Nca71z9a9vvT4g02iv3S-3kSgmhl8JST09YQwK8tfiK7nXnNMtXJi2K4dLKKnLicGtCzB6W3mXdLcP2SUOWDOeStoBt8HEBT4MrI1psCKqnBum78WkHju90rBFj99amkP6UeQy5EASAzgmKQu2nUaUnRV0lYP8LHMCkE",
    "dq": "dtpke0foFs04hPS6XYLA5lc7-1MAHfZKN4CkMAofwDqPmRQzCxpDJUk0gMWGJEdU_Lqfbg22Py44cci0dczH36NW3UU5BL86T2_SPPDOuyX7kDscrIJCdowxQCGJHGRBEozM_uTL46wu6UnUIv7m7cuGgodJyZBcdwpo6ziFink",
    "qi": "Y9KD5GaHkAYmAqpOfAQUMr71QuAAaBb0APzMuUvoEYw39PD3_vJeh9HZ15QmJ8zCX10-nlzUB-bWwvK-rGcJXbK4pArilr5MiaYv7e8h5eW2zs2_itDJ6Oebi-wVbMhg7DvUTBbkCvPhhIedE4UlDQmMYP7RhzVVs7SfmkGs_DQ",
    "p": "v1jeCPnuJQM2PW2690Q9KJk0Ulok8VFGjkcHUHVi3orKdy7y_TCIWM6ZGvgFzI6abinzYbTEPKV4wFdMAwvOWmawXj5YrsoeB44_HXJ0ak_5_iP6XXR8MLGXbd0ZqsxvAZyzMj9vyle7EN2cBod6aenI2QZoRDucPvjPwZsZotk",
    "q": "0Yv-Dj6qnvx_LL70lUnKA6MgHE_bUC4drl5ZNDDsUdUUYfxIK4G1rGU45kHGtp-Qg-Uyf9s52ywLylhcVE3jfbjOgEozlSwKyhqfXkLpMLWHqOKj9fcfYd4PWKPOgpzWsqjA6fJbBUMYo0CU2G9cWCtVodO7sBJVSIZunWrAlBc"
  },
  "tags": {
    "purpose": "unit test"
  }
}

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/ImportSoftKeyTest/2eb4a15d74184c6f84159c3ca90f0f4b",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942691,
    "updated": 1493942691,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test"
  }
}

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 dauerhaft gelöscht werden. Andernfalls kann nur das System den Schlüssel am Ende des Aufbewahrungsintervalls bereinigen.
Error	Der Schlüsseltresorserverfehler.
JsonWebKey	Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
JsonWebKeyType	JsonWebKey-Schlüsseltyp (kty), wie in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40definiert.
KeyAttributes	Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird.
KeyBundle	Ein KeyBundle, das aus einem WebKey und seinen Attributen besteht.
KeyImportParameters	Die Schlüsselimportparameter.
KeyReleasePolicy	Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.
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 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	Error	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	JsonWebKeyCurveName	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	JsonWebKeyType	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 (https://tools.ietf.org/html/rfc3447)
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	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.
updated	integer	Uhrzeit der letzten Aktualisierung in UTC.

KeyBundle

Ein KeyBundle, das aus einem WebKey und seinen Attributen besteht.

Name	Typ	Beschreibung
attributes	KeyAttributes	Die Schlüsselverwaltungsattribute.
key	JsonWebKey	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	KeyReleasePolicy	Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.
tags	object	Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

KeyImportParameters

Die Schlüsselimportparameter.

Name	Typ	Beschreibung
Hsm	boolean	Ob als Hardwareschlüssel (HSM) oder Softwareschlüssel importiert werden soll.
attributes	KeyAttributes	Die Schlüsselverwaltungsattribute.
key	JsonWebKey	Der JSON-Webschlüssel
release_policy	KeyReleasePolicy	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	Error	Der Schlüsseltresorserverfehler.

Import Key - Import Key

URI-Parameter

Anforderungstext

Antworten

Beispiele

Import key

Sample Request

Sample Response

Definitionen

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

Zusätzliche Ressourcen