Create Key - Create Key

Referenz

Service:: Key Vault

API Version:: 7.4

Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Attribute an den Client zurück.
Der Vorgang Schlüssel erstellen kann verwendet werden, um einen beliebigen Schlüsseltyp in Azure Key Vault zu erstellen. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Hierfür sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
key-name	path	True	string	Der Name für den neuen Schlüssel. Das System generiert den Versionsnamen für den neuen 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

Der Name für den neuen Schlüssel. Das System generiert den Versionsnamen für den neuen 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
kty	True	JsonWebKeyType	Die Art des zu erstellenden Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType.
attributes		KeyAttributes	Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird.
crv		JsonWebKeyCurveName	Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
key_ops		JsonWebKeyOperation[]	JSON-Webschlüsselvorgänge. Weitere Informationen finden Sie unter JsonWebKeyOperation.
key_size		integer	Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA.
public_exponent		integer	Der öffentliche Exponent für einen RSA-Schlü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.

Antworten

Name	Typ	Beschreibung
200 OK	KeyBundle	Ein Schlüsselbündel, das das Ergebnis der Anforderung zum Erstellen eines Schlüssels enthält.
Other Status Codes	KeyVaultError	Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

Create key

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/CreateSoftKeyTest/create?api-version=7.4

{
  "kty": "RSA",
  "key_size": 2048,
  "key_ops": [
    "encrypt",
    "decrypt",
    "sign",
    "verify",
    "wrapKey",
    "unwrapKey"
  ],
  "attributes": {},
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Sample Response

Status code:: 200

{
  "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
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.
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.
JsonWebKeyOperation
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.
KeyCreateParameters	Der Schlüssel erstellt Parameter.
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 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.

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 den privaten RSA-Schlüssel.
dq	string	Parameter für den 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 den 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 NIST P-256 elliptische Kurve, AKA SECG-Kurve SECP256R1.
P-256K	string	Die SECG-SECP256K1 elliptische Kurve.
P-384	string	Die elliptische Kurve NIST P-384, AKA SECG-Kurve SECP384R1.
P-521	string	Die elliptische Kurve NIST P-521, AKA SECG-Kurve SECP521R1.

JsonWebKeyOperation

Name	Typ	Beschreibung
decrypt	string
encrypt	string
export	string
import	string
sign	string
unwrapKey	string
verify	string
wrapKey	string

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 (zum Darstellen 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 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.

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.

KeyCreateParameters

Der Schlüssel erstellt Parameter.

Name	Typ	Beschreibung
attributes	KeyAttributes	Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird.
crv	JsonWebKeyCurveName	Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
key_ops	JsonWebKeyOperation[]	JSON-Webschlüsselvorgänge. Weitere Informationen finden Sie unter JsonWebKeyOperation.
key_size	integer	Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA.
kty	JsonWebKeyType	Die Art des zu erstellenden Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType.
public_exponent	integer	Der öffentliche Exponent für einen RSA-Schlü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. Blob muss base64-URL-codiert sein.
immutable	boolean		Definiert den Veränderbarkeitsstatus der Richtlinie. Nach der Kennzeichnung als unveränderlich 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.

Share via

Create Key - Create Key

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create key

Sample Request

Sample Response

Definitionen

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyOperation

JsonWebKeyType

KeyAttributes

KeyBundle

KeyCreateParameters

KeyReleasePolicy

KeyVaultError

Zusätzliche Ressourcen