Create Key - Create Key

Referencia

Service:: Key Vault

API Version:: 7.3

Létrehoz egy új kulcsot, tárolja, majd kulcsparamétereket és attribútumokat ad vissza az ügyfélnek.
A kulcs létrehozása művelettel bármilyen kulcstípust létrehozhat az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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

URI-paraméterek

Name In Required Type Description

Name	In	Required	Type	Description
key-name	path	True	string	Az új kulcs neve. A rendszer létrehozza az új kulcs verziónevét. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	A tároló neve, például https://myvault.vault.azure.net.
api-version	query	True	string	Ügyfél API-verziója.

key-name

path

True

string

Az új kulcs neve. A rendszer létrehozza az új kulcs verziónevét.

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

vaultBaseUrl

path

True

string

A tároló neve, például https://myvault.vault.azure.net.

api-version

query

True

string

Ügyfél API-verziója.

Kérelem törzse

Name	Required	Type	Description
kty	True	JsonWebKeyType	A létrehozandó kulcs típusa. Érvényes értékekért lásd: JsonWebKeyType.
attributes		KeyAttributes	A Key Vault szolgáltatás által kezelt kulcs attribútumai.
crv		JsonWebKeyCurveName	Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.
key_ops		string[]	JSON webes kulcsműveletek. További információ: JsonWebKeyOperation.
key_size		integer	A kulcs mérete bitekben. Például: 2048, 3072 vagy 4096 RSA esetén.
public_exponent		integer	Az RSA-kulcs nyilvános kitevője.
release_policy		KeyReleasePolicy	Azok a szabályzatszabályok, amelyek alapján a kulcs exportálható.
tags		object	Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.

Válaszok

Name	Type	Description
200 OK	KeyBundle	Kulcscsomag, amely a kulcs létrehozására irányuló kérelem eredményét tartalmazza.
Other Status Codes	KeyVaultError	Key Vault hibaválaszt, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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

Definíciók

DeletionRecoveryLevel	Az aktuális tárolóban lévő kulcsok törlési helyreállítási szintjét tükrözi. Ha tartalmazza a "Véglegesen törölhető" elemet, a kulcsot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a kulcsot a megőrzési időtartam végén.
Error	A Key Vault-kiszolgáló hibája.
JsonWebKey	2010. http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Elliptikus görbe neve. Érvényes értékek: JsonWebKeyCurveName.
JsonWebKeyType	JsonWebKey kulcstípus (kty), a https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	A Key Vault szolgáltatás által kezelt kulcs attribútumai.
KeyBundle	Egy WebKey-ből és attribútumaiból álló KeyBundle.
KeyCreateParameters	A kulcs hozza létre a paramétereket.
KeyReleasePolicy	Azokat a szabályzatszabályokat, amelyek alapján a kulcs exportálható.
KeyVaultError	A Key Vault hibakivétele.

DeletionRecoveryLevel

Az aktuális tárolóban lévő kulcsok törlési helyreállítási szintjét tükrözi. Ha tartalmazza a "Véglegesen törölhető" elemet, a kulcsot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a kulcsot a megőrzési időtartam végén.

Name	Type	Description
CustomizedRecoverable	string	Azt a tárolóállapotot jelöli, amelyben a törlés azonnali és végleges törlés nélkül helyreállítható (pl. 7<= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt, és amíg az előfizetés továbbra is elérhető.
CustomizedRecoverable+ProtectedSubscription	string	Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (pl. végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen, amikor 7< = SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt, és azt is tükrözi, hogy maga az előfizetés nem mondható le.
CustomizedRecoverable+Purgeable	string	Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (pl. 7< = SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják.
Purgeable	string	Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, és nincs lehetőség a helyreállításra. Ez a szint azt jelenti, hogy a törlési műveletekkel szemben nem áll rendelkezésre védelem; az adatok helyrehozhatatlanul elvesznek egy törlési művelet elfogadásakor az entitás szintjén vagy annál magasabb szinten (tároló, erőforráscsoport, előfizetés stb.).
Recoverable	string	Azt a tárolóállapotot jelöli, amelyben a törlés azonnali és végleges törlés (pl. végleges törlés) nélkül állítható helyre. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt (90 nap), és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
Recoverable+ProtectedSubscription	string	Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési időtartamon (90 napon) belül helyreállítható, az azonnali és végleges törlés (pl. végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
Recoverable+Purgeable	string	Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (pl. végleges törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre

Error

A Key Vault-kiszolgáló hibája.

Name	Type	Description
code	string	A hibakód.
innererror	Error	A Key Vault-kiszolgáló hibája.
message	string	A hibaüzenet.

JsonWebKey

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

Name	Type	Description
crv	JsonWebKeyCurveName	Elliptikus görbe neve. Érvényes értékek: JsonWebKeyCurveName.
d	string	RSA private exponent, vagy egy EC titkos kulcs D összetevője.
dp	string	RSA titkoskulcs-paraméter.
dq	string	RSA titkoskulcs-paraméter.
e	string	RSA nyilvános kitevő.
k	string	Szimmetrikus kulcs.
key_hsm	string	A "Saját kulcs használata" parancsmaggal használt védett kulcs.
key_ops	string[]	Támogatott kulcsműveletek.
kid	string	Kulcsazonosító.
kty	JsonWebKeyType	JsonWebKey kulcstípus (kty), a https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	RSA modulus.
p	string	RSA titkos prím.
q	string	RSA titkos prím, a p < q.
qi	string	RSA titkoskulcs-paraméter.
x	string	Egy NYILVÁNOS EC-kulcs X összetevője.
y	string	Egy NYILVÁNOS EC-kulcs Y összetevője.

JsonWebKeyCurveName

Elliptikus görbe neve. Érvényes értékek: JsonWebKeyCurveName.

Name	Type	Description
P-256	string	A NIST P-256 elliptikus görbe, MÁS NÉVEN SECG görbe SECP256R1.
P-256K	string	A SECG SECP256K1 elliptikus görbéje.
P-384	string	Az NIST P-384 elliptikus görbe, MÁS NÉVEN SECG görbe SECP384R1.
P-521	string	Az NIST P-521 elliptikus görbe, MÁS NÉVEN SECG-görbe SECP521R1.

JsonWebKeyType

JsonWebKey kulcstípus (kty), a https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name	Type	Description
EC	string	Elliptikus görbe.
EC-HSM	string	Elliptikus görbe a HSM-ben tárolt titkos kulccsal.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA a HSM-ben tárolt titkos kulccsal.
oct	string	Oktet szekvencia (szimmetrikus kulcsok ábrázolására szolgál)
oct-HSM	string	A HSM-et tároló oktet szekvencia (szimmetrikus kulcsok ábrázolására szolgál).

KeyAttributes

A Key Vault szolgáltatás által kezelt kulcs attribútumai.

Name	Type	Description
created	integer	Létrehozás időpontja (UTC).
enabled	boolean	Meghatározza, hogy az objektum engedélyezve van-e.
exp	integer	Lejárat dátuma (UTC).
exportable	boolean	Azt jelzi, hogy a titkos kulcs exportálható-e. Az exportálható kulcs első verziójának létrehozásakor kiadási szabályzatot kell megadni.
nbf	integer	Utc szerinti dátum előtt nem.
recoverableDays	integer	softDelete adatmegőrzési napok. Az érték =7 és <=90 lehet>, ha a softDelete engedélyezve van, egyébként 0.
recoveryLevel	DeletionRecoveryLevel	Az aktuális tárolóban lévő kulcsok törlési helyreállítási szintjét tükrözi. Ha tartalmazza a "Véglegesen törölhető" elemet, a kulcsot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a kulcsot a megőrzési időtartam végén.
updated	integer	Utolsó frissítés időpontja (UTC).

KeyBundle

Egy WebKey-ből és attribútumaiból álló KeyBundle.

Name	Type	Description
attributes	KeyAttributes	A kulcskezelési attribútumok.
key	JsonWebKey	A JSON webkulcs.
managed	boolean	Igaz, ha a kulcs élettartamát a Key Vault kezeli. Ha ez egy tanúsítványt tartalmazó kulcs, akkor a felügyelt kulcs igaz lesz.
release_policy	KeyReleasePolicy	Azokat a szabályzatszabályokat, amelyek alapján a kulcs exportálható.
tags	object	Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.

KeyCreateParameters

A kulcs hozza létre a paramétereket.

Name	Type	Description
attributes	KeyAttributes	A Key Vault szolgáltatás által kezelt kulcs attribútumai.
crv	JsonWebKeyCurveName	Elliptikus görbe neve. Érvényes értékek: JsonWebKeyCurveName.
key_ops	string[]	JSON webes kulcsműveletek. További információ: JsonWebKeyOperation.
key_size	integer	A kulcs mérete bitekben. Például: 2048, 3072 vagy 4096 RSA esetén.
kty	JsonWebKeyType	A létrehozandó kulcs típusa. Érvényes értékekért lásd: JsonWebKeyType.
public_exponent	integer	Az RSA-kulcs nyilvános kitevője.
release_policy	KeyReleasePolicy	Azokat a szabályzatszabályokat, amelyek alapján a kulcs exportálható.
tags	object	Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.

KeyReleasePolicy

Azokat a szabályzatszabályokat, amelyek alapján a kulcs exportálható.

Name	Type	Default Value	Description
contentType	string	application/json; charset=utf-8	A kulcskiadási szabályzat tartalomtípusa és verziója
data	string		Blobkódolás azokat a szabályzatszabályokat, amelyek alapján a kulcs felszabadítható. A blobnak base64 URL-kódolásúnak kell lennie.
immutable	boolean		Meghatározza a szabályzat módosíthatósági állapotát. A nem módosíthatóként megjelölt jelölő nem állítható alaphelyzetbe, és a szabályzat semmilyen körülmények között nem módosítható.

KeyVaultError

A Key Vault hibakivétele.

Name	Type	Description
error	Error	A Key Vault-kiszolgáló hibája.