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

Update Certificate - Update Certificate

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

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

URI 参数

Name In Required Type Description
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 版本。

请求正文

Name Type Description
attributes

证书的属性 (可选) 。

policy

证书的管理策略。

tags
  • object

键/值对形式的应用程序特定元数据。

响应

Name Type Description
200 OK

更新的证书。

Other Status Codes

密钥保管库错误响应,描述操作失败的原因。

示例

UpdateCertificate

Sample Request

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

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

Sample Response

{
  "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

将执行的操作。

ActionType

操作的类型。

CertificateAttributes

证书管理属性。

CertificateBundle

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

CertificatePolicy

证书的管理策略。

CertificateUpdateParameters

证书更新参数。

DeletionRecoveryLevel

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

Error

密钥保管库服务器错误。

IssuerParameters

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

JsonWebKeyCurveName

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

JsonWebKeyType

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

KeyProperties

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

KeyVaultError

密钥保管库错误异常。

LifetimeAction

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

SecretProperties

支持证书的密钥的属性。

SubjectAlternativeNames

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

Trigger

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

X509CertificateProperties

证书的 X509 组件的属性。

Action

将执行的操作。

Name Type Description
action_type

操作的类型。

ActionType

操作的类型。

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

证书管理属性。

Name Type Description
created
  • integer

以 UTC 为单位的创建时间。

enabled
  • boolean

确定是否启用对象。

exp
  • integer

UTC 格式的到期日期。

nbf
  • integer

不在 UTC 的日期之前。

recoverableDays
  • integer

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

recoveryLevel

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

updated
  • integer

上次以 UTC 为单位的更新时间。

CertificateBundle

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

Name Type Description
attributes

证书属性。

cer
  • string

x509 证书的 CER 内容。

contentType
  • string

机密的内容类型。 例如 “application/x-pem-file”或“application/x-pkcs12”,

id
  • string

证书 ID。

kid
  • string

密钥 ID。

policy

管理策略。

sid
  • string

机密 ID。

tags
  • object

键值对形式的应用程序特定元数据

x5t
  • string

证书的指纹。

CertificatePolicy

证书的管理策略。

Name Type Description
attributes

证书属性。

id
  • string

证书 ID。

issuer

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

key_props

支持证书的密钥的属性。

lifetime_actions

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

secret_props

支持证书的机密的属性。

x509_props

证书的 X509 组件的属性。

CertificateUpdateParameters

证书更新参数。

Name Type Description
attributes

证书的属性 (可选) 。

policy

证书的管理策略。

tags
  • object

键/值对形式的应用程序特定元数据。

DeletionRecoveryLevel

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

Name Type Description
CustomizedRecoverable
  • string

表示可以恢复删除的保管库状态,而无需立即和永久删除 (,即在 7<= SoftDeleteRetentionInDays < 90) 时清除。此级别保证在保留时间间隔内和订阅仍可用期间已删除实体的可恢复性。

CustomizedRecoverable+ProtectedSubscription
  • string

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

CustomizedRecoverable+Purgeable
  • string

表示可恢复删除的保管库状态,也允许立即和永久删除 (,即在 7<= SoftDeleteRetentionInDays < 90) 时清除。 此级别保证在保留间隔期间删除的实体的可恢复性,除非请求清除操作或取消订阅。

Purgeable
  • string

表示删除操作不可逆转的保管库状态,而无法恢复。 此级别对应于没有针对删除操作可用的保护;接受实体级别或更高 (保管库、资源组、订阅等删除操作时,数据无法挽回丢失 ) 。

Recoverable
  • string

表示可以恢复删除的保管库状态,而无需立即和永久删除 (,即清除) 。 此级别保证在保留时间间隔内已删除实体的可恢复性, (90 天) ,并且订阅仍可用。 系统在 90 天后永久删除它(如果未恢复)

Recoverable+ProtectedSubscription
  • string

表示保管库和订阅状态,即不允许在保留时间间隔内恢复删除 (90 天) 、即时和永久删除 (,即不允许清除) ,并且无法永久取消订阅本身。 系统在 90 天后永久删除它(如果未恢复)

Recoverable+Purgeable
  • string

表示可恢复删除的保管库状态,还允许立即和永久删除 (,即清除) 。 此级别保证删除实体在保留间隔期间 (90 天) 的可恢复性,除非请求清除操作或取消订阅。 系统在 90 天后永久删除它(如果未恢复)

Error

密钥保管库服务器错误。

Name Type Description
code
  • string

错误代码。

innererror

密钥保管库服务器错误。

message
  • string

错误消息。

IssuerParameters

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

Name Type Description
cert_transparency
  • boolean

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

cty
  • string

提供程序支持的证书类型 (可选) ;例如“OV-SSL”、“EV-SSL”

name
  • string

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

JsonWebKeyCurveName

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

Name Type Description
P-256
  • string
P-256K
  • string
P-384
  • string
P-521
  • string

JsonWebKeyType

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

Name Type Description
EC
  • string
EC-HSM
  • string
RSA
  • string
RSA-HSM
  • string
oct
  • string
oct-HSM
  • string

KeyProperties

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

Name Type Description
crv

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

exportable
  • boolean

指示是否可以导出私钥。 创建可导出密钥的第 1 版时,必须提供发布策略。

key_size
  • integer

密钥的大小(以位为单位)。 例如:2048、3072 或 4096(对于 RSA)。

kty

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

reuse_key
  • boolean

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

KeyVaultError

密钥保管库错误异常。

Name Type Description
error

密钥保管库服务器错误。

LifetimeAction

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

Name Type Description
action

将执行的操作。

trigger

将执行操作的条件。

SecretProperties

支持证书的密钥的属性。

Name Type Description
contentType
  • string

媒体类型 (MIME 类型) 。

SubjectAlternativeNames

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

Name Type Description
dns_names
  • string[]

域名。

emails
  • string[]

电子邮件地址。

upns
  • string[]

用户主体名称。

Trigger

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

Name Type Description
days_before_expiry
  • integer

过期前几天尝试续订。 值应介于 1 和 validity_in_months乘以 27 之间。 如果validity_in_months为 36,则值应介于 1 和 972 之间, (36 * 27) 。

lifetime_percentage
  • integer

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

X509CertificateProperties

证书的 X509 组件的属性。

Name Type Description
ekus
  • string[]

增强型密钥用法。

key_usage
  • string[]

密钥用法列表。

sans

使用者可选名称。

subject
  • string

主题名称。 应该是有效的 X509 可分辨名称。

validity_months
  • integer

证书有效期(以月为单位)。