@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).
GetKeyAttestationOptions	Opties voor getKeyAttestation(string, GetKeyAttestationOptions).
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
KeyAttestation	Een interface die de eigenschappen van de attestation van een sleutel vertegenwoordigt
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	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Leegmaken' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het bewaarinterval. KnownDeletionRecoveryLevel kan door elkaar worden gebruikt met DeletionRecoveryLevel, bevat dit enum de bekende waarden die de service ondersteunt. 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) Recoverable+Purgeable: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld, en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w.v. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen), tenzij er een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld Herstelbare: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid om onmiddellijk en permanent te worden verwijderd (bijvoorbeeld opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en terwijl het abonnement nog steeds beschikbaar is. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld Recoverable+ProtectedSubscription: Geeft een kluis en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen het retentieinterval (90 dagen), onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld CustomizedRecoverable+Purgeable: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld, en waarmee ook onmiddellijke en permanente verwijdering wordt toegestaan (bijvoorbeeld leegmaken wanneer 7 <= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval, tenzij er een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. CustomizedRecoverable: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid om onmiddellijk en permanent te worden verwijderd (dat wil bijvoorbeeld verwijderen wanneer 7 <= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en terwijl het abonnement nog steeds beschikbaar is. CustomizedRecoverable+ProtectedSubscription: Geeft een kluis- en abonnementsstatus aan waarin verwijdering herstelbaar, onmiddellijk en permanent verwijderen (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 terwijl deze van toepassing zijn op verschillende versleutelingsalgoritmen.
EncryptionAlgorithm	Een algoritme dat wordt gebruikt voor versleuteling en ontsleuteling. <xref:KnownJsonWebKeyEncryptionAlgorithm> kan door elkaar worden gebruikt met JsonWebKeyEncryptionAlgorithm, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund RSA-OAEP-: [Niet aanbevolen] RSAES met behulp van Optimale Asymmetrische versleuteling opvulling (OAEP), zoals beschreven in https://tools.ietf.org/html/rfc3447, met de standaardparameters die zijn opgegeven door RFC 3447 in sectie A.2.1. Deze standaardparameters maken gebruik van een hash-functie van SHA-1 en een maskergenereerfunctie van MGF1 met SHA-1. Microsoft raadt het gebruik van RSA_OAEP_256 of sterkere algoritmen aan voor verbeterde beveiliging. Microsoft niet RSA_OAEP aanbevelen, die uitsluitend is opgenomen voor achterwaartse compatibiliteit. RSA_OAEP maakt gebruik van SHA1, dat bekende botsingsproblemen heeft. RSA-OAEP-256: RSAES met behulp van Optimale Asymmetrische versleuteling opvulling met een hash-functie van SHA-256 en een maskergeneratiefunctie van MGF1 met SHA-256. RSA1_5: [Niet aanbevolen] RSAES-PKCS1-V1_5 sleutelversleuteling, zoals beschreven in https://tools.ietf.org/html/rfc3447. Microsoft raadt het gebruik van RSA_OAEP_256 of sterkere algoritmen aan voor verbeterde beveiliging. Microsoft RSA_1_5 niet aanbevelen, die uitsluitend is opgenomen voor achterwaartse compatibiliteit. Cryptografische standaarden beschouwen RSA niet langer met het PKCS#1 v1.5 opvullingsschema veilig voor versleuteling. A128GCM: 128-bits AES-GCM. A192GCM: 192-bits AES-GCM. A256GCM: 256-bits AES-GCM. A128KW: 128-bits AES-sleutelterugloop. A192KW: 192-bits AES-sleutelterugloop. A256KW: 256-bits AES-sleutelterugloop. A128CBC: 128-bits AES-CBC. A192CBC: 192-bits AES-CBC. A256CBC: 256-bits AES-CBC. A128CBCPAD: 128-bits AES-CBC met PKCS-opvulling. A192CBCPAD: 192-bits AES-CBC met PKCS-opvulling. A256CBCPAD: 256-bits AES-CBC met PKCS-opvulling. CKM_AES_KEY_WRAP: CKM AES-sleutelterugloop. CKM_AES_KEY_WRAP_PAD: CKM AES-sleutelterugloop met opvulling.
KeyCurveName	Elliptische curvenaam. Zie JsonWebKeyCurveName voor geldige waarden. <xref:KnownJsonWebKeyCurveName> kan door elkaar worden gebruikt met JsonWebKeyCurveName, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund P-256: De NIST P-256 elliptische curve, AKA SECG-curve SECP256R1. P-384: de NIST P-384-elliptische curve, AKA SECG-curve SECP384R1. P-521: de NIST P-521 elliptische curve, DE SECG-curve SECP521R1. P-256K: de SECG SECP256K1 elliptische curve.
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 RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	Bewerkingen voor JSON-websleutels. Zie JsonWebKeyOperation voor meer informatie. <xref:KnownJsonWebKeyOperation> kan door elkaar worden gebruikt met JsonWebKeyOperation, bevat deze opsomming de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund versleutelen: geeft aan dat de sleutel kan worden gebruikt om te versleutelen. ontsleutelen: geeft aan dat de sleutel kan worden gebruikt om te ontsleutelen. ondertekenen: geeft aan dat de sleutel kan worden gebruikt om te ondertekenen. controleren: geeft aan dat de sleutel kan worden gebruikt om te verifiëren. wrapKey: geeft aan dat de sleutel kan worden gebruikt om een andere sleutel te verpakken. unwrapKey: geeft aan dat de sleutel kan worden gebruikt om een andere sleutel uit te pakken. importeren: geeft aan dat de sleutel kan worden geïmporteerd tijdens het maken. exporteren: geeft aan dat het privéonderdeel van de sleutel kan worden geëxporteerd.
KeyRotationPolicyAction	De actie die wordt uitgevoerd.
KeyType	JsonWebKey-sleuteltype (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. <xref:KnownJsonWebKeyType> kan door elkaar worden gebruikt met JsonWebKeyType, bevat deze opsomming 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 sleutelterugloop/uitpakken
RsaEncryptionAlgorithm	Een samenvoegtype dat alle ondersteunde RSA-versleutelingsalgoritmen vertegenwoordigt.
SignatureAlgorithm	De id van het algoritme voor ondertekening/verificatie. Zie JsonWebKeySignatureAlgorithm voor meer informatie over mogelijke algoritmetypen. <xref:KnownJsonWebKeySignatureAlgorithm> kan door elkaar worden gebruikt met JsonWebKeySignatureAlgorithm, bevat dit enum de bekende waarden die de service ondersteunt. 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 sha-384 en MGF1 met SHA-384 gebruiken, 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 SHA-256, zoals beschreven in https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 met behulp van SHA-384, zoals beschreven in https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 met sha-512, zoals beschreven in https://tools.ietf.org/html/rfc7518 HS256-: HMAC met SHA-256, zoals beschreven in https://tools.ietf.org/html/rfc7518 HS384-: HMAC met SHA-384, zoals beschreven in https://tools.ietf.org/html/rfc7518 HS512: HMAC met 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	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Leegmaken' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het bewaarinterval.
KnownEncryptionAlgorithms	Een algoritme dat wordt gebruikt voor versleuteling en ontsleuteling.
KnownKeyCurveNames	Elliptische curvenaam. Zie JsonWebKeyCurveName voor geldige waarden.
KnownKeyExportEncryptionAlgorithm	Het versleutelingsalgoritmen dat moet worden gebruikt om het geëxporteerde sleutelmateriaal te beveiligen
KnownKeyOperations	Bekende waarden van KeyOperation die de service accepteert.
KnownKeyTypes	JsonWebKey-sleuteltype (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KnownSignatureAlgorithms	De id van het algoritme voor ondertekening/verificatie. Zie JsonWebKeySignatureAlgorithm voor meer informatie over mogelijke algoritmetypen.

Functies

parseKeyVaultKeyIdentifier(string)

Parseert de opgegeven Key Vault-sleutel-id. Een voorbeeld hiervan is:

https://< keyvault-name.vault.azure.net/keys/<> key-name>/<unique-version-id>

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 hiervan is:

https://< keyvault-name.vault.azure.net/keys/<> key-name>/<unique-version-id>

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 Sleutelkluissleutel.

Retouren

KeyVaultKeyIdentifier

Delen via

@azure/keyvault-keys package

Klassen

Interfaces

Type-aliassen

Bekende waarden die door de service worden ondersteund

Bekende waarden die door de service worden ondersteund

Bekende waarden die door de service worden ondersteund

Bekende waarden die door de service worden ondersteund

Bekende waarden die door de service worden ondersteund

Bekende waarden die door de service worden ondersteund

Bekende waarden die door de service worden ondersteund

Enums

Functies

Functiedetails

parseKeyVaultKeyIdentifier(string)

Parameters

Retouren