Share via


Get Deleted Secret - Get Deleted Secret

Ottiene il segreto eliminato specificato.
L'operazione Get Deleted Secret restituisce il segreto eliminato specificato insieme ai relativi attributi. Questa operazione richiede l'autorizzazione secrets/get.

GET {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=7.4

Parametri dell'URI

Nome In Necessario Tipo Descrizione
secret-name
path True

string

Nome del segreto.

vaultBaseUrl
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

DeletedSecretBundle

Bundle segreto del segreto e dei relativi attributi.

Other Status Codes

KeyVaultError

Key Vault risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

GetDeletedSecret

Sample Request

GET https://myvault.vault.azure.net//deletedsecrets/GetDeletedSecretTest?api-version=7.4

Sample Response

{
  "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
  "deletedDate": 1493938433,
  "scheduledPurgeDate": 1501714433,
  "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
  "attributes": {
    "enabled": true,
    "created": 1493938433,
    "updated": 1493938433,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definizioni

Nome Descrizione
DeletedSecretBundle

Un segreto eliminato costituito dall'ID precedente, gli attributi e i relativi tag, nonché le informazioni su quando verrà rimosso.

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente attivo per i segreti nell'insieme di credenziali corrente. Se contiene "Purgeable", il segreto può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il segreto, alla fine dell'intervallo di conservazione.

Error

Errore del server dell'insieme di credenziali delle chiavi.

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

SecretAttributes

Attributi di gestione dei segreti.

DeletedSecretBundle

Un segreto eliminato costituito dall'ID precedente, gli attributi e i relativi tag, nonché le informazioni su quando verrà rimosso.

Nome Tipo Descrizione
attributes

SecretAttributes

Attributi di gestione dei segreti.

contentType

string

Tipo di contenuto del segreto.

deletedDate

integer

Ora in cui il segreto è stato eliminato, in formato UTC

id

string

ID segreto.

kid

string

Se si tratta di un segreto che esegue il backup di un certificato KV, questo campo specifica la chiave corrispondente che esegue il backup del certificato KV.

managed

boolean

True se la durata del segreto viene gestita dall'insieme di credenziali delle chiavi. Se si tratta di un segreto che esegue il backup di un certificato, la gestione sarà true.

recoveryId

string

URL dell'oggetto di ripristino, utilizzato per identificare e recuperare il segreto eliminato.

scheduledPurgeDate

integer

Ora in cui il segreto è pianificato per essere eliminato, in formato UTC

tags

object

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

value

string

Valore del segreto.

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente attivo per i segreti nell'insieme di credenziali corrente. Se contiene "Purgeable", il segreto può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il segreto, 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

Error

Errore del server dell'insieme di credenziali delle chiavi.

message

string

Messaggio di errore.

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

Nome Tipo Descrizione
error

Error

Errore del server dell'insieme di credenziali delle chiavi.

SecretAttributes

Attributi di gestione dei segreti.

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.

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

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente attivo per i segreti nell'insieme di credenziali corrente. Se contiene "Purgeable", il segreto può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il segreto, alla fine dell'intervallo di conservazione.

updated

integer

Ora dell'ultimo aggiornamento in formato UTC.