Import Key - Import Key

Referencia

Service:: Key Vault

API Version:: 7.4

Importál egy külsőleg létrehozott kulcsot, tárolja, és kulcsparamétereket és attribútumokat ad vissza az ügyfélnek.
Az importálási kulcs művelettel bármilyen kulcstípust importálhat egy Azure-Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Ehhez a művelethez kulcsok/importálási engedély szükséges.

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

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
key-name	path	True	string	Az importált kulcs neve. 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 információkat. 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 importált kulcs neve. 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 információkat.

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	Kötelező	Típus	Description
key	True	JsonWebKey	A JSON webes kulcsa
Hsm		boolean	Hardverkulcsként (HSM) vagy szoftverkulcsként történő importálás.
attributes		KeyAttributes	A kulcskezelési attribútumok.
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.

Válaszok

Name	Típus	Description
200 OK	KeyBundle	Kulcscsomag importálása a tárolóba.
Other Status Codes	KeyVaultError	Key Vault hibaválasz leírja, hogy miért hiúsult meg a művelet.

Példák

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

Definíciók

Name	Description
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.
Error	A Key Vault-kiszolgáló hibája.
JsonWebKey	2015. http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.
JsonWebKeyType	A JsonWebKey kulcstípusa (kty), a következőben definiálva 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 annak attribútumaiból álló KeyBundle.
KeyImportParameters	A kulcsimportálási paraméterek.
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ó 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	Error	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	JsonWebKeyCurveName	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	JsonWebKeyType	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.

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 (https://tools.ietf.org/html/rfc3447)
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	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.
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	KeyAttributes	A kulcskezelési attribútumok.
key	JsonWebKey	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	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.

KeyImportParameters

A kulcsimportálási paraméterek.

Name	Típus	Description
Hsm	boolean	Hardverkulcsként (HSM) vagy szoftverkulcsként történő importálás.
attributes	KeyAttributes	A kulcskezelési attribútumok.
key	JsonWebKey	A JSON webes kulcsa
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	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	Error	A Key Vault-kiszolgáló hibája.

Share via

Import Key - Import Key

URI-paraméterek

Kérelem törzse

Válaszok

Példák

Import key

Sample Request

Sample Response

Definíciók

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

További források