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

Azure Key Vault REST API 参考

使用密钥保管库来保护和管理云应用程序和服务使用的加密密钥、证书和机密。

Key Vault 操作

操作 说明
检查名称可用性 检查保管库名称是否有效且尚未使用。
创建或更新 在指定的订阅中创建或更新密钥保管库。
更新访问策略 更新指定订阅中密钥保管库中的访问策略。
Get 获取指定的 Azure 密钥保管库。
列表 列表操作获取与订阅关联的保管库的相关信息。
按资源组列表 “列表”操作获取与订阅和指定资源组内关联的保管库的相关信息。
按订阅列出 列表操作获取与订阅关联的保管库的相关信息。
更新 更新指定订阅中的密钥保管库。
删除 删除指定的 Azure 密钥保管库。
获取已删除 获取已删除的 Azure 密钥保管库。
列出已删除 获取有关订阅中已删除的保管库的信息。
清除 永久删除指定的保管库。
操作 说明
按保管库列出 获取密钥保管库支持的专用链接资源。

专用终结点连接操作

操作 说明
Get 获取与密钥保管库关联的指定专用终结点连接。
按资源列出 列表操作获取与保管库关联的专用终结点连接的相关信息。
汇报与密钥保管库关联的指定专用终结点连接。
删除 删除与密钥保管库关联的指定专用终结点连接。

托管 HSM 操作

操作 说明
创建或更新 在指定的订阅中创建或更新托管 HSM 池。
Get 获取指定的托管 HSM 池。
按资源组列表 列表操作获取与订阅和指定资源组中关联的托管 HSM 池的相关信息。
按订阅列出 列表操作获取与订阅关联的托管 HSM 池的相关信息。
更新 更新指定订阅中的托管 HSM 池。
获取已删除 获取指定的已删除托管 HSM。
列出已删除 列表操作获取与订阅关联的已删除托管 HSM 的相关信息。
删除 删除指定的托管 HSM 池。
清除已删除 永久删除指定的托管 HSM。
操作 说明
按 MHSM 资源列出 获取托管 HSM 池支持的专用链接资源。

专用终结点连接操作

操作 说明
Get 获取与托管 HSM 池关联的指定专用终结点连接。
按资源列出 列表操作获取与托管 HSM 池关联的专用终结点连接的相关信息。
汇报与托管 HSM 池关联的指定专用终结点连接。
删除 删除与托管 HSM 池关联的指定专用终结点连接。

HSM 安全域操作

操作 说明
下载 从托管 HSM 检索安全域。 调用此终结点可用于激活预配的托管 HSM 资源。
下载挂起 检索安全域下载操作状态。
上传 还原提供的安全域。
上传挂起 获取安全域上传操作状态。

基于角色的访问控制操作

角色分配操作

操作 说明
Get 获取指定的角色分配。
列表 获取范围的角色分配。
创建 创建角色分配。
删除 删除角色分配。

角色定义操作

操作 说明
Get 获取指定的角色定义。
列表 获取适用于范围及更高范围的所有角色定义。
创建或更新 创建或更新自定义角色定义。
删除 删除自定义角色定义。

备份/还原操作

操作 说明
完整备份 使用用户提供的 SAS 令牌创建完整备份到 Azure Blob 存储容器。 此操作仅受托管 HSM 服务支持。
备份状态 返回完整备份操作的状态。
完全还原 使用指向以前存储的 Azure Blob 存储备份文件夹的 SAS 令牌还原所有密钥材料。
选择性还原 使用用户提供的 SAS 令牌还原给定密钥的所有密钥版本,该令牌指向以前存储的 Azure Blob 存储备份文件夹。
还原状态 返回还原操作的状态。

HSM 安全域

操作 说明
完整备份 使用用户提供的 SAS 令牌创建完整备份到 Azure Blob 存储容器。 此操作仅受托管 HSM 服务支持。
备份状态 返回完整备份操作的状态。
完全还原 使用指向以前存储的 Azure Blob 存储备份文件夹的 SAS 令牌还原所有密钥材料。
选择性还原 使用用户提供的 SAS 令牌还原给定密钥的所有密钥版本,该令牌指向以前存储的 Azure Blob 存储备份文件夹。
还原状态 返回还原操作的状态。

关键操作 (密钥保管库/托管 HSM)

操作 说明
获取密钥 获取存储密钥的公共部分。
获取密钥 列出指定保管库中的密钥。
获取密钥版本 检索具有相同密钥名称的单个密钥版本的列表。
创建键 创建一个新密钥,存储该密钥,然后向客户端返回密钥参数和属性。
导入密钥 导入外部创建的密钥,存储它,然后将密钥参数和属性返回给客户端。
更新密钥 更新密钥操作会更改存储密钥的指定属性,并可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。
删除密钥 从 Azure 密钥保管库的存储中删除任何类型的密钥。
获取已删除的密钥 获取已删除密钥的公共部分。
获取已删除的密钥 列出指定保管库中已删除的密钥。
清除已删除的密钥 永久删除指定的键。
恢复已删除的密钥 将已删除的密钥恢复到其最新版本。
备份密钥 请求将指定密钥的备份下载到客户端。
还原密钥 将备份的密钥还原到保管库。
发布密钥 释放密钥。 发布密钥操作适用于所有密钥类型。 目标密钥必须标记为可导出。 此操作需要密钥/发布权限。

仅) 密钥操作 (密钥保管库

操作 说明
轮换密钥 创建新的密钥版本,存储密钥,然后将密钥参数、属性和策略返回到客户端。 此操作将基于密钥策略轮换密钥。 它需要密钥/轮换权限。
获取密钥轮换策略 列出密钥的策略。 GetKeyRotationPolicy 操作返回指定密钥保管库中的指定密钥策略资源。 此操作需要密钥/获取权限。
更新密钥轮换策略 汇报密钥的轮换策略。 在密钥策略中设置指定的成员。 将其他人保留为未定义。 此操作需要密钥/更新权限。

仅) (托管 HSM 的关键操作

操作 说明
获取随机字节 获取请求的字节数,其中包含托管 HSM 中的随机值。
轮换密钥 (预览版) 创建一个新的密钥版本,将其存储,然后将密钥参数、属性和策略返回到客户端。 此操作将基于密钥策略轮换密钥。 它需要密钥/轮换权限。
获取密钥轮换策略 (预览版) 列出密钥的策略。GetKeyRotationPolicy 操作返回指定密钥保管库中的指定密钥策略资源。 此操作需要密钥/获取权限。 预览版) 中 (托管 HSM
更新密钥轮换策略 (预览版) 汇报密钥的轮换策略。 在密钥策略中设置指定的成员。 将其他人保留为未定义。 此操作需要密钥/更新权限。

加密操作 (密钥保管库/托管 HSM)

操作 说明
解密 解密单个加密数据块。
Encrypt 使用存储在 Key Vault 中的加密密钥加密任意字节序列。
包装键 使用指定的密钥包装对称密钥。
解包密钥 使用最初用于包装该密钥的指定密钥取消包装对称密钥。
签名 使用指定的密钥从摘要创建签名。
验证 使用指定的密钥验证签名。

仅) 机密操作 (密钥保管库

操作 说明
获取机密 从给定密钥保管库获取指定的机密。
获取机密 列出指定密钥保管库中的机密。
获取机密版本 列出指定机密的所有版本。
设置机密 在指定的密钥保管库中设置机密。
更新机密 汇报与给定密钥保管库中指定机密关联的属性。
删除机密 从指定的密钥保管库中删除机密。
获取已删除的机密 获取指定的已删除机密。
获取已删除的机密 列出指定保管库的已删除机密。
清除已删除的机密 永久删除指定的机密。
恢复已删除的机密 将已删除的机密恢复到最新版本。
备份机密 备份指定的机密。
还原机密 将备份的机密还原到保管库。

仅) 存储帐户密钥管理操作 (密钥保管库

存储帐户配置操作

操作 说明
获取存储帐户 获取有关指定存储帐户的信息。 此操作需要存储/获取权限。
获取存储帐户 列出由指定密钥保管库管理的存储帐户。 此操作需要存储/列表权限。
更新存储帐户 汇报与给定存储帐户关联的指定属性。 此操作需要存储/设置/更新权限。
设置存储帐户 创建或更新新的存储帐户。 此操作需要存储/设置权限。
删除存储帐户 删除存储帐户。 此操作需要存储/删除权限。
获取已删除的存储帐户 获取指定的已删除存储帐户。
获取已删除的存储帐户 列出指定保管库的已删除存储帐户。
清除已删除的存储帐户 永久删除指定的存储帐户。
恢复删除的存储帐户 恢复已删除的存储帐户。
备份存储帐户 备份指定的存储帐户。
还原存储帐户 将备份的存储帐户还原到保管库。

存储帐户密钥操作

操作 说明
重新生成存储帐户密钥 重新生成给定存储帐户的指定密钥值。 此操作需要存储/重新生成密钥权限。

存储帐户 SAS 操作

操作 说明
获取 Sas 定义 获取有关指定存储帐户的 SAS 定义的信息。 此操作需要存储/获取权限。
获取 Sas 定义 列出给定存储帐户的存储 SAS 定义。 此操作需要存储/listsas 权限。
设置 Sas 定义 为指定的存储帐户创建或更新新的 SAS 定义。 此操作需要 storage/setsas 权限。
更新 Sas 定义 汇报与给定 SAS 定义关联的指定属性。 此操作需要 storage/setsas 权限。
删除 Sas 定义 从指定的存储帐户中删除 SAS 定义。 此操作需要存储/删除权限。
获取已删除的 Sas 定义 获取指定的已删除 sas 定义。
获取已删除的 Sas 定义 列出指定的保管库和存储帐户的已删除 SAS 定义。
恢复已删除的 Sas 定义 恢复已删除的 SAS 定义。

仅) 证书操作 (密钥保管库

操作 说明
获取证书 获取有关证书的信息。
获取证书 列出指定密钥保管库中的证书
获取证书版本 列出证书的版本。
创建证书 创建新证书。
导入证书 将证书导入指定的密钥保管库。
合并证书 将证书或证书链与服务器上的现有密钥对合并。
获取证书操作 获取证书的创建操作。
更新证书操作 汇报证书操作。
删除证书操作 删除特定证书的创建操作。
更新证书 更新与给定证书关联的指定属性。
删除证书 从指定的密钥保管库中删除证书。
获取已删除的证书 检索有关指定已删除证书的信息。
获取已删除的证书 列出当前可用于恢复的指定保管库中的已删除证书。
清除已删除的证书 永久删除指定的已删除证书。
恢复已删除的证书 将已删除的证书恢复到 /certificates 下的当前版本。
备份证书 备份指定的证书。
还原证书 将备份的证书还原到保管库。

证书策略操作

操作 说明
获取证书策略 列出证书的策略。
更新证书策略 汇报证书的策略。

证书联系人操作

操作 说明
获取证书联系人 列出指定密钥保管库的证书联系人。
设置证书联系人 设置指定密钥保管库的证书联系人。
删除证书联系人 删除指定密钥保管库的证书联系人。

证书颁发者操作

操作 说明
获取证书颁发者 列出指定的证书颁发者。
获取证书颁发者 列出指定密钥保管库的证书颁发者。
设置证书颁发者 设置指定的证书颁发者。
更新证书颁发者 汇报指定的证书颁发者。
删除证书颁发者 删除指定的证书颁发者。

另请参阅