@azure/keyvault-keys package
Klassen
| CryptographyClient |
Een client die wordt gebruikt voor het uitvoeren van cryptografische bewerkingen op een Azure Key Vault-sleutel of een lokale JsonWebKey. |
| KeyClient |
KeyClient biedt methoden voor het beheren van KeyVaultKey- in 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 voorlopig verwijderen ingeschakelde Azure Key Vault. |
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, gaat u naar de 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, ImportKeyOptions) |
| JsonWebKey |
Vanaf http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
De optionele parameters die worden geaccepteerd door keyvault's KeyClient |
| 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 |
| KeyReleasePolicy |
De beleidsregels waaronder een sleutel kan worden geëxporteerd. |
| KeyRotationLifetimeAction |
Een actie en de bijbehorende trigger die door Key Vault worden uitgevoerd 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 KeyProperties. |
| KeyVaultKeyIdentifier |
Vertegenwoordigt de segmenten die een Key Vault-sleutel-id opstellen. |
| ListDeletedKeysOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van KeyClient die zijn doorgegeven aan listDeletedKeys(ListDeletedKeysOptions). |
| ListPropertiesOfKeyVersionsOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van KeyClient die zijn doorgegeven aan listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions). |
| ListPropertiesOfKeysOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van KeyClient die zijn doorgegeven aan listPropertiesOfKeys(ListPropertiesOfKeysOptions). |
| PageSettings |
Een interface waarmee de instellingen voor gepaginade iteratie worden bijgehouden |
| PagedAsyncIterableIterator |
Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina. |
| PollOperationState |
PollOperationState bevat een meningsopgave van 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 activeren, wachten op en mogelijk een langdurige bewerking annuleren, documenteert de PollOperationState de status van de externe langdurige bewerking. Deze moet ten minste worden bijgewerkt wanneer de bewerking wordt gestart, wanneer deze is voltooid en wanneer deze wordt geannuleerd. Implementaties kunnen echter elk ander aantal eigenschappen hebben dat door andere redenen kan worden bijgewerkt. |
| PollerLike |
Abstracte weergave van een poller, bedoeld om alleen de minimale API weer te geven waarmee de gebruiker moet werken. |
| PurgeDeletedKeyOptions |
Opties voor purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
Opties voor releaseKey |
| ReleaseKeyResult |
Resultaat van de bewerking releaseKey. |
| 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 samenvoegtype dat alle ondersteunde AES-CBC versleutelingsalgoritmen vertegenwoordigt. |
| AesGcmEncryptionAlgorithm |
Een samenvoegtype dat alle ondersteunde AES-GCM versleutelingsalgoritmen vertegenwoordigt. |
| DecryptParameters |
Een type dat alle momenteel ondersteunde ontsleutelingsparameters vertegenwoordigt wanneer deze van toepassing zijn op verschillende versleutelingsalgoritmen. |
| DeletionRecoveryLevel |
Definieert waarden voor DeletionRecoveryLevel. Bekende waarden die door de service worden ondersteund
verwijderbare: geeft een kluisstatus aan waarin verwijdering een ongedaanbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met geen beveiliging die beschikbaar is tegen een verwijderbewerking; de gegevens verloren gaan bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort) |
| EncryptParameters |
Een type dat alle momenteel ondersteunde versleutelingsparameters vertegenwoordigt terwijl deze van toepassing zijn op verschillende versleutelingsalgoritmen. |
| EncryptionAlgorithm |
Definieert waarden voor JsonWebKeyEncryptionAlgorithm. Bekende waarden die door de service worden ondersteund
RSA-OAEP- |
| KeyCurveName |
Definieert waarden voor JsonWebKeyCurveName. Bekende waarden die door de service worden ondersteund
P-256: De NIST P-256 elliptische curve, AKA SECG-curve SECP256R1. |
| KeyExportEncryptionAlgorithm |
Definieert waarden voor KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm kan door elkaar worden gebruikt met KeyEncryptionAlgorithm, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
Definieert waarden voor JsonWebKeyOperation. Bekende waarden die door de service worden ondersteund
versleutelen |
| KeyRotationPolicyAction |
De actie die wordt uitgevoerd. |
| KeyType |
Definieert waarden voor JsonWebKeyType. Bekende waarden die door de service worden ondersteund
EC-: Elliptische curve. |
| KeyWrapAlgorithm |
Ondersteunde algoritmen voor sleutelterugloop/uitpakken |
| RsaEncryptionAlgorithm |
Een samenvoegtype dat alle ondersteunde RSA-versleutelingsalgoritmen vertegenwoordigt. |
| SignatureAlgorithm |
Definieert waarden voor JsonWebKeySignatureAlgorithm. Bekende waarden die door de service worden ondersteund
PS256-: 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 de service accepteert. |
| KnownKeyCurveNames |
Bekende waarden van <xref:JsonWebKeyCurveName> die de service accepteert. |
| KnownKeyExportEncryptionAlgorithm |
Bekende waarden van KeyExportEncryptionAlgorithm die de service accepteert. |
| KnownKeyOperations |
Bekende waarden van KeyOperation die de service accepteert. |
| 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 hiervan 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 hiervan 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 Sleutelkluissleutel.