Create Key - Create Key
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.4
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
key-name
|
path | True |
string |
Az új kulcs neve. A rendszer létrehozza az új kulcs verziónevét. A megadott érték globálisan másolható a szolgáltatás futtatása céljából. A megadott érték nem tartalmazhat személyazonosításra alkalmas vagy bizalmas adatokat. Regex pattern: |
vault
|
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 | Kötelező | Típus | Description |
---|---|---|---|
kty | True |
A létrehozandó kulcs típusa. Érvényes értékekért lásd: JsonWebKeyType. |
|
attributes |
A key vault szolgáltatás által kezelt kulcs attribútumai. |
||
crv |
Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. |
||
key_ops |
JSON-webkulcs-mű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 |
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. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A kulcskérelem eredményét tartalmazó kulcscsomag. |
|
Other Status Codes |
Key Vault hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Példák
Create key
Sample Request
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
{
"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
Name | Description |
---|---|
Deletion |
Az aktuális tároló kulcsainak jelenleg érvényben lévő 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. |
Json |
2015. http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. |
Json |
|
Json |
A JsonWebKey kulcstípusa (kty), a következőben definiálva https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40: . |
Key |
A key vault szolgáltatás által kezelt kulcs attribútumai. |
Key |
Egy WebKey-ből és annak attribútumaiból álló KeyBundle. |
Key |
A kulcs hozza létre a paramétereket. |
Key |
Azokat a szabályzatszabályokat, amelyek alapján a kulcs exportálható. |
Key |
A Key Vault hibakivétele. |
DeletionRecoveryLevel
Az aktuális tároló kulcsainak jelenleg érvényben lévő 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 | Típus | 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ó (azaz 7<= SoftDeleteRetentionInDays < 90 esetén végleges törlés). 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 (azaz a végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen, ha 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 (azaz a 7<= SoftDeleteRetentionInDays < 90 utáni 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, 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, a helyreállítás lehetősége nélkül. 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és 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 helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz végleges törlésre) lennének lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam (90 nap) alatt, é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 (azaz 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 |
Egy tároló állapotát jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a 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 | Típus | Description |
---|---|---|
code |
string |
A hibakód. |
innererror |
A Key Vault-kiszolgáló hibája. |
|
message |
string |
A hibaüzenet. |
JsonWebKey
2015. http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Name | Típus | Description |
---|---|---|
crv |
Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. |
|
d |
string |
RSA privát kitevő, 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" beállítással használt védett kulcs. |
key_ops |
string[] |
Támogatott kulcsműveletek. |
kid |
string |
Kulcsazonosító. |
kty |
A JsonWebKey kulcstípusa (kty), a következőben definiálva 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ért lásd: JsonWebKeyCurveName.
Name | Típus | Description |
---|---|---|
P-256 |
string |
Az NIST P-256 elliptikus görbéje, az AKA SECG-görbe SECP256R1. |
P-256K |
string |
A SECG SECP256K1 elliptikus görbe. |
P-384 |
string |
Az NIST P-384 elliptikus görbéje, az AKA SECG-görbe SECP384R1. |
P-521 |
string |
Az NIST P-521 elliptikus görbéje, az AKA SECG-görbe SECP521R1. |
JsonWebKeyOperation
Name | Típus | Description |
---|---|---|
decrypt |
string |
|
encrypt |
string |
|
export |
string |
|
import |
string |
|
sign |
string |
|
unwrapKey |
string |
|
verify |
string |
|
wrapKey |
string |
JsonWebKeyType
A JsonWebKey kulcstípusa (kty), a következőben definiálva https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40: .
Name | Típus | Description |
---|---|---|
EC |
string |
Elliptikus görbe. |
EC-HSM |
string |
Elliptikus görbe a HSM-ben tárolt titkos kulccsal. |
RSA |
string |
|
RSA-HSM |
string |
RSA a HSM-ben tárolt titkos kulccsal. |
oct |
string |
Oktettsorozat (szimmetrikus kulcsok ábrázolására szolgál) |
oct-HSM |
string |
A HSM-ben tárolt oktettsorozat (szimmetrikus kulcsok ábrázolására szolgál). |
KeyAttributes
A key vault szolgáltatás által kezelt kulcs attribútumai.
Name | Típus | Description |
---|---|---|
created |
integer |
Létrehozás időpontja UTC-ben. |
enabled |
boolean |
Meghatározza, hogy az objektum engedélyezve van-e. |
exp |
integer |
Lejárati dátum (UTC) |
exportable |
boolean |
Azt jelzi, hogy exportálható-e a titkos kulcs. Az exportálható kulcs első verziójának létrehozásakor kiadási szabályzatot kell megadni. |
nbf |
integer |
Időpont előtt utc. |
recoverableDays |
integer |
softDelete adatmegőrzési napok. Az érték =7 és <=90 lehet>, ha a softDelete engedélyezve van, ellenkező esetben 0. |
recoveryLevel |
Az aktuális tároló kulcsainak jelenleg érvényben lévő 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 annak attribútumaiból álló KeyBundle.
Name | Típus | Description |
---|---|---|
attributes |
A kulcskezelési attribútumok. |
|
key |
A Json webes kulcs. |
|
managed |
boolean |
Igaz, ha a kulcs élettartamát a key vault kezeli. Ha ez egy tanúsítványt alátámasztó kulcs, akkor a felügyelt érték igaz lesz. |
release_policy |
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 | Típus | Description |
---|---|---|
attributes |
A key vault szolgáltatás által kezelt kulcs attribútumai. |
|
crv |
Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. |
|
key_ops |
JSON-webkulcs-mű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 |
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 |
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 | Típus | Alapértelmezett érték | 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 alatt 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 jelző 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 | Típus | Description |
---|---|---|
error |
A Key Vault-kiszolgáló hibája. |