Update Certificate - Update Certificate

參考

服務:: Key Vault

API 版本:: 7.4

匯報與指定憑證相關聯的指定屬性。
UpdateCertificate 作業會在指定的憑證上套用指定的更新;唯一更新的專案是憑證的屬性。這項作業需要憑證/更新許可權。

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

URI 參數

名稱	位於	必要	類型	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 版本。

要求本文

名稱	類型	Description
attributes	CertificateAttributes	憑證的屬性 (選擇性) 。
policy	CertificatePolicy	憑證的管理原則。
tags	object	以機碼/值組的形式應用程式特定元數據。

回應

名稱	類型	Description
200 OK	CertificateBundle	更新的憑證。
Other Status Codes	KeyVaultError	金鑰保存庫錯誤回應，描述作業失敗的原因。

範例

UpdateCertificate

範例要求

HTTP

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

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

範例回覆

狀態碼:: 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"
  }
}

定義

名稱	Description
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

將執行的動作。

名稱	類型	Description
action_type	CertificatePolicyAction	動作的類型。

CertificateAttributes

憑證管理屬性。

名稱	類型	Description
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) 及其屬性的憑證。

名稱	類型	Description
attributes	CertificateAttributes	憑證屬性。
cer	string	x509 憑證的 CER 內容。
contentType	string	秘密的內容類型。例如 'application/x-pem-file' 或 'application/x-pkcs12'，
id	string	憑證標識碼。
kid	string	金鑰識別碼。
policy	CertificatePolicy	管理原則。
sid	string	秘密標識碼。
tags	object	以機碼/值組的形式應用程式特定元數據
x5t	string	憑證的指紋。

CertificatePolicy

憑證的管理原則。

名稱	類型	Description
attributes	CertificateAttributes	憑證屬性。
id	string	憑證標識碼。
issuer	IssuerParameters	憑證之 X509 元件的簽發者參數。
key_props	KeyProperties	金鑰備份憑證的屬性。
lifetime_actions	LifetimeAction[]	憑證存留期期間金鑰保存庫執行的動作。
secret_props	SecretProperties	憑證的秘密備份屬性。
x509_props	X509CertificateProperties	憑證之 X509 元件的屬性。

CertificatePolicyAction

動作的類型。

名稱	類型	Description
AutoRenew	string
EmailContacts	string

CertificateUpdateParameters

憑證更新參數。

名稱	類型	Description
attributes	CertificateAttributes	憑證的屬性 (選擇性) 。
policy	CertificatePolicy	憑證的管理原則。
tags	object	以機碼/值組的形式應用程式特定元數據。

DeletionRecoveryLevel

反映目前保存庫中憑證目前生效的刪除復原層級。如果它包含「可清除」，則特殊許可權使用者可以永久刪除憑證;否則，只有系統可以在保留間隔結束時清除憑證。

名稱	類型	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

金鑰儲存庫伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	金鑰儲存庫伺服器錯誤。
message	string	錯誤訊息。

IssuerParameters

憑證之 X509 元件的簽發者參數。

名稱	類型	Description
cert_transparency	boolean	指出此原則下產生的憑證是否應該發佈至憑證透明度記錄。
cty	string	提供者支持的憑證類型 (選擇性) ;例如 'OV-SSL'、'EV-SSL'
name	string	參考簽發者物件或保留名稱的名稱;例如，'Self' 或 'Unknown'。

JsonWebKeyCurveName

橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。

名稱	類型	Description
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

要用於憑證的金鑰組類型。

名稱	類型	Description
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

備份憑證之金鑰組的屬性。

名稱	類型	Description
crv	JsonWebKeyCurveName	橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。
exportable	boolean	指出是否可以匯出私鑰。建立可匯出密鑰的第一個版本時，必須提供發行原則。
key_size	integer	金鑰的大小 (以位元為單位)。例如：RSA 的 2048、3072 或 4096。
kty	JsonWebKeyType	要用於憑證的金鑰組類型。
reuse_key	boolean	指出憑證更新時是否要使用相同的金鑰組。

KeyUsageType

定義如何使用憑證的金鑰。

名稱	類型	Description
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

金鑰保存庫錯誤例外狀況。

名稱	類型	Description
error	Error	金鑰儲存庫伺服器錯誤。

LifetimeAction

動作及其觸發程式，將在憑證存留期內金鑰保存庫執行。

名稱	類型	Description
action	Action	將執行的動作。
trigger	Trigger	將執行動作的條件。

SecretProperties

金鑰備份憑證的屬性。

名稱	類型	Description
contentType	string	媒體類型 (MIME類型) 。

SubjectAlternativeNames

X509 對象的主體替代名稱。

名稱	類型	Description
dns_names	string[]	功能變數名稱。
emails	string[]	電子郵件地址。
upns	string[]	用戶主體名稱。

Trigger

要執行動作的條件。

名稱	類型	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 元件的屬性。

名稱	類型	Description
ekus	string[]	增強金鑰使用方式。
key_usage	KeyUsageType[]	定義如何使用憑證的金鑰。
sans	SubjectAlternativeNames	主體別名。
subject	string	主體名稱。應該是有效的 X509 辨別名稱。
validity_months	integer	憑證在幾個月內有效的持續時間。

共用方式為