Merge Certificate - Merge Certificate

參考

Service:: Key Vault

API Version:: 7.4

將憑證或憑證鏈結與伺服器上現有的金鑰組合並。
MergeCertificate 作業會執行憑證或憑證鏈結與服務中目前可用的密鑰組合並。此作業須有憑證/建立權限。

POST {vaultBaseUrl}/certificates/{certificate-name}/pending/merge?api-version=7.4

URI 參數

名稱	位於	必要	類型	Description
certificate-name	path	True	string	憑證的名稱。
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
x5c	True	string[]	要合併的憑證或憑證鏈結。
attributes		CertificateAttributes	憑證的屬性 (選擇性) 。
tags		object	以機碼/值組的形式應用程式特定元數據。

回應

名稱	類型	Description
201 Created	CertificateBundle	合併的憑證配套至保存庫。
Other Status Codes	KeyVaultError	金鑰保存庫錯誤回應，描述作業失敗的原因。

範例

MergeCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/testcert/pending/merge?api-version=7.4

{
  "x5c": [
    "MIICxTCCAb....trimmed for brevitiy...EPAQj8="
  ]
}

Sample Response

Status code:: 201

{
  "id": "https://myvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352",
  "kid": "https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352",
  "sid": " mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352",
  "cer": "……de34534……",
  "x5t": "n14q2wbvyXr71Pcb58NivuiwJKk",
  "attributes": {
    "enabled": true,
    "exp": 1530394215,
    "nbf": 1435699215,
    "created": 1435699919,
    "updated": 1435699919
  },
  "policy": {
    "id": "https:// mykeyvault.vault.azure.net/certificates/mycert1/policy",
    "key_props": {
      "exportable": false,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=Mycert1",
      "ekus": [
        "1.3.6.1.5.5.7.3.1",
        "1.3.6.1.5.5.7.3.2"
      ],
      "validity_months": 12
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1435699811,
      "updated": 1435699811
    }
  }
}

定義

名稱	Description
Action	將執行的動作。
CertificateAttributes	憑證管理屬性。
CertificateBundle	憑證套件組合包含 (X509) 及其屬性的憑證。
CertificateMergeParameters	憑證合併參數
CertificatePolicy	憑證的管理原則。
CertificatePolicyAction	動作的類型。
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	憑證的指紋。

CertificateMergeParameters

憑證合併參數

名稱	類型	Description
attributes	CertificateAttributes	憑證的屬性 (選擇性) 。
tags	object	以機碼/值組形式的應用程式特定元數據。
x5c	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

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	憑證有效月份的持續時間。

Share via