Update Key - Update Key

Referencia

Service:: Key Vault

API Version:: 7.4

A frissítési kulcs művelet megváltoztatja a tárolt kulcs megadott attribútumait, és az Azure Key Vault tárolt kulcstípusokra és kulcsverziókra alkalmazható.
A művelet végrehajtásához a kulcsnak már léteznie kell a Key Vault. Megjegyzés: Maga a kulcs titkosítási anyaga nem módosítható. Ehhez a művelethez kulcsok/frissítési engedély szükséges.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
key-name	path	True	string	A frissíteni kívánt kulcs neve.
key-version	path	True	string	A frissíteni kívánt kulcs verziója.
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	Típus	Description
attributes	KeyAttributes	A key vault szolgáltatás által kezelt kulcs attribútumai.
key_ops	JsonWebKeyOperation[]	Json webes kulcsműveletek. A lehetséges kulcsműveletekkel kapcsolatos további információkért lásd: JsonWebKeyOperation.
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	A frissített kulcs.
Other Status Codes	KeyVaultError	Key Vault hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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

Definíciók

Name	Description
DeletionRecoveryLevel	Az aktuális tároló kulcsainak törlési helyreállítási szintjét tükrözi. Ha a "Törölhető" elemet tartalmazza, a kulcsot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer tudja kiüríteni a kulcsot a megőrzési időköz végén.
Error	A Key Vault-kiszolgáló hibája.
JsonWebKey	A 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.
JsonWebKeyOperation
JsonWebKeyType	JsonWebKey kulcstípus (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 attribútumaiból álló KeyBundle.
KeyReleasePolicy	Azokat a szabályzatszabályokat, amelyek alapján a kulcs exportálható.
KeyUpdateParameters	A kulcsfrissítési paraméterek.
KeyVaultError	A key vault hibakivétele.

DeletionRecoveryLevel

Az aktuális tároló kulcsainak törlési helyreállítási szintjét tükrözi. Ha a "Törölhető" elemet tartalmazza, a kulcsot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer tudja kiüríteni a kulcsot a megőrzési időköz végén.

Name	Típus	Description
CustomizedRecoverable	string	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz törlés, 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őköz 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őköz 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 törlést, amikor 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, 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 nem felel meg a Törlés művelet elleni védelemnek; az adatok helyrehozhatatlanul elvesznek egy törlési művelet entitásszinten vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) elfogadásakor.
Recoverable	string	Olyan tárolóállapotot jelöl, 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) van 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őköz (90 nap) alatt, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap elteltével 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 helyreállítható a megőrzési időtartamon belül (90 nap), 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 elteltével véglegesen törli, ha nem állítható helyre
Recoverable+Purgeable	string	Olyan tárolóállapotot jelöl, 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 elteltével 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

A 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 titkos kulcs paramétere.
dq	string	RSA titkos kulcs paramétere.
e	string	RSA nyilvános kitevő.
k	string	Szimmetrikus kulcs.
key_hsm	string	Védett kulcs, amelyet a "Saját kulcs használata" kifejezéssel használnak.
key_ops	string[]	Támogatott kulcsműveletek.
kid	string	Kulcsazonosító.
kty	JsonWebKeyType	JsonWebKey kulcstípus (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 titkos kulcs paramétere.
x	string	Egy NYILVÁNOS EC-kulcs X összetevője.
y	string	Egy EC nyilvános kulcs Y összetevője.

JsonWebKeyCurveName

Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.

Name	Típus	Description
P-256	string	A NIST P-256 háromliptikus görbe, az AKA SECG-görbe SECP256R1.
P-256K	string	A SECG SECP256K1 háromliptikus görbe.
P-384	string	Az NIST P-384 háromliptikus görbe, az AKA SECG-görbe SECP384R1.
P-521	string	Az NIST P-521 háromliptikus görbe, 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

JsonWebKey kulcstípus (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	Oktet sorozat (szimmetrikus kulcsok ábrázolására szolgál)
oct-HSM	string	A HSM-et tároló oktettütemezés (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-ben.
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	Dátum előtt nem UTC-ben.
recoverableDays	integer	softDelete adatmegőrzési napok. Ha a softDelete engedélyezve van >, akkor az érték =7 és <=90 lehet, ellenkező esetben 0.
recoveryLevel	DeletionRecoveryLevel	Az aktuális tároló kulcsainak törlési helyreállítási szintjét tükrözi. Ha a "Törölhető" elemet tartalmazza, a kulcsot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer tudja kiüríteni a kulcsot a megőrzési időköz végén.
updated	integer	Utolsó frissítés időpontja UTC-ben.

KeyBundle

Egy WebKey-ből és attribútumaiból álló KeyBundle.

Name	Típus	Description
attributes	KeyAttributes	A kulcskezelési attribútumok.
key	JsonWebKey	A Json webkulcs.
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.

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 alapján a kulcs kiadható. A blobnak base64 URL-címet kell kódolnia.
immutable	boolean		Meghatározza a szabályzat módosíthatósági állapotát. Ha a megjelölés nem módosítható, ez a jelző nem állítható alaphelyzetbe, és a szabályzat semmilyen körülmények között nem módosítható.

KeyUpdateParameters

A kulcsfrissítési paraméterek.

Name	Típus	Description
attributes	KeyAttributes	A key vault szolgáltatás által kezelt kulcs attribútumai.
key_ops	JsonWebKeyOperation[]	Json webes kulcsműveletek. A lehetséges kulcsműveletekkel kapcsolatos további információkért lásd: JsonWebKeyOperation.
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.

KeyVaultError

A key vault hibakivétele.

Name	Típus	Description
error	Error	A Key Vault-kiszolgáló hibája.

Megosztás a következőn keresztül: