@azure/keyvault-certificates package
類別
| CertificateClient |
要與 KeyVault 憑證功能互動的用戶端 |
介面
類型別名
| ActionType |
將執行的動作。 |
| ArrayOneOrMore |
至少具有一個屬性的陣列。 |
| BackupCertificateOptions | |
| BeginDeleteCertificateOptions |
介面，表示可傳遞至 beginDeleteCertificate(string, CertificatePollerOptions) 的選擇性參數 |
| BeginRecoverDeletedCertificateOptions |
介面，表示可傳遞至 beginRecoverDeletedCertificate(string, CertificatePollerOptions) 的選擇性參數 |
| CancelCertificateOperationOptions |
<xref:cancelCertificateOperation>的選項。 |
| CertificateContact |
保存庫憑證的連絡資訊。 每個聯繫人至少只有 CertificateContactAll 的其中一個屬性，分別是：emailAddress、名稱或電話。 |
| CertificateContentType |
定義 contentType 的值。 可能的值包括：'application/x-pem-file'、'application/x-pkcs12' |
| CertificateKeyCurveName |
橢圓曲線名稱。 如需有效值，請參閱 JsonWebKeyCurveName。 服務支援的已知值
P-256：NIST P-256 橢圓曲線，AKA SECG 曲線SECP256R1。 |
| CertificateKeyType |
要用於憑證的金鑰組類型。 服務支援的已知值
EC：橢圓曲線。 |
| CertificatePolicy |
型別，代表至少有一個主體屬性的憑證原則。 |
| CertificatePolicyAction |
將執行的動作。 |
| CertificateTags |
介面，表示證書標記的形狀。 標記只是字串索引鍵/值組。 |
| CreateCertificateState |
CreateCertificatePoller 作業狀態的公用表示法。 |
| DeleteCertificateOperationOptions | |
| DeleteCertificateState |
DeleteCertificatePoller 作業狀態的公用表示法。 |
| DeleteContactsOptions | |
| DeleteIssuerOptions | |
| DeletionRecoveryLevel |
反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」，則特殊許可權使用者可以永久刪除秘密;否則，只有系統可以在保留間隔結束時清除秘密。 服務支援的已知值
可清除：表示保存庫狀態，其中刪除是無法復原的作業，而無法復原。 此層級對應至無法對刪除作業提供保護;在接受實體層級或更高層級的刪除作業時，數據會無法復原（保存庫、資源群組、訂用帳戶等） |
| GetCertificateOperationOptions |
getCertificateOperation(string, CertificatePollerOptions)的選項。 |
| GetCertificateOptions | |
| GetCertificatePolicyOptions | |
| GetCertificateVersionOptions | |
| GetContactsOptions | |
| GetDeletedCertificateOptions | |
| GetIssuerOptions | |
| GetPlainCertificateOperationOptions |
<xref:getPlainCertificateOperation>的選項。 |
| ImportCertificatePolicy |
類型，表示不需要 SAN 或主體的憑證匯入原則 |
| KVPollerLike |
core-lro 的 PollerLike 已淘汰 KeyVault 複本。 |
| KeyUsageType |
憑證金鑰的支援使用方式。 服務支援的已知值
digitalSignature：表示憑證密鑰可作為數字簽名。 |
| ListPropertiesOfCertificateVersionsOptions |
介面，表示傳遞至 listPropertiesOfCertificateVersions(string, OperationOptions)之 CertificateClient 分頁作業的選擇性參數。 |
| ListPropertiesOfIssuersOptions |
介面，表示傳遞至 listPropertiesOfIssuers(OperationOptions)之 CertificateClient 分頁作業的選擇性參數。 |
| MergeCertificateOptions |
介面，表示 mergeCertificate(string, Uint8Array[], OperationOptions)的選擇性參數。 |
| PurgeDeletedCertificateOptions | |
| RecoverDeletedCertificateState |
已淘汰：已刪除憑證輪詢作業復原的公用表示法 |
| RequireAtLeastOne |
RequireAtLeastOne 有助於建立類型，其中至少一個介面的屬性（可以是任何屬性）必須存在。 這是因為 TypeScript 的公用程式類型：https://www.typescriptlang.org/docs/handbook/utility-types.html 讓我們檢查它：
|
| RestoreCertificateBackupOptions |
介面，表示 restoreCertificateBackup(Uint8Array, OperationOptions)的選擇性參數。 |
| SetContactsOptions | |
| SubjectAlternativeNames |
主旨屬性的替代專案。 如果存在，它至少應該有 SubjectAlternativeNamesAll 的其中一個屬性。 |
| UpdateCertificatePolicyOptions |
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)的選項。 |
列舉
| KnownCertificateKeyCurveNames |
服務接受的 CertificateKeyCurveName 已知值。 |
| KnownCertificateKeyTypes |
CertificateKeyType 服務的已知值。 |
| KnownDeletionRecoveryLevels |
反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」，則特殊許可權使用者可以永久刪除秘密;否則，只有系統可以在保留間隔結束時清除秘密。 |
| KnownKeyUsageTypes |
服務接受的 KeyUsageType 已知值。 |
| WellKnownIssuer |
選擇預設值的已知簽發者 |
函式
| parse |
剖析指定的 Key Vault 憑證標識碼。例如： https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id> 在剖析上述識別碼時，此函式會傳回： |
函式詳細資料
parseKeyVaultCertificateIdentifier(string)
剖析指定的 Key Vault 憑證標識碼。例如：
https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id>
在剖析上述識別碼時，此函式會傳回：
{
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>"
}
function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier參數
- id
-
string
Key Vault 憑證的標識碼。