@azure/keyvault-keys package
Klassen
| CryptographyClient |
Een client die wordt gebruikt om cryptografische bewerkingen uit te voeren op een Azure Key Vault-sleutel of een lokale JsonWebKey. |
| KeyClient |
KeyClient biedt methoden voor het beheren van KeyVaultKey in de Azure Key Vault. De client ondersteunt het maken, ophalen, bijwerken, verwijderen, opschonen, back-ups maken, herstellen en vermelden van KeyVaultKeys. De client biedt ook ondersteuning voor het weergeven van DeletedKey voor een Azure-Key Vault waarvoor voorlopig verwijderen is ingeschakeld. |
Interfaces
| AesCbcDecryptParameters |
Ontsleutelingsparameters voor AES-CBC-versleutelingsalgoritmen. |
| AesCbcEncryptParameters |
Versleutelingsparameters voor AES-CBC-versleutelingsalgoritmen. |
| AesGcmDecryptParameters |
Ontsleutelingsparameters voor AES-GCM-versleutelingsalgoritmen. |
| AesGcmEncryptParameters |
Versleutelingsparameters voor AES-GCM-versleutelingsalgoritmen. |
| BackupKeyOptions |
Opties voor backupKey(string, BackupKeyOptions). |
| BeginDeleteKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginDeleteKey(string, BeginDeleteKeyOptions) |
| BeginRecoverDeletedKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| CreateEcKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan createEcKey(string, CreateEcKeyOptions) |
| CreateKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan createKey(string, string, CreateKeyOptions) |
| CreateOctKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan createOctKey(string, CreateOctKeyOptions) |
| CreateRsaKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan createRsaKey(string, CreateRsaKeyOptions) |
| CryptographyClientOptions |
De optionele parameters die worden geaccepteerd door de CryptographyClient van KeyVault |
| CryptographyOptions |
Een interface die de opties van de cryptografie-API-methoden vertegenwoordigt. Ga naar CryptographyClient voor meer informatie. |
| DecryptOptions |
Opties voor decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
Resultaat van de decrypt(DecryptParameters, DecryptOptions) bewerking. |
| DeletedKey |
Een interface die een verwijderde Key Vault sleutel vertegenwoordigt. |
| EncryptOptions |
Opties voor encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
Resultaat van de encrypt(EncryptParameters, EncryptOptions) bewerking. |
| GetCryptographyClientOptions |
Opties voor getCryptographyClient. |
| GetDeletedKeyOptions |
Opties voor getDeletedKey(string, GetDeletedKeyOptions). |
| GetKeyOptions |
Opties voor getKey(string, GetKeyOptions). |
| GetKeyRotationPolicyOptions |
Opties voor <xref:KeyClient.getRotationPolicy> |
| GetRandomBytesOptions |
Opties voor getRandomBytes |
| ImportKeyOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan importKey(string, JsonWebKey_2, ImportKeyOptions) |
| JsonWebKey |
Vanaf http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
De optionele parameters die worden geaccepteerd door de KeyClient van KeyVault |
| KeyPollerOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginDeleteKey(string, BeginDeleteKeyOptions) en beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| KeyProperties |
Een interface die de eigenschappen van KeyVaultKey vertegenwoordigt |
| KeyReleasePolicy |
De beleidsregels waaronder een sleutel kan worden geëxporteerd. |
| KeyRotationLifetimeAction |
Een actie en de bijbehorende trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een sleutel. |
| KeyRotationPolicy |
Het volledige sleutelrotatiebeleid dat deel uitmaakt van een sleutel. |
| KeyRotationPolicyProperties |
De eigenschappen van een sleutelrotatiebeleid dat de client voor een bepaalde sleutel kan instellen. U kunt het sleutelrotatiebeleid ook opnieuw instellen op de standaardwaarden door lifetimeActions in te stellen op een lege matrix. |
| KeyVaultKey |
Een interface die een Key Vault Sleutel vertegenwoordigt, met de naam, waarde en Sleuteleigenschappen. |
| KeyVaultKeyIdentifier |
Vertegenwoordigt de segmenten waaruit een Key Vault Sleutel-id bestaat. |
| ListDeletedKeysOptions |
Een interface die optionele parameters vertegenwoordigt voor keyclient-bewerkingen die worden doorgegeven aan listDeletedKeys(ListDeletedKeysOptions). |
| ListPropertiesOfKeyVersionsOptions |
Een interface die optionele parameters vertegenwoordigt voor keyclient-bewerkingen die worden doorgegeven aan listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions). |
| ListPropertiesOfKeysOptions |
Een interface die optionele parameters vertegenwoordigt voor keyclient-bewerkingen die worden doorgegeven aan listPropertiesOfKeys(ListPropertiesOfKeysOptions). |
| PageSettings |
Een interface waarmee de instellingen voor gepaginade iteratie worden bijgehouden |
| PagedAsyncIterableIterator |
Een interface die asynchrone iteratie mogelijk maakt, zowel naar voltooiing als per pagina. |
| PollOperationState |
PollOperationState bevat een aangepaste lijst met de kleinste set eigenschappen die nodig zijn om een poller voor langdurige bewerkingen te definiëren. Terwijl de Poller-klasse werkt als het lokale controlemechanisme om te beginnen met het activeren, wachten op en mogelijk annuleren van een langlopende bewerking, documenteert pollOperationState de status van de externe langlopende bewerking. Deze moet ten minste worden bijgewerkt wanneer de bewerking wordt gestart, voltooid en geannuleerd. Implementaties kunnen echter een ander aantal eigenschappen hebben dat om andere redenen kan worden bijgewerkt. |
| PollerLike |
Abstracte weergave van een poller, bedoeld om alleen de minimale API beschikbaar te maken waarmee de gebruiker moet werken. |
| PurgeDeletedKeyOptions |
Opties voor purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
Opties voor ReleaseKey |
| ReleaseKeyResult |
Resultaat van de releaseKey-bewerking . |
| RestoreKeyBackupOptions |
Opties voor restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
| RotateKeyOptions |
Opties voor rotateKey |
| RsaDecryptParameters |
Ontsleutelingsparameters voor RSA-versleutelingsalgoritmen. |
| RsaEncryptParameters |
Versleutelingsparameters voor RSA-versleutelingsalgoritmen. |
| SignOptions |
Opties voor sign(string, Uint8Array, SignOptions). |
| SignResult |
Resultaat van de sign(string, Uint8Array, SignOptions) bewerking. |
| UnwrapKeyOptions |
Opties voor unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
Resultaat van de <xref:unwrap> bewerking. |
| UpdateKeyPropertiesOptions |
Opties voor updateKeyProperties(string, string, UpdateKeyPropertiesOptions). |
| UpdateKeyRotationPolicyOptions |
Opties voor updateKeyRotationPolicy |
| VerifyDataOptions |
Opties voor verifyData(string, Uint8Array, Uint8Array, VerifyOptions) |
| VerifyOptions |
Opties voor verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| VerifyResult |
Resultaat van de verify(string, Uint8Array, Uint8Array, VerifyOptions) bewerking. |
| WrapKeyOptions |
Opties voor wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| WrapResult |
Resultaat van de <xref:wrap> bewerking. |
Type-aliassen
| AesCbcEncryptionAlgorithm |
Een samenvoegingstype dat alle ondersteunde AES-CBC-versleutelingsalgoritmen vertegenwoordigt. |
| AesGcmEncryptionAlgorithm |
Een samenvoegingstype dat alle ondersteunde AES-GCM-versleutelingsalgoritmen vertegenwoordigt. |
| DecryptParameters |
Een type dat alle momenteel ondersteunde ontsleutelingsparameters vertegenwoordigt die van toepassing zijn op verschillende versleutelingsalgoritmen. |
| DeletionRecoveryLevel |
Definieert waarden voor DeletionRecoveryLevel. Bekende waarden die door de service worden ondersteundOpschoonbaar: geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Verwijderbewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort) |
| EncryptParameters |
Een type dat alle momenteel ondersteunde versleutelingsparameters vertegenwoordigt die van toepassing zijn op verschillende versleutelingsalgoritmen. |
| EncryptionAlgorithm |
Definieert waarden voor JsonWebKeyEncryptionAlgorithm. Bekende waarden die door de service worden ondersteundRSA-OAEP |
| KeyCurveName |
Definieert waarden voor JsonWebKeyCurveName. Bekende waarden die door de service worden ondersteundP-256: De NIST P-256 elliptische curve, ook wel SECG-curve SECP256R1 genoemd. |
| KeyExportEncryptionAlgorithm |
Definieert waarden voor KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm kan door elkaar worden gebruikt met KeyEncryptionAlgorithm. Deze opsomming bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteundCKM_RSA_AES_KEY_WRAP |
| KeyOperation |
Definieert waarden voor JsonWebKeyOperation. Bekende waarden die door de service worden ondersteundCoderen |
| KeyRotationPolicyAction |
De actie die wordt uitgevoerd. |
| KeyType |
Definieert waarden voor JsonWebKeyType. Bekende waarden die door de service worden ondersteundEC: Elliptische curve. |
| KeyWrapAlgorithm |
Ondersteunde algoritmen voor het verpakken/uitpakken van sleutels |
| RsaEncryptionAlgorithm |
Een samenvoegingstype dat alle ondersteunde RSA-versleutelingsalgoritmen vertegenwoordigt. |
| SignatureAlgorithm |
Definieert waarden voor JsonWebKeySignatureAlgorithm. Bekende waarden die door de service worden ondersteundPS256: RSASSA-PSS met SHA-256 en MGF1 met SHA-256, zoals beschreven in https://tools.ietf.org/html/rfc7518 |
Enums
| KnownDeletionRecoveryLevel |
Bekende waarden van DeletionRecoveryLevel die de service accepteert. |
| KnownEncryptionAlgorithms |
Bekende waarden van EncryptionAlgorithm die door de service worden geaccepteerd. |
| KnownKeyCurveNames |
Bekende waarden van <xref:JsonWebKeyCurveName> die de service accepteert. |
| KnownKeyExportEncryptionAlgorithm |
Bekende waarden van KeyExportEncryptionAlgorithm die door de service worden geaccepteerd. |
| KnownKeyOperations |
Bekende waarden van KeyOperation die door de service worden geaccepteerd. |
| KnownKeyTypes |
Bekende waarden van <xref:JsonWebKeyType> die de service accepteert. |
| KnownSignatureAlgorithms |
Bekende waarden van <xref:JsonWebKeySignatureAlgorithm> die de service accepteert. |
Functies
| parse |
Parseert de opgegeven Key Vault sleutel-id. Een voorbeeld is: https://.vault.azure.net/keys// Bij het parseren van de bovenstaande id retourneert deze functie: |
Functiedetails
parseKeyVaultKeyIdentifier(string)
Parseert de opgegeven Key Vault sleutel-id. Een voorbeeld is:
https://.vault.azure.net/keys//
Bij het parseren van de bovenstaande id retourneert deze functie:
{
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): KeyVaultKeyIdentifierParameters
- id
-
string
De id van de Key Vault sleutel.