Delen via


@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.
KnownDeletionRecoveryLevel kan door elkaar worden gebruikt met DeletionRecoveryLevel. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Opschoonbaar: 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)
Herstelbaar+opschoonbaar: geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Herstelbaar: geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription: geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een retentieperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
CustomizedRecoverable+Purgeable: geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
CustomizedRecoverable: geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription: geeft een kluis- en abonnementsstatus aan waarin verwijdering herstelbaar is, onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.

EncryptParameters

Een type dat alle momenteel ondersteunde versleutelingsparameters vertegenwoordigt die van toepassing zijn op verschillende versleutelingsalgoritmen.

EncryptionAlgorithm

Definieert waarden voor JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> kan door elkaar worden gebruikt met JsonWebKeyEncryptionAlgorithm, deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

KeyCurveName

Definieert waarden voor JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> kan door elkaar worden gebruikt met JsonWebKeyCurveName, deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

P-256: De NIST P-256 elliptische curve, ook wel SECG-curve SECP256R1 genoemd.
P-384: De NIST P-384 elliptische curve, ook wel SECG-curve SECP384R1 genoemd.
P-521: De NIST P-521 elliptische curve, ook wel SECG-curve SECP521R1 genoemd.
P-256K: De SECG SECP256K1 elliptische curve.

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 ondersteund

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

KeyOperation

Definieert waarden voor JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> kan door elkaar worden gebruikt met JsonWebKeyOperation, deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Coderen
Decoderen
Teken
Controleren
wrapKey
unwrapKey
import
exporteren

KeyRotationPolicyAction

De actie die wordt uitgevoerd.

KeyType

Definieert waarden voor JsonWebKeyType.
<xref:KnownJsonWebKeyType> kan door elkaar worden gebruikt met JsonWebKeyType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

EC: Elliptische curve.
EC-HSM: Elliptische curve met een persoonlijke sleutel die is opgeslagen in de HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA met een persoonlijke sleutel die is opgeslagen in de HSM.
oct: octetreeks (gebruikt om symmetrische sleutels weer te geven)
oct-HSM: Octetreeks (gebruikt om symmetrische sleutels weer te geven) die de HSM wordt opgeslagen.

KeyWrapAlgorithm

Ondersteunde algoritmen voor het verpakken/uitpakken van sleutels

RsaEncryptionAlgorithm

Een samenvoegingstype dat alle ondersteunde RSA-versleutelingsalgoritmen vertegenwoordigt.

SignatureAlgorithm

Definieert waarden voor JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> kan door elkaar worden gebruikt met JsonWebKeySignatureAlgorithm. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

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
PS384: RSASSA-PSS met SHA-384 en MGF1 met SHA-384, zoals beschreven in https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS met SHA-512 en MGF1 met SHA-512, zoals beschreven in https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 met behulp van SHA-256, zoals beschreven in https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 met sha-384, zoals beschreven in https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 met behulp van SHA-512, zoals beschreven in https://tools.ietf.org/html/rfc7518
RSNULL: Gereserveerd
ES256: ECDSA met P-256 en SHA-256, zoals beschreven in https://tools.ietf.org/html/rfc7518.
ES384: ECDSA met P-384 en SHA-384, zoals beschreven in https://tools.ietf.org/html/rfc7518
ES512: ECDSA met P-521 en SHA-512, zoals beschreven in https://tools.ietf.org/html/rfc7518
ES256K: ECDSA met P-256K en 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

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>"
  }

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): KeyVaultKeyIdentifier

Parameters

id

string

De id van de Key Vault sleutel.

Retouren