@azure/keyvault-keys package

Kelas

CryptographyClient	Klien yang digunakan untuk melakukan operasi kriptografi pada kunci Azure Key vault atau lokal JsonWebKey.
KeyClient	KeyClient menyediakan metode untuk mengelola KeyVaultKey di Azure Key Vault. Klien mendukung pembuatan, pengambilan, pembaruan, penghapusan, pembersihan, pencadangan, pemulihan, dan daftar KeyVaultKeys. Klien juga mendukung daftar DeletedKey untuk Azure Key Vault yang diaktifkan penghapusan sementara.

Antarmuka

AesCbcDecryptParameters	Parameter dekripsi untuk algoritma enkripsi AES-CBC.
AesCbcEncryptParameters	Parameter enkripsi untuk algoritma enkripsi AES-CBC.
AesGcmDecryptParameters	Parameter dekripsi untuk algoritma enkripsi AES-GCM.
AesGcmEncryptParameters	Parameter enkripsi untuk algoritma enkripsi AES-GCM.
BackupKeyOptions	Opsi untuk backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	Parameter opsional yang diterima oleh CryptographyClient KeyVault
CryptographyOptions	Antarmuka yang mewakili opsi metode API kriptografi, buka CryptographyClient untuk informasi selengkapnya.
DecryptOptions	Opsi untuk decrypt(DecryptParameters, DecryptOptions).
DecryptResult	Hasil operasi decrypt(DecryptParameters, DecryptOptions).
DeletedKey	Antarmuka yang mewakili Kunci Key Vault yang dihapus.
EncryptOptions	Opsi untuk encrypt(EncryptParameters, EncryptOptions).
EncryptResult	Hasil operasi encrypt(EncryptParameters, EncryptOptions).
GetCryptographyClientOptions	Opsi untuk getCryptographyClient.
GetDeletedKeyOptions	Opsi untuk getDeletedKey(string, GetDeletedKeyOptions).
GetKeyAttestationOptions	Opsi untuk getKeyAttestation(string, GetKeyAttestationOptions).
GetKeyOptions	Opsi untuk getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions	Opsi untuk <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions	Opsi untuk getRandomBytes
ImportKeyOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke importKey(string, JsonWebKey, ImportKeyOptions)
JsonWebKey	Pada http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyAttestation	Antarmuka yang mewakili properti pengesahan kunci
KeyClientOptions	Parameter opsional yang diterima oleh KeyClient KeyVault
KeyPollerOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginDeleteKey(string, BeginDeleteKeyOptions) dan beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	Antarmuka yang mewakili Properti KeyVaultKey
KeyReleasePolicy	Aturan kebijakan tempat kunci dapat diekspor.
KeyRotationLifetimeAction	Tindakan dan pemicu yang sesuai yang akan dilakukan oleh Key Vault selama masa pakai kunci.
KeyRotationPolicy	Kebijakan rotasi kunci lengkap milik kunci.
KeyRotationPolicyProperties	Properti kebijakan rotasi kunci yang dapat diatur klien untuk kunci tertentu. Anda juga dapat mengatur ulang kebijakan rotasi kunci ke nilai defaultnya dengan mengatur lifetimeActions ke array kosong.
KeyVaultKey	Antarmuka yang mewakili Key Vault Key, dengan nama, nilai, dan KeyProperties.
KeyVaultKeyIdentifier	Mewakili segmen yang menyusun Id Kunci Key Vault.
ListDeletedKeysOptions	Antarmuka yang mewakili parameter opsional untuk operasi halaman KeyClient diteruskan ke listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	Antarmuka yang mewakili parameter opsional untuk operasi halaman KeyClient diteruskan ke listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	Antarmuka yang mewakili parameter opsional untuk operasi halaman KeyClient diteruskan ke listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	Antarmuka yang melacak pengaturan untuk iterasi halaman
PagedAsyncIterableIterator	Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman.
PollOperationState	PollOperationState berisi daftar berpendapat dari sekumpulan properti terkecil yang diperlukan untuk menentukan poller operasi yang berjalan lama. Sementara kelas Poller berfungsi sebagai mekanisme kontrol lokal untuk mulai memicu, menunggu, dan berpotensi membatalkan operasi yang berjalan lama, PollOperationState mencocokkan status operasi jangka panjang jarak jauh. Ini harus diperbarui setidaknya ketika operasi dimulai, ketika selesai, dan ketika dibatalkan. Meskipun, implementasi dapat memiliki sejumlah properti lain yang dapat diperbarui dengan alasan lain.
PollerLike	Representasi abstrak dari poller, dimaksudkan untuk mengekspos api minimal yang perlu dikerjakan pengguna.
PurgeDeletedKeyOptions	Opsi untuk purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions	Opsi untuk releaseKey
ReleaseKeyResult	Hasil operasi releaseKey .
RestoreKeyBackupOptions	Opsi untuk restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	Opsi untuk rotateKey
RsaDecryptParameters	Parameter dekripsi untuk algoritma enkripsi RSA.
RsaEncryptParameters	Parameter enkripsi untuk algoritma enkripsi RSA.
SignOptions	Opsi untuk sign(string, Uint8Array, SignOptions).
SignResult	Hasil operasi sign(string, Uint8Array, SignOptions).
UnwrapKeyOptions	Opsi untuk unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	Hasil operasi <xref:unwrap>.
UpdateKeyPropertiesOptions	Opsi untuk updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions	Opsi untuk updateKeyRotationPolicy
VerifyDataOptions	Opsi untuk verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions	Opsi untuk verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult	Hasil operasi verify(string, Uint8Array, Uint8Array, VerifyOptions).
WrapKeyOptions	Opsi untuk wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	Hasil operasi <xref:wrap>.

Alias Jenis

AesCbcEncryptionAlgorithm	Jenis serikat yang mewakili semua algoritma enkripsi AES-CBC yang didukung.
AesGcmEncryptionAlgorithm	Jenis serikat yang mewakili semua algoritma enkripsi AES-GCM yang didukung.
DecryptParameters	Jenis yang mewakili semua parameter dekripsi yang saat ini didukung karena berlaku untuk algoritma enkripsi yang berbeda.
DeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk sertifikat di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', sertifikat dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh sertifikat, di akhir interval retensi. 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.
EncryptParameters	Jenis yang mewakili semua parameter enkripsi yang saat ini didukung karena berlaku untuk algoritma enkripsi yang berbeda.
EncryptionAlgorithm	Algoritma yang digunakan untuk enkripsi dan dekripsi. <xref:KnownJsonWebKeyEncryptionAlgorithm> dapat digunakan secara bergantian dengan JsonWebKeyEncryptionAlgorithm, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan RSA-OAEP: [Tidak disarankan] RSAES menggunakan Padding Enkripsi Asimetris Optimal (OAEP), seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc3447, dengan parameter default yang ditentukan oleh RFC 3447 di Bagian A.2.1. Parameter default tersebut menggunakan fungsi hash SHA-1 dan fungsi pembuatan masker MGF1 dengan SHA-1. Microsoft merekomendasikan penggunaan RSA_OAEP_256 atau algoritma yang lebih kuat untuk keamanan yang ditingkatkan. Microsoft tidak tidak merekomendasikan RSA_OAEP, yang hanya disertakan untuk kompatibilitas mundur. RSA_OAEP menggunakan SHA1, yang memiliki masalah tabrakan yang diketahui. RSA-OAEP-256: RSAES menggunakan Padding Enkripsi Asimetris Optimal dengan fungsi hash SHA-256 dan fungsi pembuatan mask MGF1 dengan SHA-256. RSA1_5: [Tidak disarankan] RSAES- enkripsi kunciPKCS1-V1_5, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc3447. Microsoft merekomendasikan penggunaan RSA_OAEP_256 atau algoritma yang lebih kuat untuk keamanan yang ditingkatkan. Microsoft tidak tidak merekomendasikan RSA_1_5, yang hanya disertakan untuk kompatibilitas mundur. Standar kriptografi tidak lagi mempertimbangkan RSA dengan skema padding PKCS#1 v1.5 yang aman untuk enkripsi. A128GCM: AES-GCM 128-bit. A192GCM: AES-GCM 192-bit. A256GCM: AES-GCM 256-bit. A128KW: bungkus kunci AES 128-bit. A192KW: bungkus kunci AES 192-bit. A256KW: Bungkus kunci AES 256-bit. A128CBC: AES-CBC 128-bit. A192CBC: AES-CBC 192-bit. A256CBC: AES-CBC 256-bit. A128CBCPAD: 128-bit AES-CBC dengan padding PKCS. A192CBCPAD: AES-CBC 192-bit dengan padding PKCS. A256CBCPAD: AES-CBC 256-bit dengan padding PKCS. CKM_AES_KEY_WRAP: Bungkus kunci AES CKM. CKM_AES_KEY_WRAP_PAD: Bungkus kunci AES CKM dengan padding.
KeyCurveName	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.
KeyExportEncryptionAlgorithm	Menentukan nilai untuk KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm dapat digunakan secara bergantian dengan KeyEncryptionAlgorithm, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	Operasi kunci web JSON. Untuk informasi selengkapnya, lihat JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> dapat digunakan secara bergantian dengan JsonWebKeyOperation, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan mengenkripsi: Menunjukkan bahwa kunci dapat digunakan untuk mengenkripsi. mendekripsi: Menunjukkan bahwa kunci dapat digunakan untuk mendekripsi. menandatangani: Menunjukkan bahwa kunci dapat digunakan untuk menandatangani. memverifikasi: Menunjukkan bahwa kunci dapat digunakan untuk memverifikasi. wrapKey: Menunjukkan bahwa kunci dapat digunakan untuk membungkus kunci lain. unwrapKey: Menunjukkan bahwa kunci dapat digunakan untuk membongkar kunci lain. mengimpor: Menunjukkan bahwa kunci dapat diimpor selama pembuatan. ekspor: Menunjukkan bahwa komponen privat kunci dapat diekspor.
KeyRotationPolicyAction	Tindakan yang akan dijalankan.
KeyType	Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. <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 disimpan di HSM. RSA : RSA () RSA-HSM: RSA dengan kunci privat yang disimpan di HSM. okt : Urutan oktet (digunakan untuk mewakili kunci konten) okt-HSM : Urutan oktet (digunakan untuk mewakili kunci konten) yang disimpan HSM.
KeyWrapAlgorithm	Algoritma yang didukung untuk pembungkusan/pembungkusan kunci
RsaEncryptionAlgorithm	Jenis serikat yang mewakili semua algoritma enkripsi RSA yang didukung.
SignatureAlgorithm	Pengidentifikasi algoritma penandatanganan/verifikasi. Untuk informasi selengkapnya tentang kemungkinan jenis algoritma, lihat JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> dapat digunakan secara bergantian dengan JsonWebKeySignatureAlgorithm, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan PS256: RSASSA-PSS menggunakan SHA-256 dan MGF1 dengan SHA-256, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS menggunakan SHA-384 dan MGF1 dengan SHA-384, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS menggunakan SHA-512 dan MGF1 dengan SHA-512, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 menggunakan SHA-256, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 menggunakan SHA-384, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 menggunakan SHA-512, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 HS256: HMAC menggunakan SHA-256, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 HS384: HMAC menggunakan SHA-384, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 HS512: HMAC menggunakan SHA-512, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 RSNULL : Dicadangkan ES256: ECDSA menggunakan P-256 dan SHA-256, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518. ES384: ECDSA menggunakan P-384 dan SHA-384, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 ES512: ECDSA menggunakan P-521 dan SHA-512, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518 ES256K: ECDSA menggunakan P-256K dan SHA-256, seperti yang dijelaskan dalam https://tools.ietf.org/html/rfc7518

Enum

KnownDeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk sertifikat di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', sertifikat dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh sertifikat, di akhir interval retensi.
KnownEncryptionAlgorithms	Algoritma yang digunakan untuk enkripsi dan dekripsi.
KnownKeyCurveNames	Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	Algoritma enkripsi yang digunakan untuk melindungi materi kunci yang diekspor
KnownKeyOperations	Nilai yang diketahui dari KeyOperation yang diterima layanan.
KnownKeyTypes	Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KnownSignatureAlgorithms	Pengidentifikasi algoritma penandatanganan/verifikasi. Untuk informasi selengkapnya tentang kemungkinan jenis algoritma, lihat JsonWebKeySignatureAlgorithm.

Fungsi

parseKeyVaultKeyIdentifier(string)

Mengurai Id Kunci Key Vault yang diberikan. Contohnya adalah:

https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

Pada penguraian Id di atas, fungsi ini mengembalikan:

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

Variabel

logger

Konfigurasi @azure/logger untuk paket ini.

Detail Fungsi

parseKeyVaultKeyIdentifier(string)

Mengurai Id Kunci Key Vault yang diberikan. Contohnya adalah:

https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

Pada penguraian Id di atas, fungsi ini mengembalikan:

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

function parseKeyVaultKeyIdentifier(id: string): KeyVaultKeyIdentifier

Parameter

id: string

Id Kunci Key Vault.

Mengembalikan

KeyVaultKeyIdentifier

Variable Details

logger

Konfigurasi @azure/logger untuk paket ini.

logger: AzureLogger

Jenis

AzureLogger

Bagikan melalui

@azure/keyvault-keys package

Kelas

Antarmuka

Alias Jenis

Nilai yang diketahui didukung oleh layanan

Nilai yang diketahui didukung oleh layanan

Nilai yang diketahui didukung oleh layanan

Nilai yang diketahui didukung oleh layanan

Nilai yang diketahui didukung oleh layanan

Nilai yang diketahui didukung oleh layanan

Nilai yang diketahui didukung oleh layanan

Enum

Fungsi

Variabel

Detail Fungsi

parseKeyVaultKeyIdentifier(string)

Parameter

Mengembalikan

Variable Details

logger

Jenis