Create Key - Create Key

Referenz

Service:: Key Vault

API Version:: 7.3

Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Attribute an den Client zurück.
Der Erstellungsschlüsselvorgang 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. Es erfordert die Schlüssel/Erstellungsberechtigung.

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

URI-Parameter

Name In Required Type Description

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

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	Required	Type	Description
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	Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName.
key_ops		string[]	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	Type	Description
200 OK	KeyBundle	Ein Schlüsselbündel, das das Ergebnis der Erstellungsschlüsselanforderung 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.3

{
  "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

DeletionRecoveryLevel	Spiegelt die Löschwiederherstellungsebene wider, die derzeit für Schlüssel im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann der Schlüssel endgültig von einem privilegierten Benutzer gelöscht werden; andernfalls kann das System den Schlüssel am Ende des Aufbewahrungsintervalls löschen.
Error	Der Fehler des Schlüsseltresorservers.
JsonWebKey	Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Elliptic curve name. 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 besteht aus einem WebKey plus seinen Attributen.
KeyCreateParameters	Der Schlüssel erstellt Parameter.
KeyReleasePolicy	Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.
KeyVaultError	Ausnahme des Schlüsseltresorfehlers.

DeletionRecoveryLevel

Spiegelt die Löschwiederherstellungsebene wider, die derzeit für Schlüssel im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann der Schlüssel endgültig von einem privilegierten Benutzer gelöscht werden; andernfalls kann das System den Schlüssel am Ende des Aufbewahrungsintervalls löschen.

Name	Type	Description
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öschvorgang, wenn 7<= SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und während der Verfügbarkeit des Abonnements.
CustomizedRecoverable+ProtectedSubscription	string	Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederherstellbar, sofort und dauerhaft gelöscht wird (d. h. Löschvorgang) ist nicht zulässig, und in dem das Abonnement selbst nicht dauerhaft abgebrochen 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 abgebrochen werden kann.
CustomizedRecoverable+Purgeable	string	Gibt einen Tresorstatus an, in dem das Löschen wiederherstellbar ist und auch eine sofortige und dauerhafte Löschung ermöglicht (d. h. Löschvorgang, wenn 7<= SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, ein Löschvorgang wird angefordert, oder das Abonnement wird abgebrochen.
Purgeable	string	Gibt einen Tresorstatus an, in dem es sich um einen unumkehrbaren Vorgang handelt, ohne dass die Möglichkeit für die Wiederherstellung möglich ist. Diese Ebene entspricht keinem Schutz, der gegen einen Delete-Vorgang verfügbar ist; die Daten werden unwiderruflich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher akzeptieren (Tresor, Ressourcengruppe, Abonnement usw.)
Recoverable	string	Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (z. B. Löschvorgang). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und während das Abonnement noch verfügbar ist. System wird es nach 90 Tagen dauerhaft löschen, wenn nicht wiederhergestellt
Recoverable+ProtectedSubscription	string	Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb des Aufbewahrungsintervalls (90 Tage), sofortige und dauerhafte Löschung (d. h. Löschung) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft abgebrochen werden kann. System wird es nach 90 Tagen dauerhaft löschen, wenn nicht wiederhergestellt
Recoverable+Purgeable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederherstellbar ist und auch eine sofortige und dauerhafte Löschung (z. B. Löschung) ermöglicht. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, ein Löschvorgang wird angefordert, oder das Abonnement wird abgebrochen. System wird es nach 90 Tagen dauerhaft löschen, wenn nicht wiederhergestellt

Error

Der Fehler des Schlüsseltresorservers.

Name	Type	Description
code	string	Der Fehlercode.
innererror	Error	Der Fehler des Schlüsseltresorservers.
message	string	Die Fehlermeldung.

JsonWebKey

Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name	Type	Description
crv	JsonWebKeyCurveName	Elliptic curve name. Gültige Werte finden Sie unter JsonWebKeyCurveName.
d	string	RSA private Exponent oder die D-Komponente eines EC-privaten Schlüssels.
dp	string	RSA private Schlüsselparameter.
dq	string	RSA private Schlüsselparameter.
e	string	RSA public exponent.
k	string	Symmetrischer Schlüssel.
key_hsm	string	Geschützter Schlüssel, der mit "Eigene Schlüssel bringen" 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 Modulus.
p	string	RSA secret prime.
q	string	RSA secret prime, with p q < .
qi	string	RSA private Schlüsselparameter.
x	string	X-Komponente eines öffentlichen EC-Schlüssels.
y	string	Y-Komponente eines ÖFFENTLICHEN Schlüssels der EG.

JsonWebKeyCurveName

Elliptic curve name. Gültige Werte finden Sie unter JsonWebKeyCurveName.

Name	Type	Description
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 NIST P-384 elliptische Kurve, AKA SECG-Kurve SECP384R1.
P-521	string	Die NIST P-521 elliptische 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	Type	Description
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	Oktetsequenz (wird verwendet, um symmetrische Schlüssel darzustellen)
oct-HSM	string	Oktetsequenz (verwendet zum Darstellen symmetrischer Schlüssel), die das HSM gespeichert wird.

KeyAttributes

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

Name	Type	Description
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 1. Version eines exportierbaren Schlüssels bereitgestellt werden.
nbf	integer	Nicht vor dem Datum in UTC.
recoverableDays	integer	softDelete Datenaufbewahrungstage. Wert sollte =7 und <=90 sein>, wenn SoftDelete aktiviert ist, andernfalls 0.
recoveryLevel	DeletionRecoveryLevel	Spiegelt die Löschwiederherstellungsebene wider, die derzeit für Schlüssel im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann der Schlüssel endgültig von einem privilegierten Benutzer gelöscht werden; andernfalls kann das System den Schlüssel am Ende des Aufbewahrungsintervalls löschen.
updated	integer	Letzte Aktualisierungszeit in UTC.

KeyBundle

Ein KeyBundle besteht aus einem WebKey plus seinen Attributen.

Name	Type	Description
attributes	KeyAttributes	Die Schlüsselverwaltungsattribute.
key	JsonWebKey	Der Json-Webschlüssel.
managed	boolean	True, wenn die Lebensdauer des Schlüssels durch Schlüsseltresor verwaltet wird. Wenn dies ein Schlüssel ist, der ein Zertifikat zurückgibt, ist dies wahr.
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	Type	Description
attributes	KeyAttributes	Die Attribute eines Schlüssels, der vom Schlüsseltresordienst verwaltet wird.
crv	JsonWebKeyCurveName	Elliptic curve name. Gültige Werte finden Sie unter JsonWebKeyCurveName.
key_ops	string[]	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	Type	Default Value	Description
contentType	string	application/json; charset=utf-8	Inhaltstyp und Version der Key Release-Richtlinie
data	string		Blob-Codierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann. Blob muss base64 URL codiert sein.
immutable	boolean		Definiert den Stummschaltungszustand der Richtlinie. Nachdem die Kennzeichnung unveränderlich markiert wurde, kann diese Kennzeichnung nicht zurückgesetzt werden, und die Richtlinie kann unter umständen nicht geändert werden.

KeyVaultError

Ausnahme des Schlüsseltresorfehlers.

Name	Type	Description
error	Error	Der Fehler des Schlüsseltresorservers.