Recover Deleted Key - Recover Deleted Key
Recupera la chiave eliminata alla versione più recente.
L'operazione Ripristina chiave eliminata è applicabile per le chiavi eliminate negli insiemi di credenziali abilitati per l'eliminazione temporanea. Ripristina la chiave eliminata alla versione più recente in /keys. Un tentativo di ripristino di una chiave non eliminata restituirà un errore. Si consideri l'inverso dell'operazione di eliminazione negli insiemi di credenziali abilitati per l'eliminazione temporanea. Questa operazione richiede l'autorizzazione chiavi/ripristino.
POST {vaultBaseUrl}/deletedkeys/{key-name}/recover?api-version=7.4
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
key-name
|
path | True |
string |
Nome della chiave eliminata. |
vault
|
path | True |
string |
Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Versione API client. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Bundle di chiavi della chiave originale e dei relativi attributi |
|
Other Status Codes |
Key Vault risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Esempio
RecoverDeletedKey
Sample Request
POST https://myvault.vault.azure.net//deletedkeys/CreateDeleteRecoverPurgeTest/recover?api-version=7.4
Sample Response
{
"key": {
"kid": "https://myvault.vault.azure.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996",
"kty": "RSA",
"key_ops": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey"
],
"n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q",
"e": "AQAB"
},
"attributes": {
"enabled": true,
"created": 1493938342,
"updated": 1493938342,
"recoveryLevel": "Recoverable+Purgeable"
},
"tags": {
"purpose": "unit test",
"test name ": "CreateDeleteRecoverPurgeTest"
}
}
Definizioni
Nome | Descrizione |
---|---|
Deletion |
Riflette il livello di ripristino di eliminazione attualmente attivo 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ò ripulire 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 i valori validi, vedere JsonWebKeyCurveName. |
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 |
Eccezione di errore dell'insieme di credenziali delle chiavi. |
DeletionRecoveryLevel
Riflette il livello di ripristino di eliminazione attualmente attivo 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ò ripulire 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 eliminazione immediata e permanente (ad esempio, l'eliminazione 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 un insieme di credenziali e uno stato di sottoscrizione in cui l'eliminazione è recuperabile, l'eliminazione immediata e permanente (ad esempio, l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata in modo permanente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la recuperabilità 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 quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o che 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 non corrisponde a alcuna protezione disponibile per un'operazione di eliminazione; i dati vengono persi in modo irreversibile 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 recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato |
Recoverable+ProtectedSubscription |
string |
Indica uno stato dell'insieme di credenziali e della sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ad esempio l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimini 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 recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o che la sottoscrizione venga annullata. Il sistema lo elimini 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 i valori validi, vedere JsonWebKeyCurveName. |
|
d |
string |
Esponente privato RSA o componente D di una chiave privata EC. |
dp |
string |
Parametro della chiave privata RSA. |
dq |
string |
Parametro della 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 di 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 della 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 i valori validi, vedere JsonWebKeyCurveName.
Nome | Tipo | Descrizione |
---|---|---|
P-256 |
string |
Curva ellittica NIST P-256, curva AKA SECG SECP256R1. |
P-256K |
string |
SeCG SECP256K1 curva ellittica. |
P-384 |
string |
Curva ellittica NIST P-384, curva AKA SECG SECP384R1. |
P-521 |
string |
Curva ellittica NIST P-521, curva AKA SECG SECP521R1. |
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. Quando si crea la prima versione di una chiave esportabile, è necessario specificare i criteri di rilascio. |
nbf |
integer |
Non prima della data in formato UTC. |
recoverableDays |
integer |
softDelete data retention days (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 attivo 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ò ripulire la chiave, alla fine dell'intervallo di conservazione. |
|
updated |
integer |
Ora dell'ultimo aggiornamento 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 una chiave che esegue il backup di un certificato, la gestione 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 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 mutabilità dei criteri. Una volta contrassegnato come non modificabile, questo flag non può essere reimpostato e i criteri non possono essere modificati in alcuna circostanza. |
KeyVaultError
Eccezione di errore dell'insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore del server dell'insieme di credenziali delle chiavi. |