@azure/keyvault-keys package
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. 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.) |
EncryptParameters |
Jenis yang mewakili semua parameter enkripsi yang saat ini didukung saat berlaku untuk algoritma enkripsi yang berbeda. |
EncryptionAlgorithm |
Menentukan nilai untuk JsonWebKeyEncryptionAlgorithm. Nilai yang diketahui didukung oleh layanan
RSA-OAEP |
KeyCurveName |
Menentukan nilai untuk JsonWebKeyCurveName. Nilai yang diketahui didukung oleh layanan
P-256: Kurva elips NIST P-256, kurva AKA SECG SECP256R1. |
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 |
KeyOperation |
Menentukan nilai untuk JsonWebKeyOperation. Nilai yang diketahui didukung oleh layanan
mengenkripsi |
KeyRotationPolicyAction |
Tindakan yang akan dijalankan. |
KeyType |
Menentukan nilai untuk JsonWebKeyType. Nilai yang diketahui didukung oleh layanan
Kurva Elips. |
KeyWrapAlgorithm |
Algoritma yang didukung untuk pembungkusan/pembungkusan kunci |
RsaEncryptionAlgorithm |
Jenis serikat yang mewakili semua algoritma enkripsi RSA yang didukung. |
SignatureAlgorithm |
Menentukan nilai untuk JsonWebKeySignatureAlgorithm. 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 |
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
parse |
Mengurai Id Kunci Key Vault yang diberikan. Contohnya adalah: https://.vault.azure.net/keys// Pada penguraian Id di atas, fungsi ini mengembalikan:
|
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.