@azure/keyvault-keys package
Kelas
| CryptographyClient |
Klien yang digunakan untuk melakukan operasi kriptografi pada kunci Azure Key vault atau <xref:JsonWebKey>lokal . |
| KeyClient |
KeyClient menyediakan metode untuk mengelola <xref:KeyVaultKey> di Azure Key Vault. Klien mendukung pembuatan, pengambilan, pembaruan, penghapusan, pembersihan, pencadangan, pemulihan, dan daftar KeyVaultKeys. Klien juga mendukung daftar <xref: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 <xref:backupKey>. |
| BeginDeleteKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:beginDeleteKey> |
| BeginRecoverDeletedKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:beginRecoverDeletedKey> |
| CreateEcKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:createEcKey> |
| CreateKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:createKey> |
| CreateOctKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:createOctKey> |
| CreateRsaKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:createRsaKey> |
| CryptographyClientOptions |
Parameter opsional yang diterima oleh CryptographyClient KeyVault |
| CryptographyOptions |
Antarmuka yang mewakili opsi metode API kriptografi, buka <xref:CryptographyClient> untuk informasi selengkapnya. |
| DecryptOptions |
Opsi untuk <xref:decrypt>. |
| DecryptResult |
Hasil operasi <xref:decrypt>. |
| DeletedKey |
Antarmuka yang mewakili Kunci Key Vault yang dihapus. |
| EncryptOptions |
Opsi untuk <xref:encrypt>. |
| EncryptResult |
Hasil operasi <xref:encrypt>. |
| GetDeletedKeyOptions |
Opsi untuk <xref:getDeletedKey>. |
| GetKeyOptions |
Opsi untuk <xref:getKey>. |
| ImportKeyOptions |
Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:importKey> |
| 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 <xref:beginDeleteKey> dan <xref:beginRecoverDeletedKey> |
| KeyProperties |
Antarmuka yang mewakili Properti <xref:KeyVaultKey> |
| KeyVaultKey |
Antarmuka yang mewakili Kunci Key Vault, dengan nama, nilai, dan <xref:KeyProperties>. |
| KeyVaultKeyIdentifier |
Mewakili segmen yang menyusun Id Kunci Key Vault. |
| ListDeletedKeysOptions |
Antarmuka yang mewakili parameter opsional untuk operasi halaman KeyClient diteruskan ke <xref:listDeletedKeys>. |
| ListPropertiesOfKeyVersionsOptions |
Antarmuka yang mewakili parameter opsional untuk operasi halaman KeyClient diteruskan ke <xref:listPropertiesOfKeyVersions>. |
| ListPropertiesOfKeysOptions |
Antarmuka yang mewakili parameter opsional untuk operasi halaman KeyClient diteruskan ke <xref:listPropertiesOfKeys>. |
| PurgeDeletedKeyOptions |
Opsi untuk <xref:purgeDeletedKey>. |
| RestoreKeyBackupOptions |
Opsi untuk <xref:restoreKeyBackup>. |
| RsaDecryptParameters |
Parameter dekripsi untuk algoritma enkripsi RSA. |
| RsaEncryptParameters |
Parameter enkripsi untuk algoritma enkripsi RSA. |
| SignOptions |
Opsi untuk <xref:sign>. |
| SignResult |
Hasil operasi <xref:sign>. |
| UnwrapKeyOptions |
Opsi untuk <xref:unwrapKey>. |
| UnwrapResult |
Hasil operasi <xref:unwrap>. |
| UpdateKeyPropertiesOptions |
Opsi untuk <xref:updateKeyProperties>. |
| VerifyDataOptions |
Opsi untuk <xref:verifyData> |
| VerifyOptions |
Opsi untuk <xref:verify>. |
| VerifyResult |
Hasil operasi <xref:verify>. |
| WrapKeyOptions |
Opsi untuk <xref:wrapKey>. |
| 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 |
Menentukan nilai untuk DeletionRecoveryLevel. Mengetahui nilai yang 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 karena berlaku untuk algoritma enkripsi yang berbeda. |
| EncryptionAlgorithm |
Menentukan nilai untuk JsonWebKeyEncryptionAlgorithm. Mengetahui nilai yang didukung oleh layanan
RSA-OAEP |
| KeyCurveName |
Menentukan nilai untuk JsonWebKeyCurveName. Mengetahui nilai yang didukung oleh layanan
P-256: Kurva elips NIST P-256, kurva AKA SECG SECP256R1. |
| KeyOperation |
Menentukan nilai untuk JsonWebKeyOperation. Mengetahui nilai yang didukung oleh layanan
mengenkripsi |
| KeyType |
Menentukan nilai untuk JsonWebKeyType. Mengetahui nilai yang didukung oleh layanan
EC: 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. Mengetahui nilai yang 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 <xref:DeletionRecoveryLevel> yang diketahui yang diterima layanan. |
| KnownEncryptionAlgorithms |
Nilai <xref:JsonWebKeyEncryptionAlgorithm> yang diketahui yang diterima layanan. |
| KnownKeyCurveNames |
Nilai <xref:JsonWebKeyCurveName> yang diketahui yang diterima layanan. |
| KnownKeyOperations |
Nilai <xref:JsonWebKeyOperation> yang diketahui yang diterima layanan. |
| KnownKeyTypes |
Nilai <xref:JsonWebKeyType> yang diketahui yang diterima layanan. |
| KnownSignatureAlgorithms |
Nilai <xref:JsonWebKeySignatureAlgorithm> yang diketahui yang diterima layanan. |
Fungsi
| parse |
Mengurai ID Kunci Vault Kunci yang diberikan. Contohnya adalah: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id> Pada penguraian Id di atas, fungsi ini mengembalikan:
|
Detail Fungsi
parseKeyVaultKeyIdentifier(string)
Mengurai ID Kunci Vault Kunci 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)
Parameter
- id
-
string
Id Kunci Key Vault.