@azure/keyvault-keys package
Klasser
| CryptographyClient |
En klient som används för att utföra kryptografiska åtgärder på en Azure Key Vault-nyckel eller en lokal JsonWebKey-. |
| KeyClient |
KeyClient innehåller metoder för att hantera KeyVaultKey- i Azure Key Vault. Klienten har stöd för att skapa, hämta, uppdatera, ta bort, rensa, säkerhetskopiera, återställa och lista KeyVaultKeys. Klienten har också stöd för att visa DeletedKey- för ett aktiverat Azure Key Vault med mjuk borttagning. |
Gränssnitt
| AesCbcDecryptParameters |
Dekrypteringsparametrar för AES-CBC krypteringsalgoritmer. |
| AesCbcEncryptParameters |
Krypteringsparametrar för AES-CBC krypteringsalgoritmer. |
| AesGcmDecryptParameters |
Dekrypteringsparametrar för AES-GCM krypteringsalgoritmer. |
| AesGcmEncryptParameters |
Krypteringsparametrar för AES-GCM krypteringsalgoritmer. |
| BackupKeyOptions |
Alternativ för backupKey(string, BackupKeyOptions). |
| BeginDeleteKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteKey(string, BeginDeleteKeyOptions) |
| BeginRecoverDeletedKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| CreateEcKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till createEcKey(string, CreateEcKeyOptions) |
| CreateKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till createKey(string, string, CreateKeyOptions) |
| CreateOctKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till createOctKey(string, CreateOctKeyOptions) |
| CreateRsaKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till createRsaKey(string, CreateRsaKeyOptions) |
| CryptographyClientOptions |
De valfria parametrar som godkänts av KeyVaults CryptographyClient |
| CryptographyOptions |
Ett gränssnitt som representerar alternativen för kryptografi-API-metoderna går du till CryptographyClient för mer information. |
| DecryptOptions |
Alternativ för decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
Resultatet av åtgärden decrypt(DecryptParameters, DecryptOptions). |
| DeletedKey |
Ett gränssnitt som representerar en borttagen Key Vault-nyckel. |
| EncryptOptions |
Alternativ för encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
Resultatet av åtgärden encrypt(EncryptParameters, EncryptOptions). |
| GetCryptographyClientOptions |
Alternativ för getCryptographyClient. |
| GetDeletedKeyOptions |
Alternativ för getDeletedKey(string, GetDeletedKeyOptions). |
| GetKeyOptions |
Alternativ för getKey(string, GetKeyOptions). |
| GetKeyRotationPolicyOptions |
Alternativ för <xref:KeyClient.getRotationPolicy> |
| GetRandomBytesOptions |
Alternativ för getRandomBytes |
| ImportKeyOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till importKey(string, JsonWebKey, ImportKeyOptions) |
| JsonWebKey |
Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
De valfria parametrar som godkänts av KeyVaults KeyClient |
| KeyPollerOptions |
Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteKey(string, BeginDeleteKeyOptions) och beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| KeyProperties |
Ett gränssnitt som representerar egenskaperna för KeyVaultKey |
| KeyReleasePolicy |
De principregler som en nyckel kan exporteras under. |
| KeyRotationLifetimeAction |
En åtgärd och dess motsvarande utlösare som ska utföras av Key Vault under en nyckels livslängd. |
| KeyRotationPolicy |
Den fullständiga nyckelrotationsprincipen som tillhör en nyckel. |
| KeyRotationPolicyProperties |
Egenskaperna för en nyckelrotationsprincip som klienten kan ange för en viss nyckel. Du kan också återställa nyckelrotationsprincipen till dess standardvärden genom att ange lifetimeActions till en tom matris. |
| KeyVaultKey |
Ett gränssnitt som representerar en Key Vault-nyckel med dess namn, värde och KeyProperties. |
| KeyVaultKeyIdentifier |
Representerar de segment som utgör ett Key Vault-nyckel-ID. |
| ListDeletedKeysOptions |
Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till listDeletedKeys(ListDeletedKeysOptions). |
| ListPropertiesOfKeyVersionsOptions |
Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions). |
| ListPropertiesOfKeysOptions |
Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till listPropertiesOfKeys(ListPropertiesOfKeysOptions). |
| PageSettings |
Ett gränssnitt som spårar inställningarna för sidsidig iteration |
| PagedAsyncIterableIterator |
Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida. |
| PollOperationState |
PollOperationState innehåller en åsiktslista över den minsta uppsättning egenskaper som behövs för att definiera en tidskrävande åtgärdsbestämning. Medan Klassen Poller fungerar som den lokala kontrollmekanismen för att börja utlösa, vänta på och eventuellt avbryta en tidskrävande åtgärd, dokumenterar PollOperationState statusen för fjärråtgärden som körs länge. Den bör uppdateras åtminstone när åtgärden startas, när den är klar och när den avbryts. Implementeringar kan dock ha valfritt annat antal egenskaper som kan uppdateras av andra orsaker. |
| PollerLike |
Abstrakt representation av en poller, avsedd att exponera bara det minimala API som användaren behöver arbeta med. |
| PurgeDeletedKeyOptions |
Alternativ för purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
Alternativ för releaseKey |
| ReleaseKeyResult |
Resultatet av åtgärden releaseKey. |
| RestoreKeyBackupOptions |
Alternativ för restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
| RotateKeyOptions |
Alternativ för rotateKey- |
| RsaDecryptParameters |
Dekrypteringsparametrar för RSA-krypteringsalgoritmer. |
| RsaEncryptParameters |
Krypteringsparametrar för RSA-krypteringsalgoritmer. |
| SignOptions |
Alternativ för sign(string, Uint8Array, SignOptions). |
| SignResult |
Resultatet av åtgärden sign(string, Uint8Array, SignOptions). |
| UnwrapKeyOptions |
Alternativ för unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
Resultatet av åtgärden <xref:unwrap>. |
| UpdateKeyPropertiesOptions |
Alternativ för updateKeyProperties(string, string, UpdateKeyPropertiesOptions). |
| UpdateKeyRotationPolicyOptions |
Alternativ för updateKeyRotationPolicy |
| VerifyDataOptions |
Alternativ för verifyData(string, Uint8Array, Uint8Array, VerifyOptions) |
| VerifyOptions |
Alternativ för verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| VerifyResult |
Resultatet av åtgärden verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| WrapKeyOptions |
Alternativ för wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| WrapResult |
Resultatet av åtgärden <xref:wrap>. |
Typalias
| AesCbcEncryptionAlgorithm |
En unionstyp som representerar alla AES-CBC krypteringsalgoritmer som stöds. |
| AesGcmEncryptionAlgorithm |
En unionstyp som representerar alla AES-GCM krypteringsalgoritmer som stöds. |
| DecryptParameters |
En typ som representerar alla dekrypteringsparametrar som stöds för närvarande när de gäller för olika krypteringsalgoritmer. |
| DeletionRecoveryLevel |
Definierar värden för DeletionRecoveryLevel. Kända värden som stöds av tjänsten
Purgeable: Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligen förlorade när en borttagningsåtgärd godkänns på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.) |
| EncryptParameters |
En typ som representerar alla krypteringsparametrar som stöds för närvarande när de gäller för olika krypteringsalgoritmer. |
| EncryptionAlgorithm |
Definierar värden för JsonWebKeyEncryptionAlgorithm. Kända värden som stöds av tjänsten
RSA-OAEP |
| KeyCurveName |
Definierar värden för JsonWebKeyCurveName. Kända värden som stöds av tjänsten
P-256: DEN NIST P-256 elliptiska kurvan, AKA SECG kurva SECP256R1. |
| KeyExportEncryptionAlgorithm |
Definierar värden för KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm kan användas omväxlande med KeyEncryptionAlgorithm innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
Definierar värden för JsonWebKeyOperation. Kända värden som stöds av tjänsten
kryptera |
| KeyRotationPolicyAction |
Den åtgärd som ska utföras. |
| KeyType |
Definierar värden för JsonWebKeyType. Kända värden som stöds av tjänsten
EC: Elliptisk kurva. |
| KeyWrapAlgorithm |
Algoritmer som stöds för nyckelomslutning/avskrivning |
| RsaEncryptionAlgorithm |
En unionstyp som representerar alla RSA-krypteringsalgoritmer som stöds. |
| SignatureAlgorithm |
Definierar värden för JsonWebKeySignatureAlgorithm. Kända värden som stöds av tjänsten
PS256: RSASSA-PSS med SHA-256 och MGF1 med SHA-256, enligt beskrivningen i https://tools.ietf.org/html/rfc7518 |
Uppräkningar
| KnownDeletionRecoveryLevel |
Kända värden för DeletionRecoveryLevel som tjänsten accepterar. |
| KnownEncryptionAlgorithms |
Kända värden för EncryptionAlgorithm som tjänsten accepterar. |
| KnownKeyCurveNames |
Kända värden för <xref:JsonWebKeyCurveName> som tjänsten accepterar. |
| KnownKeyExportEncryptionAlgorithm |
Kända värden för KeyExportEncryptionAlgorithm som tjänsten accepterar. |
| KnownKeyOperations |
Kända värden för KeyOperation som tjänsten accepterar. |
| KnownKeyTypes |
Kända värden för <xref:JsonWebKeyType> som tjänsten accepterar. |
| KnownSignatureAlgorithms |
Kända värden för <xref:JsonWebKeySignatureAlgorithm> som tjänsten accepterar. |
Funktioner
| parse |
Parsar det angivna Nyckel-ID:t för Key Vault. Ett exempel är: https://.vault.azure.net/keys// Vid parsning av ovanstående ID returnerar den här funktionen: |
Funktionsinformation
parseKeyVaultKeyIdentifier(string)
Parsar det angivna Nyckel-ID:t för Key Vault. Ett exempel är:
https://.vault.azure.net/keys//
Vid parsning av ovanstående ID returnerar den här funktionen:
{
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): KeyVaultKeyIdentifierParametrar
- id
-
string
ID:t för Key Vault-nyckeln.