Update Key - Update Key

Reference

Service:: Key Vault

API Version:: 7.4

Operace aktualizačního klíče změní zadané atributy uloženého klíče a dá se použít pro jakýkoli typ klíče a verzi klíče uložené v Azure Key Vault.
Aby bylo možné provést tuto operaci, musí klíč již existovat v Key Vault. Poznámka: Kryptografický materiál samotného klíče nelze změnit. Tato operace vyžaduje oprávnění ke klíčům nebo aktualizacím.

PATCH {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ý se má aktualizovat.
key-version	path	True	string	Verze klíče, která se má aktualizovat.
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	Typ	Description
attributes	KeyAttributes	Atributy klíče spravovaného službou trezoru klíčů.
key_ops	JsonWebKeyOperation[]	Operace s webovým klíčem JSON Další informace o možných operacích s klíčem najdete v tématu JsonWebKeyOperation.
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	Aktualizovaný klíč.
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující příčinu selhání operace.

Příklady

Update key

Sample Request

HTTP

PATCH https://myvault.vault.azure.net//keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088?api-version=7.4

{
  "key_ops": [
    "decrypt",
    "encrypt"
  ],
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800
  }
}

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088",
    "kty": "RSA",
    "key_ops": [
      "decrypt",
      "encrypt"
    ],
    "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800,
    "created": 1493860275,
    "updated": 1493860277,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

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.
JsonWebKeyOperation
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.
KeyReleasePolicy	Pravidla zásad, podle kterých lze klíč exportovat.
KeyUpdateParameters	Klíčové parametry aktualizace.
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 "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.

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. 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	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, 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	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. 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	string	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	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 v době, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
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. 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	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. 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

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 eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
d	string	Privátní exponent RSA nebo komponenta D privátního klíče EC.
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 součásti veřejného klíče ES.

JsonWebKeyCurveName

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

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

JsonWebKeyOperation

Name	Typ	Description
decrypt	string
encrypt	string
export	string
import	string
sign	string
unwrapKey	string
verify	string
wrapKey	string

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	Eliptická křivka 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	Sekvence oktetů (používá se k reprezentaci symetrických klíčů)
oct-HSM	string	Sekvence oktetů (používá se k reprezentaci symetrických klíčů), která je uložena v modulu 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	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	Není před datem v UTC.
recoverableDays	integer	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	Čas poslední aktualizace v UTC.

KeyBundle

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.

KeyReleasePolicy

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

Name	Typ	Výchozí hodnota	Description
contentType	string	application/json; charset=utf-8	Typ obsahu a verze zásad vydání klíče
data	string		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.

KeyUpdateParameters

Klíčové parametry aktualizace.

Name	Typ	Description
attributes	KeyAttributes	Atributy klíče spravovaného službou trezoru klíčů.
key_ops	JsonWebKeyOperation[]	Operace s webovým klíčem JSON Další informace o možných operacích s klíčem najdete v tématu JsonWebKeyOperation.
release_policy	KeyReleasePolicy	Pravidla zásad, podle kterých lze klíč exportovat.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

KeyVaultError

Výjimka chyby trezoru klíčů

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