Informazioni di riferimento sull'API REST di Azure Key Vault

  • Articolo

Usare Key Vault per proteggere e gestire chiavi crittografiche, certificati e segreti usati dalle applicazioni e dai servizi cloud.

Operazioni dell'insieme di credenziali delle chiavi

Operazione Descrizione
Controlla la disponibilità del nome Verifica che il nome dell'insieme di credenziali sia valido e non sia già in uso.
Crea o aggiorna Creare o aggiornare un insieme di credenziali delle chiavi nella sottoscrizione specificata.
Aggiornare i criteri di accesso Aggiornare i criteri di accesso in un insieme di credenziali delle chiavi nella sottoscrizione specificata.
Recupero Ottiene l'insieme di credenziali delle chiavi di Azure specificato.
Elenco L'operazione List ottiene informazioni sugli insiemi di credenziali associati alla sottoscrizione.
List By Resource Group L'operazione List ottiene informazioni sugli insiemi di credenziali associati alla sottoscrizione e all'interno del gruppo di risorse specificato.
Elenco per sottoscrizione L'operazione List ottiene informazioni sugli insiemi di credenziali associati alla sottoscrizione.
Aggiornamento Aggiornare un insieme di credenziali delle chiavi nella sottoscrizione specificata.
Elimina Elimina l'insieme di credenziali delle chiavi di Azure specificato.
Get Deleted Ottiene l'insieme di credenziali delle chiavi di Azure eliminato.
Elenco eliminato Ottiene informazioni sugli insiemi di credenziali eliminati in una sottoscrizione.
Ripulisci Elimina definitivamente l'insieme di credenziali specificato.
Operazione Descrizione
Elenco per insieme di credenziali Ottiene le risorse di collegamento privato supportate per l'insieme di credenziali delle chiavi.

Operazioni di connessioni endpoint private

Operazione Descrizione
Recupero Ottiene la connessione dell'endpoint privato specificata associata all'insieme di credenziali delle chiavi.
Elenco per risorsa L'operazione List ottiene informazioni sulle connessioni endpoint private associate all'insieme di credenziali.
Mettere Aggiornamenti la connessione dell'endpoint privato specificata associata all'insieme di credenziali delle chiavi.
Elimina Elimina la connessione dell'endpoint privato specificata associata all'insieme di credenziali delle chiavi.

Operazioni di HSM gestite

Operazione Descrizione
Crea o aggiorna Creare o aggiornare un pool HSM gestito nella sottoscrizione specificata.
Recupero Ottiene il pool HSM gestito specificato.
List By Resource Group L'operazione List ottiene informazioni sui pool di HSM gestiti associati alla sottoscrizione e all'interno del gruppo di risorse specificato.
Elenco per sottoscrizione L'operazione List ottiene informazioni sui pool HSM gestiti associati alla sottoscrizione.
Aggiornamento Aggiornare un pool HSM gestito nella sottoscrizione specificata.
Get Deleted Ottiene il modulo di protezione hardware gestito eliminato specificato.
Elenco eliminato L'operazione List ottiene informazioni sui moduli di protezione hardware gestiti eliminati associati alla sottoscrizione.
Elimina Elimina il pool di HSM gestito specificato.
Eliminazione eliminata Elimina definitivamente il modulo di protezione hardware gestito specificato.
Operazione Descrizione
Elenco per risorsa MHSM Ottiene le risorse di collegamento privato supportate per il pool HSM gestito.

Operazioni di connessioni endpoint private

Operazione Descrizione
Recupero Ottiene la connessione dell'endpoint privato specificata associata al pool HSM gestito.
Elenco per risorsa L'operazione List ottiene informazioni sulle connessioni endpoint private associate al pool HSM gestito.
Mettere Aggiornamenti la connessione dell'endpoint privato specificata associata al pool HSM gestito.
Elimina Elimina la connessione dell'endpoint privato specificata associata al pool HSM gestito.

Operazioni di dominio di sicurezza HSM

Operazione Descrizione
Scaricare Recupera il dominio di sicurezza dal modulo di protezione hardware gestito. La chiamata di questo endpoint può essere usata per attivare una risorsa HSM gestita con provisioning.
Scaricare in sospeso Recupera lo stato dell'operazione di download del dominio di sicurezza.
Upload Ripristinare il dominio di sicurezza specificato.
Caricamento in sospeso Ottenere lo stato dell'operazione di caricamento del dominio di sicurezza.

Operazioni di impostazioni di HSM gestite

Operazione Descrizione
Impostazione get Ottiene l'oggetto impostazione account specificato. Recupera l'oggetto impostazione di un nome di impostazione specificato.
Ottenere le impostazioni Elencare le impostazioni dell'account. Recupera un elenco di tutte le impostazioni dell'account disponibili che è possibile configurare.
Impostazione di aggiornamento Aggiornamenti'impostazione dell'account dell'insieme di credenziali delle chiavi, la archivia, quindi restituisce il nome e il valore dell'impostazione al client. Descrizione dell'impostazione del pool da aggiornare

Operazioni di controllo degli accessi in base al ruolo

Operazioni di assegnazione di ruolo

Operazione Descrizione
Recupero Ottiene l'assegnazione di ruolo specificata.
Elenco Ottiene le assegnazioni di ruolo per un ambito.
Creare Crea un'assegnazione di ruolo.
Elimina Elimina un'assegnazione di ruolo.

Operazioni di definizione del ruolo

Operazione Descrizione
Recupero Ottiene la definizione di ruolo specificata.
Elenco Ottenere tutte le definizioni di ruolo applicabili nell'ambito e versioni successive.
Crea o aggiorna Crea o aggiorna una definizione di ruolo personalizzata.
Elimina Elimina una definizione di ruolo personalizzata.

Operazioni di backup/ripristino

Operazione Descrizione
Backup completo Crea un backup completo usando un token di firma di accesso condiviso fornito dall'utente in un contenitore di archiviazione BLOB di Azure. Questa operazione è supportata solo dal servizio HSM gestito.
Stato backup Restituisce lo stato dell'operazione di backup completo.
Ripristino completo Ripristina tutti i materiali chiave usando il token di firma di accesso condiviso che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza.
Ripristino selettivo Ripristina tutte le versioni chiave di una determinata chiave usando il token di firma di accesso condiviso fornito dall'utente che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza.
Stato ripristino Restituisce lo stato dell'operazione di ripristino.

Operazioni chiave (Key Vault/modulo di protezione hardware gestito)

Operazione Descrizione
Ottenere la chiave Ottiene la parte pubblica di una chiave archiviata.
Ottenere chiavi Elencare le chiavi nell'insieme di credenziali specificato.
Ottenere le versioni chiave Recupera un elenco di singole versioni chiave con lo stesso nome di chiave.
Crea chiave Crea una nuova chiave, la archivia e quindi restituisce i parametri e gli attributi della chiave al client.
Importa chiave Importa una chiave creata esternamente, la archivia e restituisce i parametri e gli attributi della chiave al client.
Aggiorna chiave L'operazione di aggiornamento della chiave modifica gli attributi specificati di una chiave archiviata e può essere applicata a qualsiasi tipo di chiave e versione della chiave archiviata in Azure Key Vault.
Elimina chiave Elimina una chiave di qualsiasi tipo dall'archiviazione in Azure Key Vault.
Ottenere la chiave eliminata Ottiene la parte pubblica di una chiave eliminata.
Ottenere chiavi eliminate Elenca le chiavi eliminate nell'insieme di credenziali specificato.
Elimina chiave eliminata Elimina definitivamente la chiave specificata.
Recuperare la chiave eliminata Recupera la chiave eliminata alla versione più recente.
Chiave di backup Richiede il download di un backup della chiave specificata nel client.
Chiave di ripristino Ripristina una chiave di cui è stato eseguito il backup in un insieme di credenziali.
Chiave di rilascio Rilascia una chiave. L'operazione della chiave di rilascio è applicabile a tutti i tipi di chiave. La chiave di destinazione deve essere contrassegnata come esportabile. Questa operazione richiede l'autorizzazione chiavi/rilascio.
Ruota chiave Crea una nuova versione della chiave, la archivia, quindi restituisce parametri chiave, attributi e criteri al client. L'operazione ruota la chiave in base ai criteri della chiave. Richiede l'autorizzazione chiavi/rotazione.
Ottenere i criteri di rotazione delle chiavi Elenca i criteri per una chiave. L'operazione GetKeyRotationPolicy restituisce le risorse dei criteri chiave specificate nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione keys/get.
Aggiornare i criteri di rotazione delle chiavi Aggiornamenti i criteri di rotazione per una chiave. Impostare i membri specificati nei criteri della chiave. Lasciare gli altri come non definiti. Questa operazione richiede l'autorizzazione chiavi/aggiornamento.

Operazioni chiave (solo modulo di protezione hardware gestito)

Operazione Descrizione
Ottenere byte casuali Ottenere il numero richiesto di byte contenenti valori casuali da un modulo di protezione hardware gestito.

Operazioni di crittografia (Key Vault/modulo di protezione hardware gestito)

Operazione Descrizione
Decrypt Decrittografa un singolo blocco di dati crittografati.
Encrypt Crittografa una sequenza arbitraria di byte usando una chiave di crittografia archiviata in un insieme di credenziali delle chiavi.
Eseguire il wrapping della chiave Esegue il wrapping di una chiave simmetrica usando una chiave specificata.
Annulla il wrapping della chiave Annulla il wrapping di una chiave simmetrica usando la chiave specificata usata inizialmente per eseguire il wrapping della chiave.
Firma Crea una firma da un digest usando la chiave specificata.
Verificare Verifica una firma usando una chiave specificata.

Operazioni segrete (solo Key Vault)

Operazione Descrizione
Ottenere il segreto Ottenere un segreto specificato da un determinato insieme di credenziali delle chiavi.
Ottenere segreti Elencare i segreti in un insieme di credenziali delle chiavi specificato.
Ottenere versioni segrete Elencare tutte le versioni del segreto specificato.
Imposta segreto Imposta un segreto in un insieme di credenziali delle chiavi specificato.
Aggiornare il segreto Aggiornamenti gli attributi associati a un segreto specificato in un determinato insieme di credenziali delle chiavi.
Elimina segreto Elimina un segreto da un insieme di credenziali delle chiavi specificato.
Ottenere un segreto eliminato Ottiene il segreto eliminato specificato.
Ottenere segreti eliminati Elenca i segreti eliminati per l'insieme di credenziali specificato.
Elimina segreto eliminato Elimina definitivamente il segreto specificato.
Ripristinare il segreto eliminato Recupera il segreto eliminato alla versione più recente.
Segreto di backup Esegue il backup del segreto specificato.
Ripristina segreto Ripristina un segreto di cui è stato eseguito il backup in un insieme di credenziali.

Operazioni di gestione delle chiavi dell'account di archiviazione (solo Key Vault)

Operazioni di configurazione dell'account di archiviazione

Operazione Descrizione
Ottenere l'account di archiviazione Ottiene informazioni su un account di archiviazione specificato. Questa operazione richiede l'autorizzazione di archiviazione/recupero.
Ottenere gli account di archiviazione Elencare gli account di archiviazione gestiti dall'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione di archiviazione/elenco.
Aggiornare un account di archiviazione Aggiornamenti gli attributi specificati associati all'account di archiviazione specificato. Questa operazione richiede l'autorizzazione di archiviazione/set/aggiornamento.
Impostare l'account di archiviazione Crea o aggiorna un nuovo account di archiviazione. Questa operazione richiede l'autorizzazione di archiviazione/set.
Eliminare l'account di archiviazione Elimina un account di archiviazione. Questa operazione richiede l'autorizzazione di archiviazione/eliminazione.
Ottenere un account di archiviazione eliminato Ottiene l'account di archiviazione eliminato specificato.
Ottenere gli account di archiviazione eliminati Elenca gli account di archiviazione eliminati per l'insieme di credenziali specificato.
Eliminazione dell'account di archiviazione eliminato Elimina definitivamente l'account di archiviazione specificato.
Recuperare un account di archiviazione eliminato Recupera l'account di archiviazione eliminato.
Account di archiviazione di backup Esegue il backup dell'account di archiviazione specificato.
Ripristino dell'account di archiviazione Ripristina un account di archiviazione di cui è stato eseguito il backup in un insieme di credenziali.

Operazioni relative alle chiavi dell'account di archiviazione

Operazione Descrizione
Rigenerare la chiave di un account di archiviazione Rigenera il valore di chiave specificato per l'account di archiviazione specificato. Questa operazione richiede l'autorizzazione storage/regeneratekey.

Operazioni di firma di accesso condiviso dell'account di archiviazione

Operazione Descrizione
Ottenere la definizione di firma di accesso condiviso Ottiene informazioni su una definizione di firma di accesso condiviso per l'account di archiviazione specificato. Questa operazione richiede l'autorizzazione storage/getsas.
Ottenere definizioni di firma di accesso condiviso Elencare le definizioni di firma di accesso condiviso di archiviazione per l'account di archiviazione specificato. Questa operazione richiede l'autorizzazione storage/listsas.
Impostare la definizione di firma di accesso condiviso Crea o aggiorna una nuova definizione di firma di accesso condiviso per l'account di archiviazione specificato. Questa operazione richiede l'autorizzazione di archiviazione/setsas.
Aggiornare la definizione di firma di accesso condiviso Aggiornamenti gli attributi specificati associati alla definizione di firma di accesso condiviso specificata. Questa operazione richiede l'autorizzazione di archiviazione/setsas.
Eliminare la definizione di firma di accesso condiviso Elimina una definizione di firma di accesso condiviso da un account di archiviazione specificato. Questa operazione richiede l'autorizzazione storage/deletesas.
Ottenere una definizione di firma di accesso condiviso eliminata Ottiene la definizione di firma di accesso condiviso eliminata specificata.
Ottenere definizioni di firma di accesso condiviso eliminate Elenca le definizioni di firma di accesso condiviso eliminate per l'insieme di credenziali e l'account di archiviazione specificati.
Ripristinare la definizione di firma di accesso condiviso eliminata Recupera la definizione di firma di accesso condiviso eliminata.

Operazioni del certificato (solo Key Vault)

Operazione Descrizione
Ottenere il certificato Ottiene informazioni su un certificato.
Ottenere i certificati Elencare i certificati in un insieme di credenziali delle chiavi specificato
Ottenere le versioni dei certificati Elencare le versioni di un certificato.
Creare un certificato Crea un nuovo certificato.
Importa certificato Importa un certificato in un insieme di credenziali delle chiavi specificato.
Unisci certificato Unisce un certificato o una catena di certificati con una coppia di chiavi esistente nel server.
Ottenere l'operazione di certificato Ottiene l'operazione di creazione di un certificato.
Aggiornare l'operazione del certificato Aggiornamenti un'operazione di certificato.
Eliminare l'operazione di certificato Elimina l'operazione di creazione per un certificato specifico.
Aggiornare il certificato Aggiornamenti gli attributi specificati associati al certificato specificato.
Eliminazione del certificato Elimina un certificato da un insieme di credenziali delle chiavi specificato.
Ottenere un certificato eliminato Recupera informazioni sul certificato eliminato specificato.
Ottenere i certificati eliminati Elenca i certificati eliminati nell'insieme di credenziali specificato attualmente disponibile per il ripristino.
Elimina certificato eliminato Elimina definitivamente il certificato eliminato specificato.
Ripristinare il certificato eliminato Ripristina il certificato eliminato nella versione corrente in /certificates.
Certificato di backup Esegue il backup del certificato specificato.
Ripristina certificato Ripristina un certificato di cui è stato eseguito il backup in un insieme di credenziali.

Operazioni sui criteri dei certificati

Operazione Descrizione
Ottenere i criteri dei certificati Elenca i criteri per un certificato.
Aggiornare i criteri dei certificati Aggiornamenti i criteri per un certificato.

Operazioni dei contatti del certificato

Operazione Descrizione
Ottenere i contatti del certificato Elenca i contatti del certificato per un insieme di credenziali delle chiavi specificato.
Impostare i contatti del certificato Imposta i contatti del certificato per l'insieme di credenziali delle chiavi specificato.
Elimina contatti certificato Elimina i contatti del certificato per un insieme di credenziali delle chiavi specificato.

Operazioni dell'autorità di certificazione

Operazione Descrizione
Ottenere l'autorità di certificazione Elenca l'autorità emittente del certificato specificata.
Ottenere le autorità emittenti di certificati Elencare le autorità emittenti di certificati per un insieme di credenziali delle chiavi specificato.
Impostare l'autorità di certificazione Imposta l'autorità di certificazione specificata.
Aggiornare l'autorità di certificazione Aggiornamenti l'autorità emittente del certificato specificata.
Eliminare l'autorità di certificazione Elimina l'autorità di certificazione specificata.

Vedi anche