@azure/keyvault-admin package

Classi

KeyVaultAccessControlClient

KeyVaultAccessControlClient fornisce metodi per gestire il controllo di accesso e le assegnazioni di ruolo in qualsiasi istanza di Azure Key Vault specificata. Il client supporta la creazione, il recupero e l'eliminazione di ruoli.

KeyVaultBackupClient

KeyVaultBackupClient fornisce metodi per generare backup e ripristinare i backup di qualsiasi istanza di Azure Key Vault specificata. Questo client supporta la generazione di backup completi, ripristini selettivi di chiavi specifiche e ripristini completi delle istanze di Key Vault.

KeyVaultSettingsClient

KeyVaultSettingsClient fornisce metodi asincroni per creare, aggiornare, ottenere ed elencare le impostazioni per Azure Key Vault.

Interfacce

AccessControlClientOptions

Parametri facoltativi accettati da AccessControlClient di Key Vault

BooleanKeyVaultSetting

Impostazione dell'insieme di credenziali delle chiavi di tipo booleano. Per verificare se un valore KeyVaultSetting specificato è un valore booleano, usare isBooleanSetting.

CreateRoleAssignmentOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Interfaccia che rappresenta i parametri facoltativi passati a deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Interfaccia che rappresenta i parametri facoltativi passati a getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a getSetting

KeyVaultAdminPollOperationState

Interfaccia che rappresenta lo stato dell'operazione dell'amministratore dell'insieme di credenziali delle chiavi.

KeyVaultBackupClientOptions

Parametri facoltativi accettati da KeyVaultBackupClient

KeyVaultBackupPollerOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Interfaccia che rappresenta il risultato di un'operazione di backup.

KeyVaultBeginBackupOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginBackup

KeyVaultBeginPreBackupOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginPreBackup

KeyVaultBeginPreRestoreOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginPreRestore

KeyVaultBeginRestoreOptions

Interfaccia che rappresenta i parametri facoltativi che è possibile passare a beginRestore

KeyVaultBeginSelectiveKeyRestoreOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginSelectiveKeyRestore

KeyVaultPermission

Elenco di autorizzazioni di Key Vault.

KeyVaultRestoreOperationState

Interfaccia che rappresenta le proprietà disponibili pubblicamente dello stato dell'operazione di polling di un insieme di credenziali delle chiavi di ripristino.

KeyVaultRestoreResult

Interfaccia che rappresenta il risultato di un'operazione di ripristino.

KeyVaultRoleAssignment

Assegnazione di ruolo di Key Vault.

KeyVaultRoleAssignmentProperties

Proprietà dell'assegnazione di ruolo.

KeyVaultRoleDefinition

Definizione di ruolo dell'insieme di credenziali delle chiavi.

KeyVaultSelectiveKeyRestoreOperationState

Interfaccia che rappresenta le proprietà disponibili pubblicamente dello stato dell'operazione di polling di un insieme di credenziali delle chiavi di ripristino.

KeyVaultSelectiveKeyRestoreResult

Interfaccia che rappresenta il risultato di un'operazione di ripristino selettivo della chiave.

KeyVaultSetting

Impostazione di Key Vault.

ListRoleAssignmentsOptions

Interfaccia che rappresenta i parametri facoltativi passati a listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argomenti per il recupero della pagina successiva dei risultati della ricerca.

ListRoleDefinitionsOptions

Interfaccia che rappresenta i parametri facoltativi passati a listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argomenti per il recupero della pagina successiva dei risultati della ricerca.

ListSettingsOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Interfaccia che rappresenta la risposta restituita da <xref:KeyVaultSettingsClient.listSettings>

PollerLike

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

SetRoleDefinitionOptions

Interfaccia che rappresenta i parametri facoltativi passati a setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

Parametri facoltativi accettati da KeyVaultSettingsClient.

UpdateSettingOptions

Interfaccia che rappresenta i parametri facoltativi che possono essere passati a updateSetting

Alias tipo

KeyVaultBackupOperationState

Interfaccia che rappresenta le proprietà disponibili pubblicamente dello stato dell'operazione di polling di un insieme di credenziali delle chiavi di backup.

KeyVaultDataAction

Autorizzazioni supportate per le azioni dei dati.
<xref:KnownDataAction> può essere usato in modo intercambiabile con DataAction, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Microsoft.KeyVault/managedHsm/keys/read/action: leggere i metadati della chiave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: aggiornare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Leggere la chiave HSM eliminata.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Ripristinare la chiave HSM eliminata.
Microsoft.KeyVault/managedHsm/keys/backup/action: Backup delle chiavi HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action: Ripristinare le chiavi del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Elimina assegnazione di ruolo.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Ottenere l'assegnazione di ruolo.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Creare o aggiornare l'assegnazione di ruolo.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Ottenere la definizione del ruolo.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Creare o aggiornare la definizione del ruolo.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Elimina definizione del ruolo.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: crittografare usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Decrittografare usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: eseguire il wrapping usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Annullare il wrapping usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: firma con una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: Verificare l'uso di una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/create: Creare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/delete: Eliminare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: esportare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: rilasciare una chiave HSM usando il rilascio della chiave sicura.
Microsoft.KeyVault/managedHsm/keys/import/action: Importare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/deletedKeys/delete: ripulire una chiave HSM eliminata.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Scaricare un dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: controllare lo stato del download del dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Caricare un dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: controllare lo stato del file di scambio del dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: scaricare una chiave di trasferimento del dominio di sicurezza HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: avviare un backup del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/restore/start/action: Avviare un ripristino del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/backup/status/action: leggere uno stato di backup del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/restore/status/action: legge lo stato di ripristino del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/rng/action: Generare numeri casuali.

KeyVaultRoleScope

Ambito del ruolo.
<xref:KnownRoleScope> può essere usato in modo intercambiabile con RoleScope, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

/: ambito globale
/keys: ambito chiavi

OperationStatus

Stato di un'operazione a esecuzione prolungata.
<xref:KnownOperationStatus> può essere usato in modo intercambiabile con OperationStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

InProgress: l'operazione è in corso.
Operazione riuscita: operazione completata correttamente.
annullata: l'operazione è stata annullata.
non riuscito: operazione non riuscita.

SUPPORTED_API_VERSIONS

Versioni dell'API supportate

Enumerazioni

KnownKeyVaultDataAction

Autorizzazioni supportate per le azioni dei dati.

KnownKeyVaultRoleScope

Ambito del ruolo.

Funzioni

isBooleanSetting(KeyVaultSetting)

Determina se un determinato KeyVaultSetting è un valore booleano BooleanKeyVaultSetting, ovvero ha un valore booleano.

Variabili

LATEST_API_VERSION

L'ultima versione supportata dell'API del servizio Key Vault.

SDK_VERSION

Versione attuale dell'SDK di Amministratore della Cripta Chiavi.

Dettagli funzione

isBooleanSetting(KeyVaultSetting)

Determina se un determinato KeyVaultSetting è un valore booleano BooleanKeyVaultSetting, ovvero ha un valore booleano.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parametri

setting
KeyVaultSetting

Valori restituiti

setting

Dettagli delle variabili

LATEST_API_VERSION

L'ultima versione supportata dell'API del servizio Key Vault.

LATEST_API_VERSION: "2025-07-01"

Tipo

"2025-07-01"

SDK_VERSION

Versione attuale dell'SDK di Amministratore della Cripta Chiavi.

SDK_VERSION: string

Tipo

string