Get Secrets - Get Secrets
Elencare i segreti in un insieme di credenziali delle chiavi specificato.
L'operazione Get Secrets è applicabile all'intero insieme di credenziali. Tuttavia, solo l'identificatore del segreto di base e i relativi attributi vengono forniti nella risposta. Le singole versioni del segreto non vengono elencate nella risposta. Questa operazione richiede l'autorizzazione segreti/elenco.
GET {vaultBaseUrl}/secrets?api-version=7.4
GET {vaultBaseUrl}/secrets?maxresults={maxresults}&api-version=7.4
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
vault
|
path | True |
string |
Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Versione API client. |
maxresults
|
query |
integer int32 |
Numero massimo di risultati da restituire in una pagina. Se non specificato, il servizio restituirà fino a 25 risultati. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Messaggio di risposta contenente un elenco di segreti nell'insieme di credenziali insieme a un collegamento alla pagina successiva dei segreti. |
|
Other Status Codes |
Key Vault risposta di errore che descrive perché l'operazione non è riuscita. |
Esempio
GetSecrets
Esempio di richiesta
GET https://myvault.vault.azure.net//secrets?maxresults=1&api-version=7.4
Risposta di esempio
{
"value": [
{
"contentType": "plainText",
"id": "https://myvault.vault.azure.net/secrets/listsecrettest0",
"attributes": {
"enabled": true,
"created": 1482189047,
"updated": 1482189047
}
}
],
"nextLink": "https://myvault.vault.azure.net:443/secrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}
Definizioni
Nome | Descrizione |
---|---|
Deletion |
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. |
Key |
Eccezione di errore dell'insieme di credenziali delle chiavi. |
Secret |
Attributi di gestione dei segreti. |
Secret |
Elemento segreto contenente metadati segreti. |
Secret |
Risultato dell'elenco dei segreti. |
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 |
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 |
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 |
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. |
SecretItem
Elemento segreto contenente metadati segreti.
Nome | Tipo | Descrizione |
---|---|---|
attributes |
Attributi di gestione dei segreti. |
|
contentType |
string |
Tipo del valore segreto, ad esempio una password. |
id |
string |
Identificatore segreto. |
managed |
boolean |
True se la durata del segreto viene gestita dall'insieme di credenziali delle chiavi. Se si tratta di un backup di una chiave di un certificato, sarà true. |
tags |
object |
Metadati specifici dell'applicazione sotto forma di coppie chiave-valore. |
SecretListResult
Risultato dell'elenco dei segreti.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
URL per ottenere il set successivo di segreti. |
value |
Messaggio di risposta contenente un elenco di segreti nell'insieme di credenziali delle chiavi insieme a un collegamento alla pagina successiva dei segreti. |