@azure/keyvault-keys package
Třídy
| CryptographyClient |
Klient používaný k provádění kryptografických operací s klíčem služby Azure Key Vault nebo místním JsonWebKey. |
| KeyClient |
KeyClient poskytuje metody pro správu KeyVaultKey ve službě Azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultKeys. Klient také podporuje výpis DeletedKey pro obnovitelné odstranění s povoleným azure Key Vaultem. |
Rozhraní
| AesCbcDecryptParameters |
Parametry dešifrování pro šifrovací algoritmy AES-CBC |
| AesCbcEncryptParameters |
Parametry šifrování pro šifrovací algoritmy AES-CBC |
| AesGcmDecryptParameters |
Parametry dešifrování pro šifrovací algoritmy AES-GCM |
| AesGcmEncryptParameters |
Parametry šifrování pro šifrovací algoritmy AES-GCM |
| BackupKeyOptions |
Možnosti pro backupKey(string, BackupKeyOptions). |
| BeginDeleteKeyOptions |
Rozhraní představující volitelné parametry, které lze předat beginDeleteKey(string, BeginDeleteKeyOptions) |
| BeginRecoverDeletedKeyOptions |
Rozhraní představující volitelné parametry, které lze předat beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| CreateEcKeyOptions |
Rozhraní představující volitelné parametry, které lze předat createEcKey(string, CreateEcKeyOptions) |
| CreateKeyOptions |
Rozhraní představující volitelné parametry, které lze předat createKey(string, string, CreateKeyOptions) |
| CreateOctKeyOptions |
Rozhraní představující volitelné parametry, které lze předat createOctKey(string, CreateOctKeyOptions) |
| CreateRsaKeyOptions |
Rozhraní představující volitelné parametry, které lze předat createRsaKey(string, CreateRsaKeyOptions) |
| CryptographyClientOptions |
Volitelné parametry akceptované kryptografickým klientem služby KeyVault |
| CryptographyOptions |
Rozhraní představující možnosti metod rozhraní API kryptografie, přejděte na KryptografickýClient další informace. |
| DecryptOptions |
Možnosti pro decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
Výsledek operace decrypt(DecryptParameters, DecryptOptions) |
| DeletedKey |
Rozhraní představující odstraněný klíč služby Key Vault. |
| EncryptOptions |
Možnosti pro encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
Výsledek operace encrypt(EncryptParameters, EncryptOptions) |
| GetCryptographyClientOptions |
Možnosti pro getCryptographyClient. |
| GetDeletedKeyOptions |
Možnosti pro getDeletedKey(string, GetDeletedKeyOptions). |
| GetKeyOptions |
Možnosti pro getKey(string, GetKeyOptions). |
| GetKeyRotationPolicyOptions |
Možnosti pro <xref:KeyClient.getRotationPolicy> |
| GetRandomBytesOptions |
Možnosti pro getRandomBytes |
| ImportKeyOptions |
Rozhraní představující volitelné parametry, které lze předat importKey(string, JsonWebKey, ImportKeyOptions) |
| JsonWebKey |
Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
Volitelné parametry akceptované keyClient služby KeyClient služby KeyVault |
| KeyPollerOptions |
Rozhraní představující volitelné parametry, které lze předat beginDeleteKey(string, BeginDeleteKeyOptions) a beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| KeyProperties |
Rozhraní představující vlastnosti keyVaultKey |
| KeyReleasePolicy |
Pravidla zásad, pod kterými je možné klíč exportovat. |
| KeyRotationLifetimeAction |
Akce a její odpovídající aktivační událost, kterou bude služba Key Vault provádět po celou dobu životnosti klíče. |
| KeyRotationPolicy |
Úplná zásada obměny klíčů, která patří ke klíči. |
| KeyRotationPolicyProperties |
Vlastnosti zásad obměně klíčů, které může klient nastavit pro daný klíč. Zásady obměny klíčů můžete také resetovat na výchozí hodnoty nastavením lifetimeActions na prázdné pole. |
| KeyVaultKey |
Rozhraní představující klíč služby Key Vault s názvem, hodnotou a keyProperties. |
| KeyVaultKeyIdentifier |
Představuje segmenty, které tvoří ID klíče služby Key Vault. |
| ListDeletedKeysOptions |
Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané listDeletedKeys(ListDeletedKeysOptions). |
| ListPropertiesOfKeyVersionsOptions |
Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions). |
| ListPropertiesOfKeysOptions |
Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané listPropertiesOfKeys(ListPropertiesOfKeysOptions). |
| PageSettings |
Rozhraní, které sleduje nastavení stránkované iterace |
| PagedAsyncIterableIterator |
Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce. |
| PollOperationState |
PollOperationState obsahuje názorný seznam nejmenší sady vlastností potřebných k definování jakékoli dlouhotrvající operace poller. Zatímco Poller třída funguje jako místní řídicí mechanismus pro spuštění aktivace, čekání a potenciálně zrušení dlouhotrvající operace, PollOperationState dokumentuje stav vzdálené dlouhotrvající operace. Měla by se aktualizovat aspoň po spuštění operace, po jeho dokončení a po zrušení. Implementace ale můžou mít jakýkoli jiný počet vlastností, které je možné aktualizovat z jiných důvodů. |
| PollerLike |
Abstraktní reprezentace polleru, která má vystavit pouze minimální rozhraní API, se kterým musí uživatel pracovat. |
| PurgeDeletedKeyOptions |
Možnosti pro purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
Možnosti |
| ReleaseKeyResult |
Výsledek operace releaseKey. |
| RestoreKeyBackupOptions |
Možnosti pro restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
| RotateKeyOptions |
Možnosti pro rotateKey |
| RsaDecryptParameters |
Dešifrovací parametry pro šifrovací algoritmy RSA. |
| RsaEncryptParameters |
Parametry šifrování pro šifrovací algoritmy RSA |
| SignOptions |
Možnosti pro sign(string, Uint8Array, SignOptions). |
| SignResult |
Výsledek operace sign(string, Uint8Array, SignOptions) |
| UnwrapKeyOptions |
Možnosti pro unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
Výsledek operace <xref:unwrap> |
| UpdateKeyPropertiesOptions |
Možnosti pro updateKeyProperties(string, string, UpdateKeyPropertiesOptions). |
| UpdateKeyRotationPolicyOptions |
Možnosti updateKeyRotationPolicy |
| VerifyDataOptions |
Možnosti pro verifyData(string, Uint8Array, Uint8Array, VerifyOptions) |
| VerifyOptions |
Možnosti pro verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| VerifyResult |
Výsledek operace verify(string, Uint8Array, Uint8Array, VerifyOptions) |
| WrapKeyOptions |
Možnosti pro wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| WrapResult |
Výsledek operace <xref:wrap> |
Aliasy typu
| AesCbcEncryptionAlgorithm |
Typ sjednocení představující všechny podporované AES-CBC šifrovací algoritmy. |
| AesGcmEncryptionAlgorithm |
Typ sjednocení představující všechny podporované AES-GCM šifrovací algoritmy. |
| DecryptParameters |
Typ představující všechny aktuálně podporované parametry dešifrování, protože se vztahují na různé šifrovací algoritmy. |
| DeletionRecoveryLevel |
Definuje hodnoty pro DeletionRecoveryLevel. Známé hodnoty podporované službou
vyprázdnění: Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde ke ztrátě dat. |
| EncryptParameters |
Typ představující všechny aktuálně podporované parametry šifrování, protože se vztahují na různé šifrovací algoritmy. |
| EncryptionAlgorithm |
Definuje hodnoty pro JsonWebKeyEncryptionAlgorithm. Známé hodnoty podporované službou
RSA-OAEP |
| KeyCurveName |
Definuje hodnoty jsonWebKeyCurveName. Známé hodnoty podporované službou
P-256: elliptická křivka NIST P-256, křivka AKA SECG SECP256R1. |
| KeyExportEncryptionAlgorithm |
Definuje hodnoty pro KeyEncryptionAlgorithm. PoleKeyExportEncryptionAlgorithm lze použít zaměnitelně s KeyEncryptionAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
Definuje hodnoty pro JsonWebKeyOperation. Známé hodnoty podporované službou
šifrování |
| KeyRotationPolicyAction |
Akce, která se spustí. |
| KeyType |
Definuje hodnoty jsonWebKeyType. Známé hodnoty podporované službou
EC: elliptická křivka. |
| KeyWrapAlgorithm |
Podporované algoritmy pro zabalení nebo rozbalení klíče |
| RsaEncryptionAlgorithm |
Typ sjednocení představující všechny podporované šifrovací algoritmy RSA. |
| SignatureAlgorithm |
Definuje hodnoty jsonWebKeySignatureAlgorithm. Známé hodnoty podporované službou
PS256: RSASSA-PSS pomocí SHA-256 a MGF1 s SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518 |
Výčty
| KnownDeletionRecoveryLevel |
Známé hodnoty DeletionRecoveryLevel, které služba přijímá. |
| KnownEncryptionAlgorithms |
Známé hodnoty EncryptionAlgorithm, které služba přijímá. |
| KnownKeyCurveNames |
Známé hodnoty <xref:JsonWebKeyCurveName>, které služba přijímá. |
| KnownKeyExportEncryptionAlgorithm |
Známé hodnoty KeyExportEncryptionAlgorithm, které služba přijímá. |
| KnownKeyOperations |
Známé hodnoty KeyOperation, které služba přijímá. |
| KnownKeyTypes |
Známé hodnoty <xref:JsonWebKeyType>, které služba přijímá. |
| KnownSignatureAlgorithms |
Známé hodnoty <xref:JsonWebKeySignatureAlgorithm>, které služba přijímá. |
Funkce
| parse |
Analyzuje dané ID klíče služby Key Vault. Příkladem je: https://.vault.azure.net/keys// Při analýze výše uvedeného ID vrátí tato funkce: |
Podrobnosti funkce
parseKeyVaultKeyIdentifier(string)
Analyzuje dané ID klíče služby Key Vault. Příkladem je:
https://.vault.azure.net/keys//
Při analýze výše uvedeného ID vrátí tato funkce:
{
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): KeyVaultKeyIdentifierParametry
- id
-
string
ID klíče služby Key Vault.