通过

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

Recover Deleted Certificate - Recover Deleted Certificate

服务:
Key Vault
API 版本:
2025-07-01

将已删除的证书恢复到 /certificates 下的当前版本。
RecoverDeletedCertificate作执行 Delete作的撤消。 此作适用于启用了软删除的保管库，并且必须在保留间隔内颁发（在已删除证书的属性中可用）。 此作需要证书/恢复权限。

POST {vaultBaseUrl}/deletedcertificates/{certificate-name}/recover?api-version=2025-07-01

URI 参数

名称 在 必需 类型 说明
certificate-name
 path True

string

已删除证书的名称
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

CertificateBundle

请求已成功。
Other Status Codes

KeyVaultError

意外的错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://vault.azure.net/.default

示例

RecoverDeletedCertificate

示例请求

POST https://myvault.vault.azure.net//deletedcertificates/CertCreateDeleteRecoverPurgeTest/recover?api-version=2025-07-01

示例响应

状态代码:
200 
{
  "id": "https://myvault.vault.azure.net/certificates/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d",
  "kid": "https://myvault.vault.azure.net/keys/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d",
  "sid": "https://myvault.vault.azure.net/secrets/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938486,
    "updated": 1493938486,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/CertCreateDeleteRecoverPurgeTest/policy",
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=KeyVaultTest",
      "ekus": [],
      "key_usage": [],
      "validity_months": 297
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938486,
      "updated": 1493938486
    }
  }
}

定义

名称 说明
Action

将要执行的作。
CertificateAttributes

证书管理属性。
CertificateBundle

证书捆绑包由证书 （X509） 及其属性组成。
CertificatePolicy

证书的管理策略。
CertificatePolicyAction

操作的类型。
DeletionRecoveryLevel

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可以永久删除该密钥;否则，只有系统可以在保留间隔结束时清除机密。
Error
IssuerParameters

证书的 X509 组件颁发者的参数。
JsonWebKeyCurveName

椭圆曲线名称。 有关有效值，请参阅 JsonWebKeyCurveName。
JsonWebKeyType

要用于证书的密钥对的类型。
KeyProperties

支持证书的密钥对的属性。
KeyUsageType

支持证书密钥的用法。
KeyVaultError

密钥保管库错误异常。
LifetimeAction

Key Vault 将在证书生存期内执行的作及其触发器。
SecretProperties

支持证书的密钥的属性。
SubjectAlternativeNames

X509 对象的主题备用名称。
Trigger

执行作需要满足的条件。
X509CertificateProperties

证书的 X509 组件的属性。

Action

Object

将要执行的作。

名称 类型 说明
action_type

CertificatePolicyAction

操作的类型。

CertificateAttributes

Object

证书管理属性。

名称 类型 说明
created

integer (unixtime)

创建时间（UTC）。
enabled

boolean

确定是否启用对象。
exp

integer (unixtime)

到期日期（UTC）。
nbf

integer (unixtime)

不早于UTC日期。
recoverableDays

integer (int32)

softDelete 数据保留天数。 启用 softDelete 时，值应为 >=7 和 <=90，否则为 0。
recoveryLevel

DeletionRecoveryLevel

反映当前保管库中证书当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可以永久删除证书;否则，只有系统可以在保留间隔结束时清除证书。
updated

integer (unixtime)

最后更新时间（UTC）。

CertificateBundle

Object

证书捆绑包由证书 （X509） 及其属性组成。

名称 类型 说明
attributes

CertificateAttributes

证书属性。
cer

string (byte)

x509 证书的 CER 内容。
contentType

string

机密的内容类型。 eg. 'application/x-pem-file' 或 'application/x-pkcs12'。
id

string

证书 ID。
kid

string

密钥 ID。
policy

CertificatePolicy

管理方针。
preserveCertOrder

boolean

指定证书链是否保留其原始顺序。 默认值为 false，它将叶证书设置为索引 0。
sid

string

密钥 ID。
tags

object

以键值对的形式提供特定于应用程序的元数据。
x5t

string (base64url)

证书的指纹。

CertificatePolicy

Object

证书的管理策略。

名称 类型 说明
attributes

CertificateAttributes

证书属性。
id

string

证书 ID。
issuer

IssuerParameters

证书的 X509 组件颁发者的参数。
key_props

KeyProperties

支持证书的密钥的属性。
lifetime_actions

LifetimeAction[]

Key Vault 在证书生存期内将执行的作。
secret_props

SecretProperties

支持证书的机密的属性。
x509_props

X509CertificateProperties

证书的 X509 组件的属性。

CertificatePolicyAction

枚举

操作的类型。

值 说明
EmailContacts

将通过电子邮件发送证书联系人的证书策略。
AutoRenew

自动续订证书的证书策略。

DeletionRecoveryLevel

枚举

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可以永久删除该密钥;否则，只有系统可以在保留间隔结束时清除机密。

值 说明
Purgeable

表示保管库状态，在该状态下，删除是不可逆的作，无法恢复。 此级别对应于没有针对删除作的保护;在实体级别或更高级别（保管库、资源组、订阅等）接受删除作时，数据将不可挽回地丢失。
Recoverable+Purgeable

表示删除可恢复的保管库状态，并且还允许立即和永久删除（即清除）。 此级别保证已删除实体在保留间隔（90 天）内的可恢复性，除非请求清除作或取消订阅。 如果未恢复，系统将在 90 天后永久删除它
Recoverable

表示一种保管库状态，在这种状态下，删除是可恢复的，而无法立即和永久删除（即清除）。 此级别可保证在保留间隔（90 天）期间以及订阅仍然可用时已删除实体的可恢复性。 如果未恢复，系统将在 90 天后永久删除它
Recoverable+ProtectedSubscription

表示保管库和订阅状态，在该状态下，删除可在保留间隔（90 天）内恢复，不允许立即和永久删除（即清除），并且订阅本身无法永久取消。 如果未恢复，系统将在 90 天后永久删除它
CustomizedRecoverable+Purgeable

表示可恢复删除的保管库状态，并且还允许立即和永久删除（即，当 7 <= SoftDeleteRetentionInDays < 90 时清除）。 此级别可保证已删除实体在保留时间间隔内的可恢复性，除非请求清除作或取消订阅。
CustomizedRecoverable

表示一种保管库状态，在该状态下，删除是可恢复的，但无法立即和永久删除（即，当 7 <= SoftDeleteRetentionInDays < 90 时清除）。此级别可保证在保留时间间隔内以及订阅仍可用时已删除实体的可恢复性。
CustomizedRecoverable+ProtectedSubscription

表示保管库和订阅状态，在该状态下，删除是可恢复的，不允许立即和永久删除（即清除），并且在 7 <= SoftDeleteRetentionInDays < 90 时无法永久取消订阅本身。 此级别保证了已删除实体在保留间隔内的可恢复性，并且还反映了订阅本身无法取消的事实。

Error

Object
名称 类型 说明
code

string

错误代码。
innererror

Error

密钥保管库服务器错误。
message

string

错误消息。

IssuerParameters

Object

证书的 X509 组件颁发者的参数。

名称 类型 说明
cert_transparency

boolean

指示是否应将在此策略下生成的证书发布到证书透明度日志。
cty

string

提供商支持的证书类型（可选）;例如“OV-SSL”、“EV-SSL”
name

string

引用的颁发者对象或保留名称的名称;例如，“Self”或“Unknown”。

JsonWebKeyCurveName

枚举

椭圆曲线名称。 有关有效值，请参阅 JsonWebKeyCurveName。

值 说明
P-256

NIST P-256 椭圆曲线，又名 SECG 曲线SECP256R1。
P-384

NIST P-384 椭圆曲线，又名 SECG 曲线SECP384R1。
P-521

NIST P-521 椭圆曲线，又名 SECG 曲线SECP521R1。
P-256K

SECG SECP256K1椭圆曲线。

JsonWebKeyType

枚举

要用于证书的密钥对的类型。

值 说明
EC

椭圆曲线。
EC-HSM

椭圆曲线，其私钥不可从 HSM 导出。
RSA

RSA （https://tools.ietf.org/html/rfc3447）。
RSA-HSM

RSA 具有不可从 HSM 导出的私钥。
oct

八位字节序列（用于表示对称键）。
oct-HSM

八位字节序列，其私钥不可从 HSM 导出。

KeyProperties

Object

支持证书的密钥对的属性。

名称 类型 说明
crv

JsonWebKeyCurveName

椭圆曲线名称。 有关有效值，请参阅 JsonWebKeyCurveName。
exportable

boolean

指示是否可以导出私钥。 创建可导出密钥的第一个版本时，必须提供发布策略。
key_size

integer (int32)

键大小（以位为单位）。 例如：RSA 的 2048、3072 或 4096。
kty

JsonWebKeyType

要用于证书的密钥对的类型。
reuse_key

boolean

指示证书续订时是否将使用相同的密钥对。

KeyUsageType

枚举

支持证书密钥的用法。

值 说明
digitalSignature

指示证书密钥可用作数字签名。
nonRepudiation

指示证书密钥可用于身份验证。
keyEncipherment

指示证书密钥可用于密钥加密。
dataEncipherment

表示证书密钥可用于数据加密。
keyAgreement

指示证书密钥可用于确定密钥协议，例如使用 Diffie-Hellman 密钥协议算法创建的密钥。
keyCertSign

指示证书密钥可用于对证书进行签名。
cRLSign

指示证书密钥可用于对证书吊销列表进行签名。
encipherOnly

指示证书密钥只能用于加密。
decipherOnly

指示证书密钥只能用于解密。

KeyVaultError

Object

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。

LifetimeAction

Object

Key Vault 将在证书生存期内执行的作及其触发器。

名称 类型 说明
action

Action

将要执行的作。
trigger

Trigger

将执行作的条件。

SecretProperties

Object

支持证书的密钥的属性。

名称 类型 说明
contentType

string

媒体类型（MIME 类型）。

SubjectAlternativeNames

Object

X509 对象的主题备用名称。

名称 类型 说明
dns_names

string[]

域名。
emails

string[]

电子邮件地址。
ipAddresses

string[]

IP 地址;支持 IPv4 和 IPv6。
upns

string[]

用户主体名称。
uris

string[]

统一资源标识符。

Trigger

Object

执行作需要满足的条件。

名称 类型 说明
days_before_expiry

integer (int32)

到期前几天尝试续订。 值应介于 1 和 validity_in_months 乘以 27 之间。 如果validity_in_months为 36，则值应介于 1 和 972 （36 * 27） 之间。
lifetime_percentage

integer (int32)

minimum: 1
maximum: 99

触发的生存期百分比。 值应介于 1 到 99 之间。

X509CertificateProperties

Object

证书的 X509 组件的属性。

名称 类型 说明
ekus

string[]

增强的密钥用法。
key_usage

KeyUsageType[]

定义如何使用证书的密钥。
sans

SubjectAlternativeNames

主题替代名称。
subject

string

主题名称。 应为有效的 X509 可分辨名称。
validity_months

integer (int32)

minimum: 0

证书的有效期（以月为单位）。