Bagikan melalui

@azure/keyvault-certificates package

Kelas

CertificateClient

Klien untuk berinteraksi dengan fungsionalitas sertifikat KeyVault

Antarmuka

AdministratorContact

Detail administrator organisasi penerbit sertifikat.
BackupCertificateResult

Hasil sertifikat cadangan, yang berisi blob cadangan.
BeginCreateCertificateOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions

Parameter opsional yang diterima oleh CertificateClient KeyVault
CertificateContactAll

Bentuk informasi kontak untuk sertifikat vault.
CertificateIssuer

Antarmuka yang mewakili properti pengeluar sertifikat.
CertificateOperation

Operasi sertifikat dikembalikan jika terjadi permintaan asinkron.
CertificateOperationError

Kesalahan server brankas kunci.
CertificateOperationState

Antarmuka yang mewakili properti yang tersedia untuk umum dari status CertificateOperationPoller.
CertificatePolicyProperties

Antarmuka yang mewakili kebijakan sertifikat (tanpa properti subjek).
CertificatePollerOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) dan beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties

Antarmuka yang mewakili properti sertifikat
CoreSubjectAlternativeNames

Nama alternatif subjek dari objek X509.
CreateCertificateOptions

Opsi untuk <xref:createCertificate>.
CreateIssuerOptions

Opsi untuk createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate

Antarmuka yang mewakili sertifikat yang dihapus.
ErrorModel

Model kesalahan server brankas kunci.
ImportCertificateOptions

Opsi untuk importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes

Atribut penerbit yang dikelola oleh layanan Key Vault.
IssuerCredentials

Kredensial yang akan digunakan untuk penerbit sertifikat.
IssuerParameters

Parameter untuk penerbit komponen X509 sertifikat.
IssuerProperties

Antarmuka yang mewakili properti penerbit sertifikat
KeyVaultCertificate

Antarmuka yang mewakili sertifikat tanpa kebijakan sertifikat
KeyVaultCertificateIdentifier

Mewakili segmen yang menyusun Id Sertifikat Key Vault.
KeyVaultCertificatePollOperationState

Antarmuka yang mewakili bentuk publik status operasi Key Vault Certificate Poller.
KeyVaultCertificateWithPolicy

Antarmuka yang mewakili sertifikat dengan kebijakannya
LifetimeAction

Tindakan dan pemicunya yang akan dilakukan oleh Key Vault selama masa pakai sertifikat.
ListDeletedCertificatesOptions

Antarmuka yang mewakili parameter opsional untuk operasi halaman CertificateClient diteruskan ke listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions

Antarmuka yang mewakili parameter opsional untuk operasi halaman CertificateClient diteruskan ke listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties

Antarmuka yang mewakili kemungkinan properti subjek dari kebijakan sertifikat. Jenis akhir mengharuskan setidaknya salah satu properti ini ada.
PollerLike

Representasi abstrak dari poller, dimaksudkan untuk mengekspos api minimal yang perlu dikerjakan pengguna.
PollerLikeWithCancellation

Representasi abstrak dari poller, dimaksudkan untuk mengekspos api minimal yang perlu dikerjakan pengguna.
SubjectAlternativeNamesAll

Antarmuka yang mewakili nama alternatif subjek kebijakan sertifikat.
UpdateCertificateOptions

Opsi untuk <xref:updateCertificate>.
UpdateIssuerOptions

Opsi untuk updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties

Properti komponen X509 sertifikat.

Alias Jenis

ActionType

Tindakan yang akan dijalankan.
ArrayOneOrMore

Array dengan satu properti minimal.
BackupCertificateOptions

Opsi untuk backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions

Opsi untuk <xref:cancelCertificateOperation>.
CertificateContact

Informasi kontak untuk sertifikat vault. Setiap kontak akan memiliki setidaknya hanya salah satu properti CertificateContactAll, yaitu: emailAddress, nama, atau telepon.
CertificateContentType

Menentukan nilai untuk contentType. Nilai yang mungkin termasuk: 'application/x-pem-file', 'application/x-pkcs12'
CertificateKeyCurveName

Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> dapat digunakan secara bergantian dengan JsonWebKeyCurveName, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

P-256: Kurva elips NIST P-256, kurva AKA SECG SECP256R1.
P-384: Kurva elips NIST P-384, kurva AKA SECG SECP384R1.
P-521: Kurva elips NIST P-521, kurva AKA SECG SECP521R1.
P-256K: Kurva elips SECP256K1 SECG.
CertificateKeyType

Jenis pasangan kunci yang akan digunakan untuk sertifikat.
<xref:KnownJsonWebKeyType> dapat digunakan secara bergantian dengan JsonWebKeyType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

EC: Kurva Elips.
EC-HSM: Kurva Elips dengan kunci privat yang tidak dapat diekspor dari HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM: RSA dengan kunci privat yang tidak dapat diekspor dari HSM.
okt: Urutan oktet (digunakan untuk mewakili kunci konten).
okt-HSM : Urutan oktet dengan kunci privat yang tidak dapat diekspor dari HSM.
CertificatePolicy

Jenis yang mewakili kebijakan sertifikat dengan setidaknya salah satu properti subjek.
CertificatePolicyAction

Tindakan yang akan dijalankan.
CertificateTags

Antarmuka yang mewakili bentuk Tag Sertifikat. Tag hanyalah pasangan kunci-nilai string.
CreateCertificateState

Representasi publik dari status operasi CreateCertificatePoller.
DeleteCertificateOperationOptions

Opsi untuk deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState

Representasi publik dari status operasi DeleteCertificatePoller.
DeleteContactsOptions

Opsi untuk deleteContacts(OperationOptions).
DeleteIssuerOptions

Opsi untuk deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi.
<xref:KnownDeletionRecoveryLevel> dapat digunakan secara bergantian dengan DeletionRecoveryLevel, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

dapat dibersihkan: Menunjukkan status vault di mana penghapusan adalah operasi yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Tingkat ini sesuai dengan tidak ada perlindungan yang tersedia terhadap operasi Hapus; data hilang secara tidak dapat diambil setelah menerima operasi Hapus di tingkat entitas atau yang lebih tinggi (vault, grup sumber daya, langganan, dll.)
Recoverable+Purgeable: Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari), kecuali operasi Pembersihan diminta, atau langganan dibatalkan. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
yang Dapat Dipulihkan : Menunjukkan status brankas di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu penghapusan menyeluruh). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari) dan saat langganan masih tersedia. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+ProtectedSubscription: Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan dalam interval penyimpanan (90 hari), penghapusan segera dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
CustomizedRecoverable+Purgeable: Menunjukkan status brankas di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan saat 7 <= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, kecuali jika operasi Pembersihan diminta, atau langganan dibatalkan.
CustomizedRecoverable: Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu hapus menyeluruh saat 7 <= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi dan saat langganan masih tersedia.
CustomizedRecoverable+ProtectedSubscription: Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan, segera dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen ketika 7 <= SoftDeleteRetentionInDays < 90. Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, dan juga mencerminkan fakta bahwa langganan itu sendiri tidak dapat dibatalkan.
GetCertificateOperationOptions

Opsi untuk getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions

Opsi untuk getCertificate(string, OperationOptions).
GetCertificatePolicyOptions

Opsi untuk getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions

Opsi untuk getCertificateVersion(string, string, OperationOptions).
GetContactsOptions

Opsi untuk getContacts(OperationOptions).
GetDeletedCertificateOptions

Opsi untuk getDeletedCertificate(string, OperationOptions).
GetIssuerOptions

Opsi untuk getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions

Opsi untuk <xref:getPlainCertificateOperation>.
ImportCertificatePolicy

Jenis yang mewakili kebijakan sertifikat untuk impor yang tidak memerlukan SAN atau Subjek
KVPollerLike

Salinan KeyVault yang tidak digunakan lagi dari PollerLike core-lro.
KeyUsageType

Penggunaan kunci sertifikat yang didukung.
<xref:KnownKeyUsageType> dapat digunakan secara bergantian dengan KeyUsageType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

digitalSignature: Menunjukkan bahwa kunci sertifikat dapat digunakan sebagai tanda tangan digital.
nonRepudiation : Menunjukkan bahwa kunci sertifikat dapat digunakan untuk autentikasi.
keyEncipherment: Menunjukkan bahwa kunci sertifikat dapat digunakan untuk enkripsi kunci.
dataEncipherment: Menunjukkan bahwa kunci sertifikat dapat digunakan untuk enkripsi data.
keyAgreement: Menunjukkan bahwa kunci sertifikat dapat digunakan untuk menentukan perjanjian kunci, seperti kunci yang dibuat menggunakan algoritma perjanjian kunci Diffie-Hellman.
keyCertSign: Menunjukkan bahwa kunci sertifikat dapat digunakan untuk menandatangani sertifikat.
cRLSign: Menunjukkan bahwa kunci sertifikat dapat digunakan untuk menandatangani daftar pencabutan sertifikat.
encipherOnly: Menunjukkan bahwa kunci sertifikat hanya dapat digunakan untuk enkripsi.
decipherOnly: Menunjukkan bahwa kunci sertifikat hanya dapat digunakan untuk dekripsi.
ListPropertiesOfCertificateVersionsOptions

Antarmuka yang mewakili parameter opsional untuk operasi halaman CertificateClient diteruskan ke listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions

Antarmuka yang mewakili parameter opsional untuk operasi halaman CertificateClient diteruskan ke listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions

Antarmuka yang mewakili parameter opsional untuk mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions

Opsi untuk purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState

Tidak digunakan lagi: Representasi publik tentang pemulihan operasi polling sertifikat yang dihapus
RequireAtLeastOne

RequireAtLeastOne membantu membuat jenis di mana setidaknya salah satu properti antarmuka (dapat berupa properti apa pun) diperlukan untuk ada.

Ini berfungsi karena jenis utilitas TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Mari kita periksa:

  • [K in keyof T]-? properti ini (K) hanya valid jika memiliki nama yang sama dengan properti T apa pun.
  • Required<Pick<T, K>> membuat jenis baru dari T hanya dengan properti saat ini dalam iterasi, dan menandainya sebagaimana diperlukan
  • Partial<Pick<T, Exclude<keyof T, K>>> membuat jenis baru dengan semua properti T, kecuali dari properti K.
  • & adalah apa yang menyatukan jenis dengan hanya satu properti yang diperlukan dari Required<...> dengan semua properti opsional dari Partial<...>.
  • [keyof T] memastikan bahwa hanya properti T yang diizinkan.
RestoreCertificateBackupOptions

Antarmuka yang mewakili parameter opsional untuk restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions

Opsi untuk setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames

Alternatif untuk properti subjek. Jika ada, setidaknya harus memiliki salah satu properti SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions

Opsi untuk updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Enum

KnownCertificateKeyCurveNames

Nilai yang diketahui dari CertificateKeyCurveName yang diterima layanan.
KnownCertificateKeyTypes

Nilai yang diketahui dari CertificateKeyType yang diterima layanan.
KnownDeletionRecoveryLevels

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi.
KnownKeyUsageTypes

Nilai yang diketahui dari KeyUsageType yang diterima layanan.
WellKnownIssuer

Penerbit terkenal untuk memilih default

Fungsi

parseKeyVaultCertificateIdentifier(string)

Mengurai Id Sertifikat Key Vault yang diberikan. Contohnya adalah:

https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id>

Pada penguraian Id di atas, fungsi ini mengembalikan:

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

Variabel

DefaultCertificatePolicy

DefaultCertificatePolicy mengekspor nilai yang berguna sebagai parameter default ke metode yang memodifikasi kebijakan sertifikat.
logger

Konfigurasi @azure/logger untuk paket ini.

Detail Fungsi

parseKeyVaultCertificateIdentifier(string)

Mengurai Id Sertifikat Key Vault yang diberikan. Contohnya adalah:

https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id>

Pada penguraian Id di atas, fungsi ini mengembalikan:

  {
     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

Parameter

id

string

Id Sertifikat Key Vault.

Mengembalikan

KeyVaultCertificateIdentifier

Variable Details

DefaultCertificatePolicy

DefaultCertificatePolicy mengekspor nilai yang berguna sebagai parameter default ke metode yang memodifikasi kebijakan sertifikat.

DefaultCertificatePolicy: { issuerName: string, subject: string }

Jenis

{ issuerName: string, subject: string }

logger

Konfigurasi @azure/logger untuk paket ini.

logger: AzureLogger

Jenis

AzureLogger