Get Keys - Get Keys

Riferimento

Servizio:: Key Vault

Versione API:: 7.4

Elencare le chiavi nell'insieme di credenziali specificato.
Recupera un elenco delle chiavi nell'insieme di credenziali chiave come strutture di chiavi Web JSON che contengono la parte pubblica di una chiave archiviata. L'operazione LIST è applicabile a tutti i tipi di chiave, ma nella risposta vengono forniti solo l'identificatore di chiave di base, gli attributi e i tag. Le singole versioni di una chiave non vengono elencate nella risposta. Questa operazione richiede l'autorizzazione keys/list.

GET {vaultBaseUrl}/keys?api-version=7.4

Con parametri facoltativi:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
vaultBaseUrl	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	KeyListResult	Messaggio di risposta contenente un elenco di chiavi nell'insieme di credenziali insieme a un collegamento alla pagina successiva di chiavi.
Other Status Codes	KeyVaultError	Key Vault risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

GetKeys

Esempio di richiesta

HTTP

GET https://myvault.vault.azure.net//keys?maxresults=1&api-version=7.4

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Definizioni

Nome	Descrizione
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.
Error	Errore del server dell'insieme di credenziali delle chiavi.
KeyAttributes	Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi.
KeyItem	Elemento chiave contenente i metadati della chiave.
KeyListResult	Risultato dell'elenco di chiavi.
KeyVaultError	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	Error	Errore del server dell'insieme di credenziali delle chiavi.
message	string	Messaggio di errore.

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	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.
updated	integer	Ora dell'ultimo aggiornamento in formato UTC.

KeyItem

Elemento chiave contenente i metadati della chiave.

Nome	Tipo	Descrizione
attributes	KeyAttributes	Attributi di gestione delle chiavi.
kid	string	Identificatore di chiave.
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.
tags	object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

KeyListResult

Risultato dell'elenco di chiavi.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set successivo di chiavi.
value	KeyItem[]	Messaggio di risposta contenente un elenco di chiavi nell'insieme di credenziali delle chiavi insieme a un collegamento alla pagina successiva delle chiavi.

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
error	Error	Errore del server dell'insieme di credenziali delle chiavi.

Condividi tramite