Update Key - Update Key
L'operazione chiave di aggiornamento modifica gli attributi specificati di una chiave archiviata e può essere applicata a qualsiasi tipo di chiave e versione della chiave archiviata in Azure Key Vault.
Per eseguire questa operazione è necessario che la chiave esista già nell'insieme di credenziali chiave. Nota: impossibile modificare il materiale crittografico di una chiave stessa. Questa operazione richiede l'autorizzazione chiavi/aggiornamento.
PATCH {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
key-name
|
path | True |
string |
Nome della chiave da aggiornare. |
key-version
|
path | True |
string |
Versione della chiave da aggiornare. |
vault
|
path | True |
string |
Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Versione API client. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
attributes |
Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi. |
|
key_ops |
Operazioni della chiave Web JSON. Per altre informazioni sulle possibili operazioni chiave, vedere JsonWebKeyOperation. |
|
release_policy |
Regole dei criteri in cui è possibile esportare la chiave. |
|
tags |
object |
Metadati specifici dell'applicazione sotto forma di coppie chiave-valore. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Chiave aggiornata. |
|
Other Status Codes |
Key Vault risposta di errore che descrive perché l'operazione non è riuscita. |
Esempio
Update key
Sample Request
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
{
"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"
}
}
Definizioni
Nome | Descrizione |
---|---|
Deletion |
Riflette il livello di ripristino di eliminazione attualmente effettivo per le chiavi nell'insieme di credenziali corrente. Se contiene "Eliminabile" la chiave può essere eliminata definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare la chiave, alla fine dell'intervallo di conservazione. |
Error |
Errore del server dell'insieme di credenziali delle chiavi. |
Json |
A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName. |
Json |
|
Json |
Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
Key |
Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi. |
Key |
KeyBundle costituito da un WebKey più i relativi attributi. |
Key |
Regole dei criteri in cui è possibile esportare la chiave. |
Key |
Parametri di aggiornamento delle chiavi. |
Key |
Eccezione di errore dell'insieme di credenziali delle chiavi. |
DeletionRecoveryLevel
Riflette il livello di ripristino di eliminazione attualmente effettivo per le chiavi nell'insieme di credenziali corrente. Se contiene "Eliminabile" la chiave può essere eliminata definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare la chiave, alla fine dell'intervallo di conservazione.
Nome | Tipo | Descrizione |
---|---|---|
CustomizedRecoverable |
string |
Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminare immediatamente e definitivamente (ad esempio, eliminare quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile. |
CustomizedRecoverable+ProtectedSubscription |
string |
Indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile, l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione e riflette anche il fatto che la sottoscrizione stessa non può essere annullata. |
CustomizedRecoverable+Purgeable |
string |
Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio, l'eliminazione quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. |
Purgeable |
string |
Indica uno stato dell'insieme di credenziali in cui l'eliminazione è un'operazione irreversibile, senza la possibilità di ripristino. Questo livello corrisponde a nessuna protezione disponibile per un'operazione Di eliminazione; i dati sono irreperibili quando si accetta un'operazione Di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via) |
Recoverable |
string |
Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente ,ad esempio l'eliminazione. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione(90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato |
Recoverable+ProtectedSubscription |
string |
Indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato |
Recoverable+Purgeable |
string |
Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente ,ad esempio l'eliminazione. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato |
Error
Errore del server dell'insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
innererror |
Errore del server dell'insieme di credenziali delle chiavi. |
|
message |
string |
Messaggio di errore. |
JsonWebKey
A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Nome | Tipo | Descrizione |
---|---|---|
crv |
Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName. |
|
d |
string |
Esponente privato RSA o componente D di una chiave privata EC. |
dp |
string |
Parametro chiave privata RSA. |
dq |
string |
Parametro chiave privata RSA. |
e |
string |
Esponente pubblico RSA. |
k |
string |
Chiave simmetrica. |
key_hsm |
string |
Chiave protetta, usata con "Bring Your Own Key". |
key_ops |
string[] |
Operazioni chiave supportate. |
kid |
string |
Identificatore della chiave. |
kty |
Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
|
n |
string |
Modulo RSA. |
p |
string |
RSA secret prime. |
q |
string |
RSA secret prime, con p < q. |
qi |
string |
Parametro chiave privata RSA. |
x |
string |
Componente X di una chiave pubblica EC. |
y |
string |
Componente Y di una chiave pubblica EC. |
JsonWebKeyCurveName
Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName.
Nome | Tipo | Descrizione |
---|---|---|
P-256 |
string |
Curva NIST P-256 ellittica, curva AKA SECG SECP256R1. |
P-256K |
string |
La curva seCG SECP256K1 ellittica. |
P-384 |
string |
Curva ellittica NIST P-384, curva AKA SECG SECP384R1. |
P-521 |
string |
Curva NIST P-521 ellittica, curva AKA SECG SECP521R1. |
JsonWebKeyOperation
Nome | Tipo | Descrizione |
---|---|---|
decrypt |
string |
|
encrypt |
string |
|
export |
string |
|
import |
string |
|
sign |
string |
|
unwrapKey |
string |
|
verify |
string |
|
wrapKey |
string |
JsonWebKeyType
Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
Nome | Tipo | Descrizione |
---|---|---|
EC |
string |
Curva ellittica. |
EC-HSM |
string |
Curva ellittica con una chiave privata archiviata nel modulo di protezione hardware. |
RSA |
string |
|
RSA-HSM |
string |
RSA con una chiave privata archiviata nel modulo di protezione hardware. |
oct |
string |
Sequenza di ottet (usata per rappresentare chiavi simmetriche) |
oct-HSM |
string |
Sequenza di ottet (usata per rappresentare chiavi simmetriche) archiviata nel modulo di protezione hardware. |
KeyAttributes
Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
created |
integer |
Ora di creazione in formato UTC. |
enabled |
boolean |
Determina se l'oggetto è abilitato. |
exp |
integer |
Data di scadenza in FORMATO UTC. |
exportable |
boolean |
Indica se la chiave privata può essere esportata. I criteri di rilascio devono essere forniti quando si crea la prima versione di una chiave esportabile. |
nbf |
integer |
Non prima della data UTC. |
recoverableDays |
integer |
giorni di conservazione dei dati softDelete. Il valore deve essere >=7 e <=90 quando softDelete abilitato, in caso contrario 0. |
recoveryLevel |
Riflette il livello di ripristino di eliminazione attualmente effettivo per le chiavi nell'insieme di credenziali corrente. Se contiene "Eliminabile" la chiave può essere eliminata definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare la chiave, alla fine dell'intervallo di conservazione. |
|
updated |
integer |
Ultima ora aggiornata in FORMATO UTC. |
KeyBundle
KeyBundle costituito da un WebKey più i relativi attributi.
Nome | Tipo | Descrizione |
---|---|---|
attributes |
Attributi di gestione delle chiavi. |
|
key |
Chiave Web Json. |
|
managed |
boolean |
True se la durata della chiave viene gestita dall'insieme di credenziali delle chiavi. Se si tratta di un backup di una chiave di un certificato, sarà true. |
release_policy |
Regole dei criteri in cui è possibile esportare la chiave. |
|
tags |
object |
Metadati specifici dell'applicazione sotto forma di coppie chiave-valore. |
KeyReleasePolicy
Regole dei criteri in cui è possibile esportare la chiave.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
contentType |
string |
application/json; charset=utf-8 |
Tipo di contenuto e versione dei criteri di rilascio della chiave |
data |
string |
Codifica BLOB delle regole dei criteri in cui è possibile rilasciare la chiave. Il BLOB deve essere codificato con URL base64. |
|
immutable |
boolean |
Definisce lo stato di mutabilità del criterio. Dopo aver contrassegnato l'immutabile, questo flag non può essere reimpostato e i criteri non possono essere modificati in qualsiasi circostanza. |
KeyUpdateParameters
Parametri di aggiornamento delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
attributes |
Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi. |
|
key_ops |
Operazioni della chiave Web JSON. Per altre informazioni sulle possibili operazioni chiave, vedere JsonWebKeyOperation. |
|
release_policy |
Regole dei criteri in cui è possibile esportare la chiave. |
|
tags |
object |
Metadati specifici dell'applicazione sotto forma di coppie chiave-valore. |
KeyVaultError
Eccezione di errore dell'insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore del server dell'insieme di credenziali delle chiavi. |