Compartir a través de


@azure/keyvault-admin package

Clases

KeyVaultAccessControlClient

KeyVaultAccessControlClient proporciona métodos para administrar el control de acceso y las asignaciones de roles en cualquier instancia de Azure Key Vault determinada. El cliente admite la creación, recuperación y eliminación de roles.

KeyVaultBackupClient

KeyVaultBackupClient proporciona métodos para generar copias de seguridad y restaurar copias de seguridad de cualquier instancia de Azure Key Vault determinada. Este cliente admite la generación de copias de seguridad completas, restauraciones selectivas de claves específicas y restauraciones completas de instancias de Key Vault.

KeyVaultSettingsClient

KeyVaultSettingsClient proporciona métodos asincrónicos para crear, actualizar, obtener y enumerar la configuración de Azure Key Vault.

Interfaces

AccessControlClientOptions

Los parámetros opcionales aceptados por accessControlClient de Key Vault

BooleanKeyVaultSetting

Valor de Key Vault de tipo booleano. Para comprobar si keyVaultSetting determinado es un valor booleano, use isBooleanSetting.

CreateRoleAssignmentOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Interfaz que representa parámetros opcionales pasados a deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Interfaz que representa parámetros opcionales pasados a getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a getSetting

KeyVaultAdminPollOperationState

Interfaz que representa el estado de una operación del sondeo de administrador de Key Vault.

KeyVaultBackupClientOptions

Los parámetros opcionales aceptados por KeyVaultBackupClient

KeyVaultBackupPollerOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Interfaz que representa el resultado de una operación de copia de seguridad.

KeyVaultBeginBackupOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBeginRestoreOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginRestore(string, string, KeyVaultBeginRestoreOptions)

KeyVaultBeginSelectiveKeyRestoreOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

KeyVaultPermission

Lista de permisos de Key Vault.

KeyVaultRestoreOperationState

Interfaz que representa las propiedades disponibles públicamente del estado de una operación de sondeo de Key Vault de restauración.

KeyVaultRestoreResult

Interfaz que representa el resultado de una operación de restauración.

KeyVaultRoleAssignment

Asignación de roles de Key Vault.

KeyVaultRoleAssignmentProperties

Propiedades de asignación de roles.

KeyVaultRoleDefinition

Definición de roles de Key Vault.

KeyVaultSelectiveKeyRestoreOperationState

Interfaz que representa las propiedades disponibles públicamente del estado de una operación de sondeo de Key Vault de restauración.

KeyVaultSelectiveKeyRestoreResult

Interfaz que representa el resultado de una operación de restauración selectiva de claves.

KeyVaultSetting

Una configuración de Key Vault.

ListRoleAssignmentsOptions

Interfaz que representa parámetros opcionales pasados a listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argumentos para recuperar la página siguiente de los resultados de búsqueda.

ListRoleDefinitionsOptions

Interfaz que representa parámetros opcionales pasados a listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argumentos para recuperar la página siguiente de los resultados de búsqueda.

ListSettingsOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Interfaz que representa la respuesta devuelta por <xref:KeyVaultSettingsClient.listSettings>

SetRoleDefinitionOptions

Interfaz que representa parámetros opcionales pasados a setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

Los parámetros opcionales aceptados por KeyVaultSettingsClient.

UpdateSettingOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a updateSetting

Alias de tipos

KeyVaultBackupOperationState

Interfaz que representa las propiedades disponibles públicamente del estado de una operación de sondeo de Key Vault de copia de seguridad.

KeyVaultDataAction

Define valores para DataAction.
<xref:KnownDataAction> se puede usar indistintamente con DataAction, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Microsoft.KeyVault/managedHsm/keys/read/action: leer metadatos de clave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: actualizar una clave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: lectura de la clave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: recuperar la clave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/backup/action: Copias de seguridad de claves HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action: Restaurar claves HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Eliminar asignación de roles.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Obtener asignación de roles.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Crear o actualizar la asignación de roles.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: obtener la definición del rol.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: crear o actualizar la definición de roles.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Eliminar definición de roles.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: cifrar mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: descifrar mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Encapsular mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Desencapsular mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: firmar con una clave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: comprobar el uso de una clave HSM.
Microsoft.KeyVault/managedHsm/keys/create: cree una clave HSM.
Microsoft.KeyVault/managedHsm/keys/delete: Eliminar una clave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: exportar una clave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: liberar una clave HSM mediante la versión de clave segura.
Microsoft.KeyVault/managedHsm/keys/import/action: Importar una clave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: purgar una clave HSM eliminada.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: descargue un dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: comprobación del estado de descarga del dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: carga de un dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: compruebe el estado del archivo de intercambio de dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: descargue una clave de transferencia de dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: iniciar una copia de seguridad de HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: iniciar una restauración de HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: leer un estado de copia de seguridad de HSM.
Microsoft.KeyVault/managedHsm/restore/status/action: leer un estado de restauración de HSM.
Microsoft.KeyVault/managedHsm/rng/action: generar números aleatorios.

KeyVaultRoleScope

Define valores para RoleScope.
<xref:KnownRoleScope> se puede usar indistintamente con RoleScope, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

/: ámbito global
/keys: ámbito de claves

SUPPORTED_API_VERSIONS

Versiones de API admitidas

Enumeraciones

KnownKeyVaultDataAction

Valores conocidos de KeyVaultDataAction que acepta el servicio.

KnownKeyVaultRoleScope

Valores conocidos de KeyVaultRoleScope que acepta el servicio.

Funciones

isBooleanSetting(KeyVaultSetting)

Determina si una keyVaultSetting determinada es un booleanKeyVaultSetting, es decir, tiene un valor booleano.

Detalles de la función

isBooleanSetting(KeyVaultSetting)

Determina si una keyVaultSetting determinada es un booleanKeyVaultSetting, es decir, tiene un valor booleano.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parámetros

setting
KeyVaultSetting

Devoluciones

setting