Import Key - Import Key

Reference

Služba:: Key Vault

Verze rozhraní API:: 7.4

Naimportuje externě vytvořený klíč, uloží ho a vrátí klíčové parametry a atributy do klienta.
Operace importu klíče se dá použít k importu libovolného typu klíče do Key Vault Azure. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Tato operace vyžaduje oprávnění ke klíčům nebo importu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
key-name	path	True	string pattern: ^[0-9a-zA-Z-]+$	Název importovaného klíče Zadaná hodnota se může globálně zkopírovat za účelem spuštění služby. Zadaná hodnota by neměla zahrnovat identifikovatelné osobní údaje ani citlivé informace.
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze klientského rozhraní API

Text požadavku

Name	Vyžadováno	Typ	Description
key	True	JsonWebKey	Webový klíč JSON
Hsm		boolean	Zda se má importovat jako hardwarový klíč (HSM) nebo softwarový klíč.
attributes		KeyAttributes	Atributy správy klíčů.
release_policy		KeyReleasePolicy	Pravidla zásad, podle kterých lze klíč exportovat.
tags		object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

Odpovědi

Name	Typ	Description
200 OK	KeyBundle	Importovaná sada klíčů do trezoru
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující příčinu selhání operace.

Příklady

Import key

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Vyprázdnit", může být klíč trvale odstraněn uživatelem s oprávněním; v opačném případě může klíč na konci intervalu uchovávání vyprázdnit pouze systém.
Error	Chyba serveru trezoru klíčů.
JsonWebKey	Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
JsonWebKeyType	JsonWebKey Key Type (kty), jak je definováno v https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	Atributy klíče spravovaného službou trezoru klíčů.
KeyBundle	A KeyBundle skládající se z WebKey plus jeho atributy.
KeyImportParameters	Klíčové parametry importu
KeyReleasePolicy	Pravidla zásad, podle kterých lze klíč exportovat.
KeyVaultError	Výjimka chyby trezoru klíčů

DeletionRecoveryLevel

Výčet

Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Vyprázdnit", může být klíč trvale odstraněn uživatelem s oprávněním; v opačném případě může klíč na konci intervalu uchovávání vyprázdnit pouze systém.

Hodnota	Description
CustomizedRecoverable	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription	Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, pokud je 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.
CustomizedRecoverable+Purgeable	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není požadována operace vyprázdnění nebo pokud není zrušeno předplatné.
Purgeable	Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde k nenávratné ztrátě dat.
Recoverable	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
Recoverable+ProtectedSubscription	Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
Recoverable+Purgeable	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud není požadována operace vyprázdnění nebo pokud není předplatné zrušeno. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.

Error

Objekt

Chyba serveru trezoru klíčů.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva

JsonWebKey

Objekt

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

Name	Typ	Description
crv	JsonWebKeyCurveName	Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
d	string (base64url)	Privátní exponent RSA nebo komponenta D privátního klíče EC.
dp	string (base64url)	Parametr privátního klíče RSA.
dq	string (base64url)	Parametr privátního klíče RSA.
e	string (base64url)	Veřejný exponent RSA.
k	string (base64url)	Symetrický klíč.
key_hsm	string (base64url)	Chráněný klíč, který se používá s funkcí Přineste si vlastní klíč.
key_ops	string[]	Podporované operace s klíči.
kid	string	Identifikátor klíče.
kty	JsonWebKeyType	JsonWebKey Key Type (kty), jak je definováno v https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string (base64url)	Modul RSA.
p	string (base64url)	RSA secret prime.
q	string (base64url)	RSA secret prime, with p < q.
qi	string (base64url)	Parametr privátního klíče RSA.
x	string (base64url)	Součást X veřejného klíče ES.
y	string (base64url)	Y součásti veřejného klíče ES.

JsonWebKeyCurveName

Výčet

Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.

Hodnota	Description
P-256	Elliptická křivka NIST P-256, AKA SECG křivka SECP256R1.
P-256K	SeCG SECP256K1 tři tečky.
P-384	Elliptická křivka NIST P-384, AKA SECG křivka SECP384R1.
P-521	Elliptická křivka NIST P-521, AKA SECG křivka SECP521R1.

JsonWebKeyType

Výčet

JsonWebKey Key Type (kty), jak je definováno v https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Hodnota	Description
EC	Eliptická křivka.
EC-HSM	Eliptická křivka s privátním klíčem, který je uložený v hsm.
RSA	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	RSA s privátním klíčem, který je uložený v HSM.
oct	Sekvence oktetů (používá se k reprezentaci symetrických klíčů)
oct-HSM	Sekvence oktetů (používá se k reprezentaci symetrických klíčů), která je uložena v modulu HSM.

KeyAttributes

Objekt

Atributy klíče spravovaného službou trezoru klíčů.

Name	Typ	Description
created	integer (unixtime)	Čas vytvoření ve standardu UTC.
enabled	boolean	Určuje, zda je objekt povolen.
exp	integer (unixtime)	Datum vypršení platnosti v UTC.
exportable	boolean	Označuje, jestli je možné exportovat privátní klíč. Při vytváření první verze exportovatelného klíče je nutné zadat zásady vydané verze.
nbf	integer (unixtime)	Není před datem v UTC.
recoverableDays	integer (int32)	softDelete data retention days. Hodnota by měla být >=7 a <=90, pokud je povolená funkce softDelete, jinak 0.
recoveryLevel	DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Vyprázdnit", může být klíč trvale odstraněn uživatelem s oprávněním; v opačném případě může klíč na konci intervalu uchovávání vyprázdnit pouze systém.
updated	integer (unixtime)	Čas poslední aktualizace v UTC.

KeyBundle

Objekt

A KeyBundle skládající se z WebKey plus jeho atributy.

Name	Typ	Description
attributes	KeyAttributes	Atributy správy klíčů.
key	JsonWebKey	Webový klíč JSON.
managed	boolean	Hodnota True, pokud je životnost klíče spravovaná trezorem klíčů. Pokud se jedná o klíč, který slouží jako záložní certifikát, bude mít spravovaná hodnota true.
release_policy	KeyReleasePolicy	Pravidla zásad, podle kterých lze klíč exportovat.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

KeyImportParameters

Objekt

Klíčové parametry importu

Name	Typ	Description
Hsm	boolean	Zda se má importovat jako hardwarový klíč (HSM) nebo softwarový klíč.
attributes	KeyAttributes	Atributy správy klíčů.
key	JsonWebKey	Webový klíč JSON
release_policy	KeyReleasePolicy	Pravidla zásad, podle kterých lze klíč exportovat.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

KeyReleasePolicy

Objekt

Pravidla zásad, podle kterých lze klíč exportovat.

Name	Typ	Default value	Description
contentType	string	application/json; charset=utf-8	Typ obsahu a verze zásad vydání klíče
data	string (base64url)		Objekt blob kóduje pravidla zásad, podle kterých se dá klíč uvolnit. Objekt blob musí být zakódovaný jako adresa URL base64.
immutable	boolean		Definuje stav proměnlivosti zásad. Jakmile je tento příznak označený jako neměnný, nelze tento příznak resetovat a zásady nelze za žádných okolností změnit.

KeyVaultError

Objekt

Výjimka chyby trezoru klíčů

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

Sdílet prostřednictvím

Import Key - Import Key

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Import key

Ukázkový požadavek

Ukázková odpověď

Definice

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

Další materiály