你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/keyvault-admin package

KeyVaultAccessControlClient

KeyVaultAccessControlClient 提供用于管理任何给定 Azure 密钥保管库 实例中的访问控制和角色分配的方法。 客户端支持创建、检索和删除角色。

KeyVaultBackupClient

KeyVaultBackupClient 提供用于生成任何给定 Azure 密钥保管库 实例的备份和还原备份的方法。 此客户端支持生成完整备份、特定密钥的选择性还原和密钥保管库实例的完整还原。

接口

AccessControlClientOptions

密钥保管库的 AccessControlClient 接受的可选参数

CreateRoleAssignmentOptions

表示可传递给的可选参数的接口 createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

表示可传递给的可选参数的接口 deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

表示传递给 的可选参数的 deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)接口。

GetRoleAssignmentOptions

表示可传递给的可选参数的接口 getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

表示传递给 的可选参数的 getRoleDefinition(string, string, GetRoleDefinitionOptions)接口。

KeyVaultAdminPollOperationState

表示密钥保管库 管理员轮询器操作状态的接口。

KeyVaultBackupClientOptions

KeyVaultBackupClient 接受的可选参数

KeyVaultBackupPollerOptions

表示可传递给的可选参数的接口 beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

表示备份操作结果的接口。

KeyVaultBeginBackupOptions

表示可传递给的可选参数的接口 beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBeginRestoreOptions

表示可传递给的可选参数的接口 beginRestore(string, string, KeyVaultBeginRestoreOptions)

KeyVaultBeginSelectiveKeyRestoreOptions

表示可传递给的可选参数的接口 beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

KeyVaultPermission

密钥保管库权限的列表。

KeyVaultRestoreOperationState

一个接口,表示还原密钥保管库轮询操作的状态的公开可用属性。

KeyVaultRestoreResult

表示还原操作结果的接口。

KeyVaultRoleAssignment

密钥保管库角色分配。

KeyVaultRoleAssignmentProperties

角色分配属性。

KeyVaultRoleDefinition

密钥保管库角色定义。

KeyVaultSelectiveKeyRestoreOperationState

一个接口,表示还原密钥保管库轮询操作的状态的公开可用属性。

KeyVaultSelectiveKeyRestoreResult

表示选择性密钥还原操作结果的接口。

ListRoleAssignmentsOptions

表示传递给 的可选参数的 listRoleAssignments(string, ListRoleAssignmentsOptions)接口。

ListRoleAssignmentsPageSettings

用于检索下一页搜索结果的参数。

ListRoleDefinitionsOptions

表示传递给 的可选参数的 listRoleDefinitions(string, ListRoleDefinitionsOptions)接口。

ListRoleDefinitionsPageSettings

用于检索下一页搜索结果的参数。

SetRoleDefinitionOptions

表示传递给 的可选参数的 setRoleDefinition(string, SetRoleDefinitionOptions)接口。

类型别名

KeyVaultBackupOperationState

一个接口,表示备份密钥保管库轮询操作的状态的公开可用属性。

KeyVaultDataAction

定义 DataAction 的值。
<xref:KnownDataAction> 可与 DataAction 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Microsoft.KeyVault/managedHsm/keys/read/action:读取 HSM 密钥元数据。
Microsoft.KeyVault/managedHsm/keys/write/action:更新 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action:读取已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action:恢复已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/backup/action:备份 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/restore/action:还原 HSM 密钥。
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action:删除角色分配。
Microsoft.KeyVault/managedHsm/roleAssignments/read/action:获取角色分配。
Microsoft.KeyVault/managedHsm/roleAssignments/write/action:创建或更新角色分配。
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action:获取角色定义。
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action:创建或更新角色定义。
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action:删除角色定义。
Microsoft.KeyVault/managedHsm/keys/encrypt/action:使用 HSM 密钥加密。
Microsoft.KeyVault/managedHsm/keys/decrypt/action:使用 HSM 密钥解密。
Microsoft.KeyVault/managedHsm/keys/wrap/action:使用 HSM 密钥包装。
Microsoft.KeyVault/managedHsm/keys/unwrap/action:使用 HSM 密钥取消包装。
Microsoft.KeyVault/managedHsm/keys/sign/action:使用 HSM 密钥进行签名。
Microsoft.KeyVault/managedHsm/keys/verify/action:使用 HSM 密钥进行验证。
Microsoft.KeyVault/managedHsm/keys/create:创建 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/delete:删除 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/export/action:导出 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/release/action:使用安全密钥发布发布 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/import/action:导入 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete:清除已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/securitydomain/download/action:下载 HSM 安全域。
Microsoft.KeyVault/managedHsm/securitydomain/download/read:检查 HSM 安全域下载状态。
Microsoft.KeyVault/managedHsm/securitydomain/upload/action:上传 HSM 安全域。
Microsoft.KeyVault/managedHsm/securitydomain/upload/read:检查 HSM 安全域交换文件的状态。
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read:下载 HSM 安全域传输密钥。
Microsoft.KeyVault/managedHsm/backup/start/action:启动 HSM 备份。
Microsoft.KeyVault/managedHsm/restore/start/action:启动 HSM 还原。
Microsoft.KeyVault/managedHsm/backup/status/action:读取 HSM 备份状态。
Microsoft.KeyVault/managedHsm/restore/status/action:读取 HSM 还原状态。
Microsoft.KeyVault/managedHsm/rng/action:生成随机数。

KeyVaultRoleScope

定义 RoleScope 的值。
<xref:KnownRoleScope> 可以与 RoleScope 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

/:全局范围
/keys:密钥范围

SUPPORTED_API_VERSIONS

支持的 API 版本

枚举

KnownKeyVaultDataAction

服务接受的 KeyVaultDataAction 已知值。

KnownKeyVaultRoleScope

服务接受的 KeyVaultRoleScope 已知值。