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

Update Certificate - Update Certificate

参考

Service:: Key Vault

API Version:: 7.4

更新与给定证书关联的指定属性。
UpdateCertificate 操作对给定证书应用指定的更新;更新的唯一元素是证书的属性。此操作需要证书/更新权限。

PATCH {vaultBaseUrl}/certificates/{certificate-name}/{certificate-version}?api-version=7.4

URI 参数

名称	在	必需	类型	说明
certificate-name	path	True	string	给定密钥保管库中证书的名称。
certificate-version	path	True	string	证书的版本。
vaultBaseUrl	path	True	string	保管库名称，例如 https://myvault.vault.azure.net。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
attributes	CertificateAttributes	证书的属性 (可选) 。
policy	CertificatePolicy	证书的管理策略。
tags	object	键/值对形式的应用程序特定元数据。

响应

名称	类型	说明
200 OK	CertificateBundle	更新的证书。
Other Status Codes	KeyVaultError	密钥保管库描述操作失败原因的错误响应。

示例

UpdateCertificate

Sample Request

HTTP

PATCH https://myvault.vault.azure.net//certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc?api-version=7.4

{
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "kid": "https://myvault.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "sid": "https://myvault.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "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": 1482188981,
    "updated": 1482188981
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

定义

名称	说明
Action	将执行的操作。
CertificateAttributes	证书管理属性。
CertificateBundle	证书捆绑包由一个证书 (X509) 及其属性组成。
CertificatePolicy	证书的管理策略。
CertificatePolicyAction	操作的类型。
CertificateUpdateParameters	证书更新参数。
DeletionRecoveryLevel	反映当前保管库中证书的删除恢复级别。如果证书包含“可清除”，则特权用户可以永久删除证书;否则，只有系统可以在保留间隔结束时清除证书。
Error	密钥保管库服务器错误。
IssuerParameters	证书 X509 组件的颁发者的参数。
JsonWebKeyCurveName	椭圆曲线名称。有关有效值，请参阅 JsonWebKeyCurveName。
JsonWebKeyType	要用于证书的密钥对的类型。
KeyProperties	支持证书的密钥对的属性。
KeyUsageType	定义证书密钥的使用方式。
KeyVaultError	密钥保管库错误异常。
LifetimeAction	将由密钥保管库在证书生存期内执行的操作及其触发器。
SecretProperties	支持证书的密钥的属性。
SubjectAlternativeNames	X509 对象的使用者备用名称。
Trigger	要为要执行的操作满足的条件。
X509CertificateProperties	证书的 X509 组件的属性。

Action

将执行的操作。

名称	类型	说明
action_type	CertificatePolicyAction	操作的类型。

CertificateAttributes

证书管理属性。

名称	类型	说明
created	integer	创建时间（UTC）。
enabled	boolean	确定是否启用对象。
exp	integer	到期日期（UTC）。
nbf	integer	不早于 UTC 日期。
recoverableDays	integer	softDelete 数据保留天数。启用 softDelete 时，值应为 >=7 和 <=90，否则为 0。
recoveryLevel	DeletionRecoveryLevel	反映当前保管库中证书的删除恢复级别。如果证书包含“可清除”，则特权用户可以永久删除证书;否则，只有系统可以在保留间隔结束时清除证书。
updated	integer	上次更新时间（UTC）。

CertificateBundle

证书捆绑包由一个证书 (X509) 及其属性组成。

名称	类型	说明
attributes	CertificateAttributes	证书属性。
cer	string	x509 证书的 CER 内容。
contentType	string	机密的内容类型。例如 “application/x-pem-file”或“application/x-pkcs12”，
id	string	证书 ID。
kid	string	密钥 ID。
policy	CertificatePolicy	管理策略。
sid	string	机密 ID。
tags	object	键值对形式的特定于应用程序的元数据
x5t	string	证书的指纹。

CertificatePolicy

证书的管理策略。

名称	类型	说明
attributes	CertificateAttributes	证书属性。
id	string	证书 ID。
issuer	IssuerParameters	证书 X509 组件的颁发者的参数。
key_props	KeyProperties	支持证书的密钥的属性。
lifetime_actions	LifetimeAction[]	将由密钥保管库在证书生存期内执行的操作。
secret_props	SecretProperties	支持证书的机密的属性。
x509_props	X509CertificateProperties	证书的 X509 组件的属性。

CertificatePolicyAction

操作的类型。

名称	类型	说明
AutoRenew	string
EmailContacts	string

CertificateUpdateParameters

证书更新参数。

名称	类型	说明
attributes	CertificateAttributes	证书的属性 (可选) 。
policy	CertificatePolicy	证书的管理策略。
tags	object	键/值对形式的应用程序特定元数据。

DeletionRecoveryLevel

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

名称	类型	说明
CustomizedRecoverable	string	表示可恢复删除的保管库状态， (即当 7<= SoftDeleteRetentionInDays < 90) 时进行清除，则无法立即和永久删除删除。此级别可保证已删除实体在保留间隔期间以及订阅仍可用时的可恢复性。
CustomizedRecoverable+ProtectedSubscription	string	表示保管库和订阅状态，其中删除是可恢复的，即时和永久删除 (即不允许清除) ，并且当 7<= SoftDeleteRetentionInDays < 90 时，订阅本身无法永久取消。此级别可保证已删除实体在保留间隔期间的可恢复性，还反映了订阅本身无法取消这一事实。
CustomizedRecoverable+Purgeable	string	表示保管库状态，其中删除是可恢复的，并且还允许立即和永久删除 (即在 7<= SoftDeleteRetentionInDays <) 时清除。除非请求清除操作或取消订阅，否则此级别可保证已删除实体在保留间隔期间的可恢复性。
Purgeable	string	表示保管库状态，其中删除操作不可逆，无法恢复。此级别对应于对删除操作没有可用的保护;在实体级别或更高 (保管库、资源组、订阅等接受删除操作时，数据将不可挽回地丢失 )
Recoverable	string	表示可恢复删除的保管库状态，无法立即和永久删除 (即清除) 。此级别保证在保留间隔 (90 天) 且订阅仍然可用期间，已删除实体的可恢复性。系统将在 90 天后永久删除它（如果未恢复）
Recoverable+ProtectedSubscription	string	表示保管库和订阅状态，其中删除可在 90 天内恢复， (90 天的保留间隔) ，即时和永久删除 (即不允许清除) ，并且订阅本身不能永久取消。系统将在 90 天后永久删除它（如果未恢复）
Recoverable+Purgeable	string	表示保管库状态，其中删除是可恢复的，还允许立即和永久删除 (即清除) 。此级别保证删除实体在保留间隔 (90 天) 的可恢复性，除非请求清除操作或取消订阅。系统将在 90 天后永久删除它（如果未恢复）

Error

密钥保管库服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

IssuerParameters

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

名称	类型	说明
cert_transparency	boolean	指示是否应将此策略下生成的证书发布到证书透明度日志。
cty	string	提供程序支持的证书类型 (可选) ;例如“OV-SSL”、“EV-SSL”
name	string	引用的颁发者对象的名称或保留名称;例如，“Self”或“Unknown”。

JsonWebKeyCurveName

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

名称	类型	说明
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

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

名称	类型	说明
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

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

名称	类型	说明
crv	JsonWebKeyCurveName	椭圆曲线名称。有关有效值，请参阅 JsonWebKeyCurveName。
exportable	boolean	指示是否可以导出私钥。创建可导出密钥的第一个版本时，必须提供释放策略。
key_size	integer	密钥的大小（以位为单位）。例如：RSA 的 2048、3072 或 4096。
kty	JsonWebKeyType	要用于证书的密钥对的类型。
reuse_key	boolean	指示是否在证书续订时使用相同的密钥对。

KeyUsageType

定义证书密钥的使用方式。

名称	类型	说明
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

密钥保管库错误异常。

名称	类型	说明
error	Error	密钥保管库服务器错误。

LifetimeAction

将由密钥保管库在证书生存期内执行的操作及其触发器。

名称	类型	说明
action	Action	将执行的操作。
trigger	Trigger	将执行操作的条件。

SecretProperties

支持证书的密钥的属性。

名称	类型	说明
contentType	string	媒体类型 (MIME 类型) 。

SubjectAlternativeNames

X509 对象的使用者备用名称。

名称	类型	说明
dns_names	string[]	域名。
emails	string[]	电子邮件地址。
upns	string[]	用户主体名称。

Trigger

要为要执行的操作满足的条件。

名称	类型	说明
days_before_expiry	integer	在到期前几天尝试续订。值应介于 1 和 validity_in_months乘以 27 之间。如果validity_in_months为 36，则值应介于 1 和 972 (36 * 27) 之间。
lifetime_percentage	integer	触发的生存期的百分比。值应介于 1 和 99 之间。

X509CertificateProperties

证书的 X509 组件的属性。

名称	类型	说明
ekus	string[]	增强的密钥用法。
key_usage	KeyUsageType[]	定义证书密钥的使用方式。
sans	SubjectAlternativeNames	使用者可选名称。
subject	string	主题名称。应为有效的 X509 可分辨名称。
validity_months	integer	证书的有效期（以月为单位）。