@azure/keyvault-keys package

Ein Client, der zum Ausführen kryptografischer Vorgänge für einen Azure Key Vault-Schlüssel oder einen lokalen JsonWebKey verwendet wird.

Der KeyClient bietet Methoden zum Verwalten von KeyVaultKey im Azure-Key Vault. Der Client unterstützt das Erstellen, Abrufen, Aktualisieren, Löschen, Löschen, Sichern, Wiederherstellen und Auflisten von KeyVaultKeys. Der Client unterstützt auch das Auflisten von DeletedKey für eine vorläufige Löschung aktivierte Azure-Key Vault.

Entschlüsselungsparameter für AES-CBC-Verschlüsselungsalgorithmen.

Verschlüsselungsparameter für AES-CBC-Verschlüsselungsalgorithmen.

Entschlüsselungsparameter für AES-GCM-Verschlüsselungsalgorithmen.

Verschlüsselungsparameter für AES-GCM-Verschlüsselungsalgorithmen.

Optionen für backupKey(string, BackupKeyOptions).

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginDeleteKey(string, BeginDeleteKeyOptions)

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createEcKey(string, CreateEcKeyOptions)

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createKey(string, string, CreateKeyOptions)

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createOctKey(string, CreateOctKeyOptions)

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createRsaKey(string, CreateRsaKeyOptions)

Die optionalen Parameter, die vom CryptographyClient des KeyVault akzeptiert werden

Eine Schnittstelle, die die Optionen der Kryptografie-API-Methoden darstellt. Weitere Informationen findest du unter CryptographyClient .

Optionen für decrypt(DecryptParameters, DecryptOptions).

Ergebnis des Vorgangs decrypt(DecryptParameters, DecryptOptions) .

Eine Schnittstelle, die einen gelöschten Key Vault Key darstellt.

Optionen für encrypt(EncryptParameters, EncryptOptions).

Ergebnis des Vorgangs encrypt(EncryptParameters, EncryptOptions) .

Optionen für getCryptographyClient.

Optionen für getDeletedKey(string, GetDeletedKeyOptions).

Optionen für getKey(string, GetKeyOptions).

Optionen für <xref:KeyClient.getRotationPolicy>.

Optionen für getRandomBytes

Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können importKey(string, JsonWebKey_2, ImportKeyOptions)

Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Die optionalen Parameter, die vom KeyClient des KeyVault akzeptiert werden

Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteKey(string, BeginDeleteKeyOptions) und übergeben werden können beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Eine Schnittstelle, die die Eigenschaften von KeyVaultKey darstellt

Die Richtlinienregeln, unter denen ein Schlüssel exportiert werden kann.

Eine Aktion und der zugehörige Trigger, die von Key Vault während der Lebensdauer eines Schlüssels ausgeführt werden.

Die vollständige Schlüsselrotationsrichtlinie, die zu einem Schlüssel gehört.

Die Eigenschaften einer Schlüsselrotationsrichtlinie, die der Client für einen bestimmten Schlüssel festlegen kann.

Sie können die Schlüsselrotationsrichtlinie auch auf ihre Standardwerte zurücksetzen, indem Sie lifetimeActions auf ein leeres Array festlegen.

Eine Schnittstelle, die einen Key Vault Key mit name, wert und KeyProperties darstellt.

Stellt die Segmente dar, die eine Key Vault Schlüssel-ID bilden.

Eine Schnittstelle, die optionale Parameter für ausgelagerte KeyClient-Vorgänge darstellt, die an listDeletedKeys(ListDeletedKeysOptions)übergeben werden.

Eine Schnittstelle, die optionale Parameter für ausgelagerte KeyClient-Vorgänge darstellt, die an listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)übergeben werden.

Eine Schnittstelle, die optionale Parameter für ausgelagerte KeyClient-Vorgänge darstellt, die an listPropertiesOfKeys(ListPropertiesOfKeysOptions)übergeben werden.

Eine Schnittstelle, die die Einstellungen für seitenseitige Iteration nachverfolgt

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zur Vervollständigung als auch nach Seite ermöglicht.

PollOperationState enthält eine Meinungsliste mit dem kleinsten Satz von Eigenschaften, die zum Definieren eines Abfragevorgangs mit langer Ausführungszeit erforderlich sind.

Während die Poller-Klasse als lokaler Steuerungsmechanismus fungiert, um einen Vorgang mit langer Ausführungszeit auszulösen, zu warten und möglicherweise abzubrechen, dokumentiert PollOperationState den Status des Remotevorgangs mit langer Ausführungsdauer.

Es sollte mindestens aktualisiert werden, wenn der Vorgang gestartet wird, wenn er abgeschlossen ist und wenn er abgebrochen wird. Implementierungen können jedoch eine beliebige andere Anzahl von Eigenschaften aufweisen, die aus anderen Gründen aktualisiert werden können.

Abstrakte Darstellung eines Pollers, der nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss.

Optionen für purgeDeletedKey(string, PurgeDeletedKeyOptions).

Optionen für releaseKey

Ergebnis des releaseKey-Vorgangs .

Optionen für restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Optionen für rotateKey

Entschlüsselungsparameter für RSA-Verschlüsselungsalgorithmen.

Verschlüsselungsparameter für RSA-Verschlüsselungsalgorithmen.

Optionen für sign(string, Uint8Array, SignOptions).

Ergebnis des Vorgangs sign(string, Uint8Array, SignOptions) .

Optionen für unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Ergebnis des Vorgangs <xref:unwrap> .

Optionen für updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Optionen für updateKeyRotationPolicy

Optionen für verifyData(string, Uint8Array, Uint8Array, VerifyOptions).

Optionen für verify(string, Uint8Array, Uint8Array, VerifyOptions).

Ergebnis des Vorgangs verify(string, Uint8Array, Uint8Array, VerifyOptions) .

Optionen für wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Ergebnis des Vorgangs <xref:wrap> .

Ein Union-Typ, der alle unterstützten AES-CBC-Verschlüsselungsalgorithmen darstellt.

Ein Union-Typ, der alle unterstützten AES-GCM-Verschlüsselungsalgorithmen darstellt.

Ein Typ, der alle derzeit unterstützten Entschlüsselungsparameter darstellt, die für verschiedene Verschlüsselungsalgorithmen gelten.

Definiert Werte für DeletionRecoveryLevel.
KnownDeletionRecoveryLevel kann austauschbar mit DeletionRecoveryLevel verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Löschbar: Gibt einen Tresorzustand an, in dem das Löschen ein irreversibler Vorgang ist, ohne die Möglichkeit zur Wiederherstellung. Diese Ebene entspricht keinem Schutz gegen einen Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren.
Wiederherstellbar+Löschbar: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch ein sofortiges und dauerhaftes Löschen (d. h. löschen) zulässt. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, es wird ein Löschvorgang angefordert oder das Abonnement gekündigt. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
Wiederherstellbar: Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen (d. h. Löschen) wiederhergestellt werden kann. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungszeitraums (90 Tage) und solange das Abonnement noch verfügbar ist. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
Recoverable+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb des Aufbewahrungszeitraums (90 Tage) wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
CustomizedRecoverable+Löschbar: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch das sofortige und dauerhafte Löschen zulässt (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, es wird ein Löschvorgang angefordert oder das Abonnement gekündigt.
CustomizedRecoverable: Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist.
CustomizedRecoverable+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederherstellbar ist, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht gekündigt werden kann.

Ein Typ, der alle derzeit unterstützten Verschlüsselungsparameter darstellt, die für verschiedene Verschlüsselungsalgorithmen gelten.

Definiert Werte für JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> kann austauschbar mit JsonWebKeyEncryptionAlgorithm verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

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

Definiert Werte für JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> kann austauschbar mit JsonWebKeyCurveName verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

P-256: Die NIST P-256 elliptische Kurve, AKA SECG-Kurve SECP256R1.
P-384: Die NIST P-384 elliptische Kurve, AKA SECG-Kurve SECP384R1.
P-521: Die elliptische Kurve NIST P-521, AKA SECG-Kurve SECP521R1.
P-256K: Die SECG SECP256K1 elliptische Kurve.

Definiert Werte für KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm kann austauschbar mit KeyEncryptionAlgorithm verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Definiert Werte für JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> kann austauschbar mit JsonWebKeyOperation verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export

Die Aktion, die ausgeführt wird.

Definiert Werte für JsonWebKeyType.
<xref:KnownJsonWebKeyType> kann austauschbar mit JsonWebKeyType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

EC: Elliptische Kurve.
EC-HSM: Elliptische Kurve mit einem privaten Schlüssel, der im HSM gespeichert ist.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA mit einem privaten Schlüssel, der im HSM gespeichert ist.
oct: Oktettsequenz (wird verwendet, um symmetrische Schlüssel darzustellen)
oct-HSM: Oktettsequenz (wird verwendet, um symmetrische Schlüssel darzustellen), die im HSM gespeichert wird.

Unterstützte Algorithmen zum Umbruch/Entpacken von Schlüsseln

Ein Union-Typ, der alle unterstützten RSA-Verschlüsselungsalgorithmen darstellt.

Definiert Werte für JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> kann austauschbar mit JsonWebKeySignatureAlgorithm verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

PS256: RSASSA-PSS mit SHA-256 und MGF1 mit SHA-256, wie in beschrieben https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS mit SHA-384 und MGF1 mit SHA-384, wie in beschrieben https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS mit SHA-512 und MGF1 mit SHA-512, wie in beschrieben https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 mit SHA-256, wie in beschrieben https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 mit SHA-384, wie in beschrieben https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 unter Verwendung von SHA-512 https://tools.ietf.org/html/rfc7518
RSNULL: Reserviert
ES256: ECDSA mit P-256 und SHA-256, wie in https://tools.ietf.org/html/rfc7518beschrieben.
ES384: ECDSA mit P-384 und SHA-384, wie in beschrieben https://tools.ietf.org/html/rfc7518
ES512: ECDSA mit P-521 und SHA-512, wie in beschrieben https://tools.ietf.org/html/rfc7518
ES256K: ECDSA mit P-256K und SHA-256, wie in beschrieben https://tools.ietf.org/html/rfc7518

Bekannte Werte von DeletionRecoveryLevel , die der Dienst akzeptiert.

Bekannte Werte von EncryptionAlgorithm , die der Dienst akzeptiert.

Bekannte Werte von <xref:JsonWebKeyCurveName> , die der Dienst akzeptiert.

Bekannte Werte von KeyExportEncryptionAlgorithm , die der Dienst akzeptiert.

Bekannte Werte von KeyOperation , die der Dienst akzeptiert.

Bekannte Werte von <xref:JsonWebKeyType> , die der Dienst akzeptiert.

Bekannte Werte von <xref:JsonWebKeySignatureAlgorithm> , die der Dienst akzeptiert.

Analysiert die angegebene Key Vault Schlüssel-ID. Ein Beispiel ist:

https://.vault.azure.net/keys//

Beim Analysieren der obigen ID gibt diese Funktion Folgendes zurück:

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