@azure/keyvault-certificates package

要與 KeyVault 憑證功能互動的用戶端

憑證簽發者組織管理員的詳細數據。

包含備份 Blob 的備份憑證結果。

介面，表示可傳遞至 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) 的選擇性參數

KeyVault 的 CertificateClient 所接受的選擇性參數

保存庫憑證連絡信息的形狀。

表示簽發者屬性的介面。

如果異步要求，則會傳回憑證作業。

金鑰儲存庫伺服器錯誤。

介面，表示 CertificateOperationPoller 狀態的公開可用屬性。

介面，表示憑證的原則（不含主體屬性）。

介面，表示可傳遞至 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)、beginDeleteCertificate(string, CertificatePollerOptions) 和 beginRecoverDeletedCertificate(string, CertificatePollerOptions) 的選擇性參數

表示憑證屬性的介面

X509 對象的主體替代名稱。

<xref:createCertificate>的選項。

createIssuer(string, string, CreateIssuerOptions)的選項。

表示已刪除憑證的介面。

金鑰儲存庫伺服器錯誤模型。

importCertificate(string, Uint8Array, ImportCertificateOptions)的選項。

Key Vault 服務所管理之簽發者的屬性。

要用於憑證簽發者的認證。

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

介面，表示憑證簽發者的屬性

介面，表示沒有憑證原則的憑證

代表組成 Key Vault 憑證標識碼的區段。

介面，表示 Key Vault 憑證輪詢器作業狀態的公用形狀。

介面，表示具有其原則的憑證

動作及其觸發程式，將在憑證存留期內由 Key Vault 執行。

介面，表示傳遞至 listDeletedCertificates(ListDeletedCertificatesOptions)之 CertificateClient 分頁作業的選擇性參數。

介面，表示傳遞至 listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)之 CertificateClient 分頁作業的選擇性參數。

介面，表示憑證原則的可能主體屬性。 最終類型至少需要其中一個屬性存在。

輪詢器抽象表示法，旨在只公開使用者需要使用的最小 API。

輪詢器抽象表示法，旨在只公開使用者需要使用的最小 API。

介面，表示憑證原則主體的替代名稱。

<xref:updateCertificate>的選項。

updateIssuer(string, UpdateIssuerOptions)的選項。

憑證的 X509 元件屬性。

定義 ActionType 的值。

至少具有一個屬性的陣列。

backupCertificate(string, OperationOptions)的選項。

介面，表示可傳遞至 beginDeleteCertificate(string, CertificatePollerOptions) 的選擇性參數

介面，表示可傳遞至 beginRecoverDeletedCertificate(string, CertificatePollerOptions) 的選擇性參數

<xref:cancelCertificateOperation>的選項。

保存庫憑證的連絡資訊。 每個聯繫人至少只有 CertificateContactAll 的其中一個屬性，分別是：emailAddress、名稱或電話。

定義 contentType 的值。 可能的值包括：'application/x-pem-file'、'application/x-pkcs12'

定義 JsonWebKeyCurveName 的值。
<xref:KnownJsonWebKeyCurveName> 可以與 JsonWebKeyCurveName 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

P-256
P-384
P-521
P-256K

定義 JsonWebKeyType 的值。
<xref:KnownJsonWebKeyType> 可以與 JsonWebKeyType 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

EC
EC-HSM
RSA
RSA-HSM
10 月 日
oct-HSM

型別，代表至少有一個主體屬性的憑證原則。

將執行的動作。

介面，表示證書標記的形狀。 標記只是字串索引鍵/值組。

CreateCertificatePoller 作業狀態的公用表示法。

deleteCertificateOperation(string, OperationOptions)的選項。

DeleteCertificatePoller 作業狀態的公用表示法。

deleteContacts(OperationOptions)的選項。

deleteIssuer(string, OperationOptions)的選項。

定義DeletionRecoveryLevel的值。
<xref:KnownDeletionRecoveryLevel> 可以與 DeletionRecoveryLevel 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

可清除：表示保存庫狀態，其中刪除是無法復原的作業，而無法復原。 此層級對應至無法對刪除作業提供保護;在接受實體層級或更高層級的刪除作業時，數據會無法復原（保存庫、資源群組、訂用帳戶等）
可復原+可清除：表示可復原刪除的保存庫狀態，也允許立即和永久刪除（亦即清除）。 此層級保證刪除實體在保留間隔期間 （90 天） 的復原能力，除非要求清除作業，或取消訂閱。 系統 wil 會在 90 天后永久刪除，如果未復原
可復原：表示可復原刪除的保存庫狀態，而無法立即和永久刪除（亦即清除）。 此層級可保證已刪除實體在保留間隔（90 天）和訂用帳戶仍可使用期間復原。 系統 wil 會在 90 天后永久刪除，如果未復原
Recoverable+ProtectedSubscription：表示保存庫和訂用帳戶狀態，在保留間隔（90 天）、立即和永久刪除期間內可復原的保存庫和訂用帳戶狀態，且不允許永久取消訂閱本身。 系統 wil 會在 90 天后永久刪除，如果未復原
CustomizedRecoverable+Purgeable：表示可復原刪除的保存庫狀態，也允許立即和永久刪除（也就是當 7<= SoftDeleteRetentionInDays < 90 時清除）。 除非要求清除作業或取消訂閱，否則此層級保證在保留間隔期間已刪除實體的復原能力。
CustomizedRecoverable：表示可復原刪除的保存庫狀態，而無法立即和永久刪除（亦即當 7<= SoftDeleteRetentionInDays < 90 時清除）。此層級可保證已刪除實體在保留間隔期間和訂用帳戶仍可使用時的復原能力。
CustomizedRecoverable+ProtectedSubscription：表示無法復原刪除的保存庫和訂閱狀態，不允許立即和永久刪除（亦即清除），而且當 7<= SoftDeleteRetentionInDays < 90 時，將無法永久取消訂閱本身。 此層級保證在保留間隔期間已刪除實體的復原能力，也反映無法取消訂閱本身的事實。

getCertificateOperation(string, CertificatePollerOptions)的選項。

getCertificate(string, OperationOptions)的選項。

getCertificatePolicy(string, OperationOptions)的選項。

getCertificateVersion(string, string, OperationOptions)的選項。

getContacts(OperationOptions)的選項。

getDeletedCertificate(string, OperationOptions)的選項。

getIssuer(string, OperationOptions)的選項。

<xref:getPlainCertificateOperation>的選項。

類型，表示不需要 SAN 或主體的憑證匯入原則

core-lro 的 PollerLike 已淘汰 KeyVault 複本。

定義 KeyUsageType 的值。
<xref:KnownKeyUsageType> 可以與 KeyUsageType 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

digitalSignature
非分類
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
加密Only
譯碼Only

介面，表示傳遞至 listPropertiesOfCertificateVersions(string, OperationOptions)之 CertificateClient 分頁作業的選擇性參數。

介面，表示傳遞至 listPropertiesOfIssuers(OperationOptions)之 CertificateClient 分頁作業的選擇性參數。

介面，表示 mergeCertificate(string, Uint8Array[], OperationOptions)的選擇性參數。

purgeDeletedCertificate(string, OperationOptions)的選項。

已淘汰：已刪除憑證輪詢作業復原的公用表示法

RequireAtLeastOne 有助於建立類型，其中至少一個介面的屬性（可以是任何屬性）必須存在。

這是因為 TypeScript 的公用程式類型：https://www.typescriptlang.org/docs/handbook/utility-types.html 讓我們檢查它：

• [K in keyof T]-? 此屬性 （K） 只有在它與 T 的任何屬性同名時才有效。
• Required<Pick<T, K>> 從 T 建立新的類型，其中只有反覆運算中的目前屬性，並將它標示為必要
• Partial<Pick<T, Exclude<keyof T, K>>> 會建立具有 T 所有屬性的新類型，但屬性 K 除外。
• & 是將類型與來自 Partial<...>的所有選擇性屬性 Required<...> 中只有一個必要屬性結合在一起。
• [keyof T] 可確保只允許 T 的屬性。

介面，表示 restoreCertificateBackup(Uint8Array, OperationOptions)的選擇性參數。

setContacts(CertificateContact[], OperationOptions)的選項。

主旨屬性的替代專案。 如果存在，它至少應該有 SubjectAlternativeNamesAll 的其中一個屬性。

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)的選項。

服務接受的 CertificateKeyCurveName 已知值。

CertificateKeyType 服務的已知值。

DeletionRecoveryLevel 服務的已知值。

服務接受的 KeyUsageType 已知值。

選擇預設值的已知簽發者

剖析指定的 Key Vault 憑證標識碼。例如：

https://.vault.azure.net/certificates//

在剖析上述識別碼時，此函式會傳回：

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }