你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Azure 密钥保管库 REST API 参考
使用 密钥保管库 来保护和管理云应用程序和服务使用的加密密钥、证书和机密。
Key Vault 操作
| 操作 |
说明 |
| 检查名称可用性 |
检查保管库名称是否有效且尚未使用。 |
| 创建或更新 |
在指定订阅中创建或更新密钥保管库。 |
| 更新访问策略 |
更新指定订阅中密钥保管库中的访问策略。 |
| Get |
获取指定的 Azure 密钥保管库。 |
| 列表 |
List 操作获取与订阅关联的保管库的相关信息。 |
| 按资源组列表 |
“列出”操作获取与订阅关联的保管库以及指定资源组中有关的信息。 |
| 按订阅列出 |
List 操作获取与订阅关联的保管库的相关信息。 |
| 更新 |
更新指定订阅中的密钥保管库。 |
| 删除 |
删除指定的 Azure 密钥保管库。 |
| Get Deleted |
获取已删除的 Azure 密钥保管库。 |
| List Deleted |
获取有关订阅中已删除的保管库的信息。 |
| 清除 |
永久删除指定的保管库。 |
专用链接操作
| 操作 |
说明 |
| 按保管库列出 |
获取密钥保管库支持的专用链接资源。 |
专用终结点连接操作
| 操作 |
说明 |
| Get |
获取与密钥保管库关联的指定专用终结点连接。 |
| 按资源列出 |
“列出”操作获取与保管库关联的专用终结点连接的相关信息。 |
| 把 |
汇报与密钥保管库关联的指定专用终结点连接。 |
| 删除 |
删除与密钥保管库关联的指定专用终结点连接。 |
托管 HSM 操作
| 操作 |
说明 |
| 创建或更新 |
在指定的订阅中创建或更新托管 HSM 池。 |
| Get |
获取指定的托管 HSM 池。 |
| 按资源组列表 |
List 操作获取与订阅关联的托管 HSM 池以及指定资源组中的信息。 |
| 按订阅列出 |
“列出”操作获取与订阅关联的托管 HSM 池的相关信息。 |
| 更新 |
更新指定订阅中的托管 HSM 池。 |
| Get Deleted |
获取指定的已删除托管 HSM。 |
| List Deleted |
List 操作获取与订阅关联的已删除托管 HSM 的相关信息。 |
| 删除 |
删除指定的托管 HSM 池。 |
| 清除已删除 |
永久删除指定的托管 HSM。 |
专用链接操作
专用终结点连接操作
| 操作 |
说明 |
| Get |
获取与托管 HSM 池关联的指定专用终结点连接。 |
| 按资源列出 |
List 操作获取与托管 HSM 池关联的专用终结点连接的相关信息。 |
| 把 |
汇报与托管 HSM 池关联的指定专用终结点连接。 |
| 删除 |
删除与托管 HSM 池关联的指定专用终结点连接。 |
HSM 安全域操作
| 操作 |
说明 |
| 下载 |
从托管 HSM 检索安全域。 调用此终结点可用于激活预配的托管 HSM 资源。 |
| 下载挂起 |
检索安全域下载操作状态。 |
| 上传 |
还原提供的安全域。 |
| 上传挂起 |
获取安全域上传操作状态。 |
托管 HSM 设置操作
| 操作 |
说明 |
| 获取设置 |
获取指定的帐户设置对象。 检索指定设置名称的设置对象。 |
| 获取设置 |
列出帐户设置。 检索可配置的所有可用帐户设置的列表。 |
| 更新设置 |
汇报密钥保管库帐户设置，将其存储，然后将设置名称和值返回给客户端。 要更新的池设置的说明 |
基于角色的访问控制操作
角色分配操作
| 操作 |
说明 |
| Get |
获取指定的角色分配。 |
| 列表 |
获取范围的角色分配。 |
| 创建 |
创建角色分配。 |
| 删除 |
删除角色分配。 |
角色定义操作
| 操作 |
说明 |
| Get |
获取指定的角色定义。 |
| 列表 |
获取范围及更高范围适用的所有角色定义。 |
| 创建或更新 |
创建或更新自定义角色定义。 |
| 删除 |
删除自定义角色定义。 |
备份/还原操作
| 操作 |
说明 |
| 完整备份 |
使用用户提供的 SAS 令牌创建到 Azure Blob 存储容器的完整备份。 只有托管 HSM 服务支持此操作。 |
| 备份状态 |
返回完整备份操作的状态。 |
| 完全还原 |
使用 SAS 令牌还原所有密钥材料，该令牌指向以前存储的 Azure Blob 存储备份文件夹。 |
| 选择性还原 |
使用用户提供的 SAS 令牌还原给定密钥的所有密钥版本，该令牌指向以前存储的 Azure Blob 存储备份文件夹。 |
| 还原状态 |
返回还原操作的状态。 |
(密钥保管库/托管 HSM) 的关键操作
| 操作 |
说明 |
| 获取密钥 |
获取存储密钥的公共部分。 |
| 获取密钥 |
列出指定保管库中的密钥。 |
| 获取密钥版本 |
检索具有相同密钥名称的单个密钥版本的列表。 |
| 创建键 |
创建一个新密钥，存储该密钥，然后向客户端返回密钥参数和属性。 |
| 导入密钥 |
导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。 |
| 更新密钥 |
更新密钥操作会更改存储密钥的指定属性，并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。 |
| 删除密钥 |
从 Azure 密钥保管库 中的存储中删除任何类型的密钥。 |
| 获取已删除的密钥 |
获取已删除密钥的公共部分。 |
| 获取已删除的密钥 |
列出指定保管库中已删除的密钥。 |
| 清除已删除的密钥 |
永久删除指定的密钥。 |
| 恢复已删除的密钥 |
将已删除的密钥恢复到其最新版本。 |
| 备份密钥 |
请求将指定密钥的备份下载到客户端。 |
| 还原密钥 |
将备份的密钥还原到保管库。 |
| 发布密钥 |
释放密钥。 释放密钥操作适用于所有密钥类型。 目标密钥必须标记为可导出。 此操作需要密钥/释放权限。 |
| 轮换密钥 |
创建新的密钥版本并存储它，然后将密钥参数、属性和策略返回给客户端。 该操作将根据密钥策略轮换密钥。 它需要密钥/轮换权限。 |
| 获取密钥轮换策略 |
列出密钥的策略。 GetKeyRotationPolicy 操作返回指定密钥保管库中的指定密钥策略资源。 此操作需要密钥/get 权限。 |
| 更新密钥轮换策略 |
汇报密钥的轮换策略。 在密钥策略中设置指定成员。 将其他人保留为未定义。 此操作需要密钥/更新权限。 |
仅) 托管 HSM (关键操作
| 操作 |
说明 |
| 获取随机字节数 |
从托管 HSM 获取包含随机值的所请求字节数。 |
(密钥保管库/托管 HSM) 的加密操作
| 操作 |
说明 |
| 解密 |
解密单个加密数据块。 |
| Encrypt |
使用存储在密钥保管库中的加密密钥加密任意字节序列。 |
| 包装键 |
使用指定的密钥包装对称密钥。 |
| 解压缩密钥 |
使用最初用于包装该密钥的指定密钥解包对称密钥。 |
| 签名 |
使用指定的键从摘要创建签名。 |
| 验证 |
使用指定的密钥验证签名。 |
仅) (密钥保管库机密操作
存储帐户密钥管理操作仅 (密钥保管库)
存储帐户配置操作
存储帐户密钥操作
| 操作 |
说明 |
| 重新生成存储帐户密钥 |
为给定存储帐户重新生成指定的密钥值。 此操作需要存储/重新生成密钥权限。 |
存储帐户 SAS 操作
证书操作仅 (密钥保管库)
证书策略操作
证书颁发者操作
另请参阅