Get Key - Get Key

Reference

Služba:: Key Vault

Verze rozhraní API:: 7.4

Získá veřejnou část uloženého klíče.
Operace získání klíče je použitelná pro všechny typy klíčů. Pokud je požadovaný klíč symetrický, v odpovědi se neuvolní žádný materiál. Tato operace vyžaduje oprávnění ke klíčům nebo získání.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
key-name	path	True	string	Název klíče, který chcete získat.
key-version	path	True	string	Přidání parametru verze načte konkrétní verzi klíče. Tento fragment identifikátoru URI je volitelný. Pokud není zadaný, vrátí se nejnovější verze klíče.
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	KeyBundle	Sada klíčů obsahující klíč a jeho atributy.
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující, proč operace selhala.

Příklady

Get key

Ukázkový požadavek

HTTP

GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?api-version=7.4

Ukázková odpověď

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

Definice

Name	Description
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Purgeable", 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 elliptické 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	KeyBundle skládající se z WebKey plus jeho atributy.
KeyReleasePolicy	Pravidla zásad, podle kterých je možné klíč exportovat.
KeyVaultError	Výjimka chyby trezoru klíčů

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Purgeable", 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.

Name	Typ	Description
CustomizedRecoverable	string	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. vyprázdně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	string	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, když 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	string	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. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není vyžadována operace vyprázdnění nebo se nezruší předplatné.
Purgeable	string	Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá žádné ochraně není k dispozici 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	string	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 po dobu, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Recoverable+ProtectedSubscription	string	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. vyprázdnění) není povoleno a ve kterém nelze trvale zrušit samotné předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Recoverable+Purgeable	string	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. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud se nevyžádá operace vyprázdnění nebo se nezruší předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví

Error

Chyba serveru trezoru klíčů.

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

JsonWebKey

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

Name	Typ	Description
crv	JsonWebKeyCurveName	Název elliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
d	string	RsA private exponent, or the D component of an EC private key.
dp	string	Parametr privátního klíče RSA.
dq	string	Parametr privátního klíče RSA.
e	string	Veřejný exponent RSA.
k	string	Symetrický klíč.
key_hsm	string	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	Modul RSA.
p	string	RSA secret prime.
q	string	RSA secret prime, with p < q.
qi	string	Parametr privátního klíče RSA.
x	string	Součást X veřejného klíče ES.
y	string	Y složky veřejného klíče ES.

JsonWebKeyCurveName

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

Name	Typ	Description
P-256	string	Elliptická křivka NIST P-256 neboli křivka SECG SECP256R1.
P-256K	string	SeCG SECP256K1 tři tečky.
P-384	string	Elliptická křivka NIST P-384 neboli křivka SECG SECP384R1.
P-521	string	Elliptická křivka NIST P-521 neboli křivka SECG SECP521R1.

JsonWebKeyType

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

Name	Typ	Description
EC	string	Eliptická křivka.
EC-HSM	string	Tři tečky s privátním klíčem, který je uložený v HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA s privátním klíčem, který je uložený v HSM.
oct	string	Posloupnost oktetů (slouží k reprezentaci symetrických klíčů)
oct-HSM	string	Sekvence oktetů (sloužící k reprezentaci symetrických klíčů), která je uložena modulem HSM.

KeyAttributes

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

Name	Typ	Description
created	integer	Čas vytvoření ve standardu UTC
enabled	boolean	Určuje, zda je objekt povolen.
exp	integer	Datum vypršení platnosti v UTC.
exportable	boolean	Určuje, jestli je možné privátní klíč exportovat. Při vytváření první verze exportovatelného klíče je potřeba zadat zásady vydané verze.
nbf	integer	Není před datem ve standardu UTC.
recoverableDays	integer	softDelete data retention days. Pokud je povolená funkce softDelete, hodnota by měla být >=7 a <=90, jinak 0.
recoveryLevel	DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Purgeable", 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	Čas poslední aktualizace v UTC.

KeyBundle

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ý zálohuje certifikát, bude spravovaná hodnota true.
release_policy	KeyReleasePolicy	Pravidla zásad, podle kterých je možné klíč exportovat.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

KeyReleasePolicy

Pravidla zásad, podle kterých je možné klíč exportovat.

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

KeyVaultError

Výjimka chyby trezoru klíčů

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

Sdílet prostřednictvím