Dela via

Update Key - Update Key

  • Referens
Tjänst:
Key Vault
API-version:
7.4

Uppdateringsnyckelåtgärden ändrar angivna attribut för en lagrad nyckel och kan tillämpas på valfri nyckeltyp och nyckelversion som lagras i Azure Key Vault.
För att kunna utföra den här åtgärden måste nyckeln redan finnas i Key Vault. Obs! Det går inte att ändra själva nyckelns kryptografiska material. Den här åtgärden kräver behörigheten nycklar/uppdatering.

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

URI-parametrar

Name I Obligatorisk Typ Description
key-name
 path True

string

Namnet på nyckeln som ska uppdateras.
key-version
 path True

string

Den version av nyckeln som ska uppdateras.
vaultBaseUrl
 path True

string

Valvnamnet, till exempel https://myvault.vault.azure.net.
api-version
 query True

string

Klient-API-version.

Begärandetext

Name Typ Description
attributes

KeyAttributes

Attributen för en nyckel som hanteras av key vault-tjänsten.
key_ops

JsonWebKeyOperation[]

Json-webbnyckelåtgärder. Mer information om möjliga nyckelåtgärder finns i JsonWebKeyOperation.
release_policy

KeyReleasePolicy

De principregler som nyckeln kan exporteras under.
tags

object

Programspecifika metadata i form av nyckel/värde-par.

Svar

Name Typ Description
200 OK

KeyBundle

Den uppdaterade nyckeln.
Other Status Codes

KeyVaultError

Key Vault felsvar som beskriver varför åtgärden misslyckades.

Exempel

Update key

Exempelbegäran

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

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

Exempelsvar

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

Definitioner

Name Description
DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för nycklar i det aktuella valvet. Om den innehåller "Rensningsbar" kan nyckeln tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa nyckeln i slutet av kvarhållningsintervallet.
Error

Nyckelvalvsserverfelet.
JsonWebKey

Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

Elliptiskt kurvnamn. Giltiga värden finns i JsonWebKeyCurveName.
JsonWebKeyOperation
JsonWebKeyType

JsonWebKey Nyckeltyp (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Attributen för en nyckel som hanteras av key vault-tjänsten.
KeyBundle

En KeyBundle som består av en WebKey plus dess attribut.
KeyReleasePolicy

De principregler som nyckeln kan exporteras under.
KeyUpdateParameters

Viktiga uppdateringsparametrar.
KeyVaultError

Felfelet för nyckelvalvet.

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för nycklar i det aktuella valvet. Om den innehåller "Rensningsbar" kan nyckeln tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa nyckeln i slutet av kvarhållningsintervallet.

Name Typ Description
CustomizedRecoverable

string

Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig.
CustomizedRecoverable+ProtectedSubscription

string

Anger ett valv- och prenumerationstillstånd där borttagning kan återställas, omedelbar och permanent borttagning (dvs. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent när 7<= SoftDeleteRetentionInDays < 90. Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och återspeglar även det faktum att själva prenumerationen inte kan avbrytas.
CustomizedRecoverable+Purgeable

string

Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts.
Purgeable

string

Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligen förlorade när en borttagningsåtgärd accepteras på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)
Recoverable

string

Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Recoverable+ProtectedSubscription

string

Anger ett valv- och prenumerationstillstånd där borttagning kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (dvs. rensning) är inte tillåtet och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Recoverable+Purgeable

string

Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (t.ex. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs

Error

Nyckelvalvsserverfelet.

Name Typ Description
code

string

Felkoden.
innererror

Error

Nyckelvalvsserverfelet.
message

string

Felmeddelandet.

JsonWebKey

Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name Typ Description
crv

JsonWebKeyCurveName

Elliptiskt kurvnamn. Giltiga värden finns i JsonWebKeyCurveName.
d

string

Privat RSA-exponent eller D-komponenten för en privat EC-nyckel.
dp

string

RSA privat nyckelparameter.
dq

string

RSA privat nyckelparameter.
e

string

RSA offentlig exponent.
k

string

Symmetrisk nyckel.
key_hsm

string

Skyddad nyckel, som används med "Bring Your Own Key".
key_ops

string[]

Nyckelåtgärder som stöds.
kid

string

Nyckelidentifierare.
kty

JsonWebKeyType

JsonWebKey Nyckeltyp (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n

string

RSA-modulus.
p

string

RSA hemlighet prime.
q

string

RSA secret prime, med p < q.
qi

string

RSA privat nyckelparameter.
x

string

X-komponent i en offentlig EG-nyckel.
y

string

Y-komponent i en offentlig EG-nyckel.

JsonWebKeyCurveName

Elliptiskt kurvnamn. Giltiga värden finns i JsonWebKeyCurveName.

Name Typ Description
P-256

string

NIST P-256 elliptisk kurva, AKA SECG kurva SECP256R1.
P-256K

string

SECG-SECP256K1 elliptisk kurva.
P-384

string

NIST P-384 elliptisk kurva, AKA SECG kurva SECP384R1.
P-521

string

NIST P-521 elliptisk kurva, AKA SECG kurva SECP521R1.

JsonWebKeyOperation

Name Typ Description
decrypt

string

encrypt

string

export

string

import

string

sign

string

unwrapKey

string

verify

string

wrapKey

string

JsonWebKeyType

JsonWebKey Nyckeltyp (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name Typ Description
EC

string

Elliptisk kurva.
EC-HSM

string

Elliptisk kurva med en privat nyckel som lagras i HSM.
RSA

string

RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM

string

RSA med en privat nyckel som lagras i HSM.
oct

string

Oktettsekvens (används för att representera symmetriska nycklar)
oct-HSM

string

Oktettsekvens (används för att representera symmetriska nycklar) som lagras HSM.

KeyAttributes

Attributen för en nyckel som hanteras av key vault-tjänsten.

Name Typ Description
created

integer

Skapandetid i UTC.
enabled

boolean

Avgör om objektet är aktiverat.
exp

integer

Förfallodatum i UTC.
exportable

boolean

Anger om den privata nyckeln kan exporteras. Versionsprincip måste anges när du skapar den första versionen av en exporterbar nyckel.
nbf

integer

Inte före datum i UTC.
recoverableDays

integer

softTa bort datakvarhållningsdagar. Värdet ska vara >=7 och <=90 när softDelete är aktiverat, annars 0.
recoveryLevel

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för nycklar i det aktuella valvet. Om den innehåller "Rensningsbar" kan nyckeln tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa nyckeln i slutet av kvarhållningsintervallet.
updated

integer

Senast uppdaterad tid i UTC.

KeyBundle

En KeyBundle som består av en WebKey plus dess attribut.

Name Typ Description
attributes

KeyAttributes

Nyckelhanteringsattributen.
key

JsonWebKey

Json-webbnyckeln.
managed

boolean

Sant om nyckelns livslängd hanteras av nyckelvalvet. Om det här är en nyckel som stöder ett certifikat är hanterad sant.
release_policy

KeyReleasePolicy

De principregler som nyckeln kan exporteras under.
tags

object

Programspecifika metadata i form av nyckel/värde-par.

KeyReleasePolicy

De principregler som nyckeln kan exporteras under.

Name Typ Standardvärde Description
contentType

string

application/json; charset=utf-8

Innehållstyp och version av nyckelfrisläppningsprincip
data

string

Blobkodning av de principregler som nyckeln kan släppas under. Blob måste vara base64 URL-kodad.
immutable

boolean

Definierar principens föränderlighetstillstånd. När den här flaggan har markerats som oföränderlig kan den inte återställas och principen kan inte ändras under några omständigheter.

KeyUpdateParameters

Viktiga uppdateringsparametrar.

Name Typ Description
attributes

KeyAttributes

Attributen för en nyckel som hanteras av key vault-tjänsten.
key_ops

JsonWebKeyOperation[]

Json-webbnyckelåtgärder. Mer information om möjliga nyckelåtgärder finns i JsonWebKeyOperation.
release_policy

KeyReleasePolicy

De principregler som nyckeln kan exporteras under.
tags

object

Programspecifika metadata i form av nyckel/värde-par.

KeyVaultError

Felfelet för nyckelvalvet.

Name Typ Description
error

Error

Nyckelvalvsserverfelet.