@azure/keyvault-certificates package

類別

CertificateClient

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

介面

AdministratorContact	憑證簽發者的組織系統管理員詳細資料。
BackupCertificateResult	包含備份 Blob 的備份憑證結果。
BeginCreateCertificateOptions	介面，表示可傳遞至的選擇性參數 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	KeyVault 的 CertificateClient 所接受的選擇性參數
CertificateContactAll	保存庫憑證的連絡資訊圖形。
CertificateIssuer	表示簽發者屬性的介面。
CertificateOperation	如果非同步要求，則會傳回憑證作業。
CertificateOperationError	金鑰保存庫伺服器錯誤。
CertificateOperationState	介面，表示 CertificateOperationPoller 狀態的公開可用屬性。
CertificatePolicyProperties	介面，表示憑證的原則 (，沒有主體屬性) 。
CertificatePollerOptions	介面，表示可傳遞至 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) 、 beginDeleteCertificate(string, CertificatePollerOptions) 和 的選擇性參數 beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	表示憑證屬性的介面
CoreSubjectAlternativeNames	X509 物件的主體替代名稱。
CreateCertificateOptions	的選項 <xref:createCertificate> 。
CreateIssuerOptions	的選項 createIssuer(string, string, CreateIssuerOptions) 。
DeletedCertificate	表示已刪除憑證的介面。
ErrorModel	金鑰保存庫伺服器錯誤模型。
ImportCertificateOptions	的選項 importCertificate(string, Uint8Array, ImportCertificateOptions) 。
IssuerAttributes	由金鑰保存庫服務管理的簽發者屬性。
IssuerCredentials	要用於憑證簽發者的認證。
IssuerParameters	憑證之 X509 元件的簽發者參數。
IssuerProperties	表示憑證簽發者屬性的介面
KeyVaultCertificate	表示沒有憑證原則之憑證的介面
KeyVaultCertificateIdentifier	表示組成金鑰保存庫憑證識別碼的區段。
KeyVaultCertificatePollOperationState	介面，表示金鑰保存庫憑證輪詢器作業狀態的公用圖形。
KeyVaultCertificateWithPolicy	介面，表示具有其原則的憑證
LifetimeAction	動作及其觸發程式，將在憑證存留期內金鑰保存庫執行。
ListDeletedCertificatesOptions	介面，表示傳遞至 listDeletedCertificates(ListDeletedCertificatesOptions) 之 CertificateClient 分頁作業的選擇性參數。
ListPropertiesOfCertificatesOptions	介面，表示傳遞至 listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions) 之 CertificateClient 分頁作業的選擇性參數。
PolicySubjectProperties	介面，表示憑證原則的可能主體屬性。 最終類型至少需要其中一個屬性存在。
PollerLike	輪詢器的抽象標記法，旨在只公開使用者需要使用的最小 API。
SubjectAlternativeNamesAll	介面，表示憑證原則主體的替代名稱。
UpdateCertificateOptions	的選項 <xref:updateCertificate> 。
UpdateIssuerOptions	的選項 updateIssuer(string, UpdateIssuerOptions) 。
X509CertificateProperties	憑證之 X509 元件的屬性。

類型別名

ActionType	定義 ActionType 的值。
ArrayOneOrMore	至少具有一個屬性的陣列。
BackupCertificateOptions	的選項 backupCertificate(string, OperationOptions) 。
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 的值。 <xref:KnownJsonWebKeyCurveName> 可以與 JsonWebKeyCurveName 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 P-256 P-384 P-521 P-256K
CertificateKeyType	定義 JsonWebKeyType 的值。 <xref:KnownJsonWebKeyType> 可以與 JsonWebKeyType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 EC EC-HSM RSA RSA-HSM oct oct-HSM
CertificatePolicy	類型，表示至少有一個主體屬性的憑證原則。
CertificatePolicyAction	將執行的動作。
CertificateTags	介面，表示憑證標記的形狀。 標籤只是字串索引鍵/值組。
CreateCertificateState	CreateCertificatePoller 作業狀態的公用標記法。
DeleteCertificateOperationOptions	的選項 deleteCertificateOperation(string, OperationOptions) 。
DeleteCertificateState	DeleteCertificatePoller 作業狀態的公用標記法。
DeleteContactsOptions	的選項 deleteContacts(OperationOptions) 。
DeleteIssuerOptions	的選項 deleteIssuer(string, OperationOptions) 。
DeletionRecoveryLevel	定義 DeletionRecoveryLevel 的值。 <xref:KnownDeletionRecoveryLevel> 可以與 DeletionRecoveryLevel 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 可清除：表示刪除是無法復原作業的保存庫狀態，而無法復原。 此層級對應至刪除作業沒有可用的保護;在實體層級或更高層級接受刪除作業時，資料無法復原， (保存庫、資源群組、訂用帳戶等) 可復原+可清除：表示可復原刪除的保存庫狀態，也允許立即和永久刪除 (，也就是清除) 。 除非要求清除作業或取消訂用帳戶，否則此層級可確保在保留間隔期間 (90 天) ，否則已刪除實體的復原能力。 系統會在 90 天后永久刪除，如果未復原，則為 可復原：表示可復原刪除的保存庫狀態，而不可能發生立即和永久刪除 (，亦即清除) 。 此層級可確保在保留間隔期間 (90 天) 且訂用帳戶仍可使用時，刪除實體的復原能力。 系統會在 90 天后永久刪除，如果未復原，則為 Recoverable+ProtectedSubscription：表示保存庫和訂用帳戶狀態，其中刪除可在保留間隔內復原 (90 天) 、立即和永久刪除 (，亦即不允許清除) ，以及無法永久取消訂用帳戶本身。 系統會在 90 天后永久刪除，如果未復原，則為 CustomizedRecoverable+Purgeable：表示可復原刪除的保存庫狀態，也允許立即和永久刪除 (，也就是在 7 < = SoftDeleteRetentionInDays < 90) 時清除。 除非要求清除作業或取消訂閱，否則此層級可確保在保留間隔期間刪除實體的復原能力。 CustomizedRecoverable：表示可復原刪除的保存庫狀態，而無法立即和永久刪除 (，也就是在 7 < = SoftDeleteRetentionInDays < 90) 時清除。此層級保證在保留間隔期間和訂用帳戶仍可使用時，已刪除實體的復原能力。 CustomizedRecoverable+ProtectedSubscription：表示刪除可復原的保存庫和訂用帳戶狀態、立即和永久刪除 (亦即不允許清除) ，以及當 7 < = SoftDeleteRetentionInDays < 90 時，無法永久取消訂用帳戶本身。 此層級保證在保留間隔期間刪除的實體可復原性，同時反映無法取消訂閱本身的事實。
GetCertificateOperationOptions	的選項 getCertificateOperation(string, CertificatePollerOptions) 。
GetCertificateOptions	的選項 getCertificate(string, OperationOptions) 。
GetCertificatePolicyOptions	的選項 getCertificatePolicy(string, OperationOptions) 。
GetCertificateVersionOptions	的選項 getCertificateVersion(string, string, OperationOptions) 。
GetContactsOptions	的選項 getContacts(OperationOptions) 。
GetDeletedCertificateOptions	的選項 getDeletedCertificate(string, OperationOptions) 。
GetIssuerOptions	的選項 getIssuer(string, OperationOptions) 。
GetPlainCertificateOperationOptions	的選項 <xref:getPlainCertificateOperation> 。
ImportCertificatePolicy	類型，表示不需要 SAN 或主體的憑證匯入原則
KVPollerLike	core-lro 的 PollerLike 已被取代的 KeyVault 複本。
KeyUsageType	定義 KeyUsageType 的值。 <xref:KnownKeyUsageType> 可以與 KeyUsageType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 digitalSignature nonRepudiation keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	介面，表示傳遞至 listPropertiesOfCertificateVersions(string, OperationOptions) 之 CertificateClient 分頁作業的選擇性參數。
ListPropertiesOfIssuersOptions	介面，表示傳遞至 listPropertiesOfIssuers(OperationOptions) 之 CertificateClient 分頁作業的選擇性參數。
MergeCertificateOptions	介面，表示 的 mergeCertificate(string, Uint8Array[], OperationOptions) 選擇性參數。
PurgeDeletedCertificateOptions	的選項 purgeDeletedCertificate(string, OperationOptions) 。
RecoverDeletedCertificateState	已淘汰：公開表示已刪除憑證輪詢作業的復原
RequireAtLeastOne	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 除外。 & 是 將類型與 只有一個必要屬性與 中的所有選擇性屬性結合 Required<...> 在 Partial<...> 一起。 [keyof T] 可確保只允許 T 的屬性。
RestoreCertificateBackupOptions	介面，表示 的 restoreCertificateBackup(Uint8Array, OperationOptions) 選擇性參數。
SetContactsOptions	的選項 setContacts(CertificateContact[], OperationOptions) 。
SubjectAlternativeNames	主旨屬性的替代專案。 如果有的話，它至少應該有 SubjectAlternativeNamesAll 的其中一個屬性。
UpdateCertificatePolicyOptions	的選項 updateCertificatePolicy(string, CertificatePolicy, OperationOptions) 。

列舉

KnownCertificateKeyCurveNames	服務的 CertificateKeyCurveName 已知值。
KnownCertificateKeyTypes	服務接受的 CertificateKeyType 已知值。
KnownDeletionRecoveryLevels	服務的 DeletionRecoveryLevel 已知值。
KnownKeyUsageTypes	服務接受的 KeyUsageType 已知值。
WellKnownIssuer	選擇預設值的已知簽發者

函數

parseKeyVaultCertificateIdentifier(string)

剖析指定的金鑰保存庫憑證識別碼。例如： 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>" }

函式詳細資料

parseKeyVaultCertificateIdentifier(string)

剖析指定的金鑰保存庫憑證識別碼。例如：

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

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

參數

id

string

金鑰保存庫憑證的識別碼。

傳回

KeyVaultCertificateIdentifier