@azure/keyvault-keys package

Referensi

Kelas

CryptographyClient	Klien yang digunakan untuk melakukan operasi kriptografi pada kunci brankas Azure Key atau JsonWebKey lokal.
KeyClient	KeyClient menyediakan metode untuk mengelola KeyVaultKey di Azure Key Vault. Klien mendukung pembuatan, pengambilan, pembaruan, penghapusan, penghapusan menyeluruh, mencadangkan, memulihkan, dan mencantumkan KeyVaultKeys. Klien juga mendukung daftar DeletedKey untuk Key Vault Azure 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 KriptografiClient untuk informasi selengkapnya.
DecryptOptions	Opsi untuk decrypt(DecryptParameters, DecryptOptions).
DecryptResult	decrypt(DecryptParameters, DecryptOptions) Hasil operasi.
DeletedKey	Antarmuka yang mewakili Kunci Key Vault yang dihapus.
EncryptOptions	Opsi untuk encrypt(EncryptParameters, EncryptOptions).
EncryptResult	encrypt(EncryptParameters, EncryptOptions) Hasil operasi.
GetCryptographyClientOptions	Opsi untuk getCryptographyClient.
GetDeletedKeyOptions	Opsi untuk getDeletedKey(string, GetDeletedKeyOptions).
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_2, ImportKeyOptions)
JsonWebKey	Pada http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
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 yang termasuk dalam kunci.
KeyRotationPolicyProperties	Properti kebijakan rotasi kunci yang dapat ditetapkan 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 namanya, 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	sign(string, Uint8Array, SignOptions) Hasil operasi.
UnwrapKeyOptions	Opsi untuk unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	<xref:unwrap> Hasil operasi.
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	verify(string, Uint8Array, Uint8Array, VerifyOptions) Hasil operasi.
WrapKeyOptions	Opsi untuk wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	<xref:wrap> Hasil operasi.

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 saat berlaku untuk algoritma enkripsi yang berbeda.
DeletionRecoveryLevel	Menentukan nilai untuk DeletionRecoveryLevel. 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.) Dapat Dipulihkan+Dapat Dibersihkan: Menunjukkan status brankas tempat penghapusan dapat dipulihkan, dan yang juga memungkinkan 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 akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan Dapat dipulihkan: Menunjukkan status vault 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 akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan Recoverable+ProtectedSubscription: Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan dalam interval retensi (90 hari), penghapusan segera dan permanen (yaitu penghapusan menyeluruh) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan CustomizedRecoverable+Purgeable: Menunjukkan status vault tempat penghapusan dapat dipulihkan, dan yang juga memungkinkan penghapusan segera dan permanen (yaitu hapus menyeluruh saat 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, kecuali 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 ketika 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, penghapusan langsung dan permanen (yaitu penghapusan menyeluruh) 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 saat berlaku untuk algoritma enkripsi yang berbeda.
EncryptionAlgorithm	Menentukan nilai untuk JsonWebKeyEncryptionAlgorithm. <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 RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	Menentukan nilai untuk 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 SECG SECP256K1.
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	Menentukan nilai untuk 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 mendeskripsi sign Memverifikasi wrapKey unwrapKey impor ekspor
KeyRotationPolicyAction	Tindakan yang akan dijalankan.
KeyType	Menentukan nilai untuk JsonWebKeyType. <xref:KnownJsonWebKeyType> dapat digunakan secara bergantian dengan JsonWebKeyType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Kurva Elips. EC-HSM: Kurva Elips dengan kunci privat yang disimpan di HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA dengan kunci privat yang disimpan di HSM. okt: Urutan oktet (digunakan untuk mewakili kunci konten) oct-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	Menentukan nilai untuk 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 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	Nilai Yang diketahui dari DeletionRecoveryLevel yang diterima layanan.
KnownEncryptionAlgorithms	Nilai yang diketahui dari EncryptionAlgorithm yang diterima layanan.
KnownKeyCurveNames	Nilai yang diketahui dari <xref:JsonWebKeyCurveName> yang diterima layanan.
KnownKeyExportEncryptionAlgorithm	Nilai keyExportEncryptionAlgorithm yang diketahui yang diterima layanan.
KnownKeyOperations	Nilai KeyOperation yang diketahui yang diterima layanan.
KnownKeyTypes	Nilai yang diketahui dari <xref:JsonWebKeyType> yang diterima layanan.
KnownSignatureAlgorithms	Nilai yang diketahui dari <xref:JsonWebKeySignatureAlgorithm> yang diterima layanan.

Fungsi

parseKeyVaultKeyIdentifier(string)

Mengurai Id Kunci Key Vault yang diberikan. Contohnya adalah:

https://.vault.azure.net/keys//

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

Detail Fungsi

parseKeyVaultKeyIdentifier(string)

Mengurai Id Kunci Key Vault yang diberikan. Contohnya adalah:

https://.vault.azure.net/keys//

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

@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

Detail Fungsi

parseKeyVaultKeyIdentifier(string)

Parameter

Mengembalikan

Sumber Daya Tambahan: