@azure/keyvault-keys package
Osztályok
| CryptographyClient |
Az Azure Key Vault-kulcson vagy egy helyi JsonWebKey-en végzett titkosítási műveletekhez használt ügyfél. |
| KeyClient |
A KeyClient metódusokat biztosít a KeyVaultKey azure-Key Vault való kezeléséhez. Az ügyfél támogatja a KeyVaultKeys létrehozását, lekérését, frissítését, törlését, törlését, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél a helyreállítható törlést engedélyező Azure-Key Vault is támogatja a DeletedKey listázását. |
Interfészek
| AesCbcDecryptParameters |
Az AES-CBC titkosítási algoritmusok visszafejtési paraméterei. |
| AesCbcEncryptParameters |
Az AES-CBC titkosítási algoritmusok titkosítási paraméterei. |
| AesGcmDecryptParameters |
Az AES-GCM titkosítási algoritmusok visszafejtési paraméterei. |
| AesGcmEncryptParameters |
Az AES-GCM titkosítási algoritmusok titkosítási paraméterei. |
| BackupKeyOptions |
A beállítások a következőhöz: backupKey(string, BackupKeyOptions). |
| BeginDeleteKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginDeleteKey(string, BeginDeleteKeyOptions) |
| BeginRecoverDeletedKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| CreateEcKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: createEcKey(string, CreateEcKeyOptions) |
| CreateKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: createKey(string, string, CreateKeyOptions) |
| CreateOctKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: createOctKey(string, CreateOctKeyOptions) |
| CreateRsaKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: createRsaKey(string, CreateRsaKeyOptions) |
| CryptographyClientOptions |
A KeyVault CryptographyClient által elfogadott választható paraméterek |
| CryptographyOptions |
A kriptográfiai API-metódusok lehetőségeit képviselő felületről további információt a TitkosításClient webhelyen talál. |
| DecryptOptions |
A beállítások a következőhöz: decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
A decrypt(DecryptParameters, DecryptOptions) művelet eredménye. |
| DeletedKey |
Törölt Key Vault kulcsot jelképező felület. |
| EncryptOptions |
A beállítások a következőhöz: encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
A encrypt(EncryptParameters, EncryptOptions) művelet eredménye. |
| GetCryptographyClientOptions |
A getCryptographyClient beállításai. |
| GetDeletedKeyOptions |
A beállítások a következőhöz: getDeletedKey(string, GetDeletedKeyOptions). |
| GetKeyOptions |
A beállítások a következőhöz: getKey(string, GetKeyOptions). |
| GetKeyRotationPolicyOptions |
Beállítások a következőhöz: <xref:KeyClient.getRotationPolicy> |
| GetRandomBytesOptions |
A getRandomBytes beállításai |
| ImportKeyOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: importKey(string, JsonWebKey_2, ImportKeyOptions) |
| JsonWebKey |
A http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
A KeyVault KeyClient által elfogadott választható paraméterek |
| KeyPollerOptions |
Egy interfész, amely az opcionális paramétereket jelöli, amelyek átadhatók a és a beginDeleteKey(string, BeginDeleteKeyOptions)beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| KeyProperties |
A KeyVaultKey tulajdonságait képviselő felület |
| KeyReleasePolicy |
Azok a szabályzatszabályok, amelyek alapján a kulcs exportálható. |
| KeyRotationLifetimeAction |
Egy művelet és annak megfelelő eseményindítója, amelyet Key Vault hajt végre egy kulcs élettartama során. |
| KeyRotationPolicy |
A kulcshoz tartozó teljes kulcsrotálási szabályzat. |
| KeyRotationPolicyProperties |
Egy kulcsrotálási szabályzat tulajdonságai, amelyeket az ügyfél beállíthat egy adott kulcshoz. A kulcsrotálási szabályzatot visszaállíthatja az alapértelmezett értékre is, ha a lifetimeActions értéket üres tömbre állítja. |
| KeyVaultKey |
Egy Key Vault kulcsot jelképező felület, amelynek neve, értéke és KeyProperties értéke. |
| KeyVaultKeyIdentifier |
A Key Vault kulcsazonosítót alkotó szegmenseket jelöli. |
| ListDeletedKeysOptions |
A KeyClient lapozott műveleteinek opcionális paramétereit képviselő felület, amely a következőnek listDeletedKeys(ListDeletedKeysOptions)lett átadva: . |
| ListPropertiesOfKeyVersionsOptions |
A KeyClient lapozott műveleteinek opcionális paramétereit képviselő felület, amely a következőnek listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)lett átadva: . |
| ListPropertiesOfKeysOptions |
A KeyClient lapozott műveleteinek opcionális paramétereit képviselő felület, amely a következőnek listPropertiesOfKeys(ListPropertiesOfKeysOptions)lett átadva: . |
| PageSettings |
Egy felület, amely nyomon követi a lapozott iteráció beállításait |
| PagedAsyncIterableIterator |
Egy felület, amely lehetővé teszi az aszinkron iterációt mind a befejezésig, mind az oldal szerint. |
| PollOperationState |
A PollOperationState a hosszú ideig futó művelet pollerének definiálásához szükséges legkisebb tulajdonságkészlet véleményezett listáját tartalmazza. Bár a Poller osztály helyi vezérlő mechanizmusként működik egy hosszú ideig futó művelet elindításához, várakozásához és esetleges megszakításához, a PollOperationState dokumentálja a távoli hosszú ideig futó művelet állapotát. Frissíteni kell legalább a művelet indításakor, befejezésekor és megszakításakor. Az implementációk azonban bármilyen más okból frissíthető tulajdonsággal rendelkezhetnek. |
| PollerLike |
A poller absztrakt ábrázolása, amelynek célja, hogy a felhasználónak csak a minimális API-t tegye elérhetővé. |
| PurgeDeletedKeyOptions |
A beállítások a következőhöz: purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
A releaseKey beállításai |
| ReleaseKeyResult |
A releaseKey művelet eredménye. |
| RestoreKeyBackupOptions |
A beállítások a következőhöz: restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
| RotateKeyOptions |
Az rotateKey beállításai |
| RsaDecryptParameters |
RSA titkosítási algoritmusok visszafejtési paraméterei. |
| RsaEncryptParameters |
Az RSA titkosítási algoritmusainak titkosítási paraméterei. |
| SignOptions |
A beállítások a következőhöz: sign(string, Uint8Array, SignOptions). |
| SignResult |
A sign(string, Uint8Array, SignOptions) művelet eredménye. |
| UnwrapKeyOptions |
A beállítások a következőhöz: unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
A <xref:unwrap> művelet eredménye. |
| UpdateKeyPropertiesOptions |
A beállítások a következőhöz: updateKeyProperties(string, string, UpdateKeyPropertiesOptions). |
| UpdateKeyRotationPolicyOptions |
Az updateKeyRotationPolicy beállításai |
| VerifyDataOptions |
Beállítások a következőhöz: verifyData(string, Uint8Array, Uint8Array, VerifyOptions) |
| VerifyOptions |
A beállítások a következőhöz: verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| VerifyResult |
A verify(string, Uint8Array, Uint8Array, VerifyOptions) művelet eredménye. |
| WrapKeyOptions |
A beállítások a következőhöz: wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| WrapResult |
A <xref:wrap> művelet eredménye. |
Típusaliasok
| AesCbcEncryptionAlgorithm |
Az összes támogatott AES-CBC titkosítási algoritmust képviselő egyesítő típus. |
| AesGcmEncryptionAlgorithm |
Az összes támogatott AES-GCM titkosítási algoritmust képviselő egyesítő típus. |
| DecryptParameters |
Az összes jelenleg támogatott visszafejtési paramétert képviselő típus, amely különböző titkosítási algoritmusokra vonatkozik. |
| DeletionRecoveryLevel |
A DeletionRecoveryLevel értékeit határozza meg. A szolgáltatás által támogatott ismert értékekHelyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a Törlés művelet elleni védelemnek; az adatok helyrehozhatatlanul elvesznek egy törlési művelet entitásszinten vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) elfogadásakor. |
| EncryptParameters |
Az összes jelenleg támogatott titkosítási paramétert képviselő típus, amely a különböző titkosítási algoritmusokra vonatkozik. |
| EncryptionAlgorithm |
A JsonWebKeyEncryptionAlgorithm értékeit határozza meg. A szolgáltatás által támogatott ismert értékekRSA-OAEP |
| KeyCurveName |
A JsonWebKeyCurveName értékeit határozza meg. A szolgáltatás által támogatott ismert értékekP-256: A NIST P-256 háromliptikus görbe, AKA SECG görbe SECP256R1. |
| KeyExportEncryptionAlgorithm |
A KeyEncryptionAlgorithm értékeit határozza meg. A KnownKeyExportEncryptionAlgorithm felcserélhető a KeyEncryptionAlgorithm használatával, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékekCKM_RSA_AES_KEY_WRAP |
| KeyOperation |
A JsonWebKeyOperation értékeit határozza meg. A szolgáltatás által támogatott ismert értékekTitkosítani |
| KeyRotationPolicyAction |
A végrehajtandó művelet. |
| KeyType |
A JsonWebKeyType értékeit határozza meg. A szolgáltatás által támogatott ismert értékekEC: Elliptikus görbe. |
| KeyWrapAlgorithm |
Támogatott algoritmusok kulcsburkoláshoz/kicsomagoláshoz |
| RsaEncryptionAlgorithm |
Az összes támogatott RSA-titkosítási algoritmust képviselő egyesítő típus. |
| SignatureAlgorithm |
A JsonWebKeySignatureAlgorithm értékeit határozza meg. A szolgáltatás által támogatott ismert értékekPS256: RSASSA-PSS SHA-256 és MGF1 használatával SHA-256-tal, az alábbiakban leírtak szerint https://tools.ietf.org/html/rfc7518 |
Enumerációk
| KnownDeletionRecoveryLevel |
A szolgáltatás által elfogadott DeletionRecoveryLevel ismert értékei. |
| KnownEncryptionAlgorithms |
A szolgáltatás által elfogadott EncryptionAlgorithm ismert értékei. |
| KnownKeyCurveNames |
A szolgáltatás által elfogadott ismert értékek <xref:JsonWebKeyCurveName> . |
| KnownKeyExportEncryptionAlgorithm |
A KeyExportEncryptionAlgorithm ismert értékei, amelyeket a szolgáltatás elfogad. |
| KnownKeyOperations |
A KeyOperation ismert értékei, amelyeket a szolgáltatás elfogad. |
| KnownKeyTypes |
A szolgáltatás által elfogadott ismert értékek <xref:JsonWebKeyType> . |
| KnownSignatureAlgorithms |
A szolgáltatás által elfogadott ismert értékek <xref:JsonWebKeySignatureAlgorithm> . |
Függvények
| parse |
Elemzi a megadott Key Vault kulcsazonosítót. Ilyen például a következő: https://.vault.azure.net/keys// A fenti azonosító elemzésekor a függvény a következőt adja vissza: |
Függvény adatai
parseKeyVaultKeyIdentifier(string)
Elemzi a megadott Key Vault kulcsazonosítót. Ilyen például a következő:
https://.vault.azure.net/keys//
A fenti azonosító elemzésekor a függvény a következőt adja vissza:
{
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): KeyVaultKeyIdentifierParaméterek
- id
-
string
A Key Vault kulcs azonosítója.