Get Secret - Get Secret

Riferimento

Servizio:: Key Vault

Versione API:: 7.4

Ottenere un segreto specificato da un determinato insieme di credenziali delle chiavi.
L'operazione GET è applicabile a qualsiasi segreto archiviato nell'insieme di credenziali chiave di Azure. Questa operazione richiede i segreti o ottenere l'autorizzazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
secret-name	path	True	string	Nome del segreto.
secret-version	path	True	string	Versione del segreto. Questo frammento URI è facoltativo. Se non specificato, viene restituita la versione più recente 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	SecretBundle	Segreto recuperato.
Other Status Codes	KeyVaultError	Key Vault risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

GetSecret

Esempio di richiesta

HTTP

GET https://myvault.vault.azure.net//secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79?api-version=7.4

Risposta di esempio

Codice di stato:: 200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79",
  "attributes": {
    "enabled": true,
    "created": 1493938410,
    "updated": 1493938410,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definizioni

Nome	Descrizione
DeletionRecoveryLevel	Riflette il livello di ripristino di eliminazione attualmente effettivo 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ò eliminare 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.
SecretBundle	Segreto costituito da un valore, id e i relativi attributi.

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente effettivo 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ò eliminare 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 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	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 UTC.
recoverableDays	integer	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 effettivo 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ò eliminare il segreto, alla fine dell'intervallo di conservazione.
updated	integer	Ultima ora aggiornata in FORMATO UTC.

SecretBundle

Segreto costituito da un valore, id e i relativi attributi.

Nome	Tipo	Descrizione
attributes	SecretAttributes	Attributi di gestione dei segreti.
contentType	string	Tipo di contenuto del segreto.
id	string	ID segreto.
kid	string	Se si tratta di un backup segreto 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 backup segreto di un certificato, sarà vero.
tags	object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.
value	string	Valore segreto.

Condividi tramite