@azure/keyvault-admin package

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

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

KeyVaultSettingsClient 提供了用于创建、更新、获取和列出 Azure Key Vault 设置的异步方法。

Key Vault 的 AccessControlClient 接受的可选参数

布尔类型的 Key Vault 设置。 若要检查给定的 KeyVaultSetting 是否为布尔值，请使用 isBooleanSetting。

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

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

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

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

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

表示可传递给 getSetting 的可选参数的接口

一个接口，表示 Key Vault 管理员轮询程序作的状态。

KeyVaultBackupClient 接受的可选参数

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

表示备份作结果的接口。

表示可传递给 beginBackup 的可选参数的接口

表示可传递给 beginPreBackup 的可选参数的接口

表示可传递给 beginPreRestore 的可选参数的接口

表示可传递给 beginRestore 的可选参数的接口

表示可传递给 beginSelectiveKeyRestore 的可选参数的接口

Key Vault 权限的列表。

表示还原 Key Vault 轮询作状态的公开可用属性的接口。

表示还原作结果的接口。

Key Vault 角色分配。

角色分配属性。

Key Vault 角色定义。

表示还原 Key Vault 轮询作状态的公开可用属性的接口。

一个接口，表示选择性键还原作的结果。

Key Vault 设置。

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

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

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

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

表示可传递给 <xref:KeyVaultSettingsClient.listSettings> 的可选参数的接口

表示 <xref:KeyVaultSettingsClient.listSettings> 返回的响应的接口

可用于轮询长时间运行的操作的简单轮询程序。

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

KeyVaultSettingsClient 接受的可选参数。

表示可传递给 updateSetting 的可选参数的接口

表示备份 Key Vault 轮询作状态的公开可用属性的接口。

支持的数据作权限。
<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：生成随机数。

角色范围。
<xref:KnownRoleScope> 可与 RoleScope 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

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

长时间运行的操作的状态。
<xref:KnownOperationStatus> 可与 OperationStatus 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

InProgress：作正在进行中。
已成功：作成功完成。
已取消：作已取消。
失败：作失败。

支持的 API 版本

支持的数据作权限。

角色范围。

确定给定的 KeyVaultSetting 是否为布尔值 ，即具有布尔值。