Bagikan melalui


@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.
<xref:KnownDeletionRecoveryLevel> dapat digunakan secara bergantian dengan DeletionRecoveryLevel, enum ini berisi nilai yang diketahui yang didukung layanan.

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.)
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 vault 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 brankas dan langganan di mana penghapusan dapat dipulihkan, segera 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 karena 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.

Mengetahui nilai yang 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.

Mengetahui nilai yang 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.

KeyOperation

Menentukan nilai untuk JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> dapat digunakan secara bergantian dengan JsonWebKeyOperation, enum ini berisi nilai yang diketahui yang didukung layanan.

Mengetahui nilai yang didukung oleh layanan

mengenkripsi
mendekripsi
tanda tangan
memverifikasi
wrapKey
unwrapKey
impor

KeyType

Menentukan nilai untuk JsonWebKeyType.
<xref:KnownJsonWebKeyType> dapat digunakan secara bergantian dengan JsonWebKeyType, enum ini berisi nilai yang diketahui yang didukung layanan.

Mengetahui nilai yang didukung oleh layanan

EC: Kurva Elips.
EC-HSM: Kurva Elips dengan kunci privat yang tidak dapat diekspor dari HSM.
RSA : RSA ()
RSA-HSM: RSA dengan kunci privat yang tidak dapat diekspor dari HSM.
okt : Urutan oktet (digunakan untuk mewakili kunci konten)
okt-HSM : Urutan oktet (digunakan untuk mewakili kunci konten) yang tidak dapat diekspor dari 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.

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

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

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.

Mengembalikan