@azure/keyvault-keys package
Klassen
| CryptographyClient |
Ein Client, der zum Ausführen kryptografischer Vorgänge auf einem Azure Key Vault-Schlüssel oder einem lokalen JsonWebKey-verwendet wird. |
| KeyClient |
Der KeyClient stellt Methoden zum Verwalten KeyVaultKey- im Azure Key Vault bereit. 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 DeletedKey- für einen vorläufig aktivierten Azure Key Vault. |
Schnittstellen
| AesCbcDecryptParameters |
Entschlüsselungsparameter für AES-CBC Verschlüsselungsalgorithmen. |
| AesCbcEncryptParameters |
Verschlüsselungsparameter für AES-CBC Verschlüsselungsalgorithmen. |
| AesGcmDecryptParameters |
Entschlüsselungsparameter für AES-GCM Verschlüsselungsalgorithmen. |
| AesGcmEncryptParameters |
Verschlüsselungsparameter für AES-GCM Verschlüsselungsalgorithmen. |
| BackupKeyOptions |
Optionen für backupKey(string, BackupKeyOptions). |
| BeginDeleteKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteKey(string, BeginDeleteKeyOptions) übergeben werden können |
| BeginRecoverDeletedKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) übergeben werden können |
| CreateEcKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an createEcKey(string, CreateEcKeyOptions) übergeben werden können |
| CreateKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an createKey(string, string, CreateKeyOptions) übergeben werden können |
| CreateOctKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an createOctKey(string, CreateOctKeyOptions) übergeben werden können |
| CreateRsaKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an createRsaKey(string, CreateRsaKeyOptions) übergeben werden können |
| CryptographyClientOptions |
Die optionalen Parameter, die vom CryptographyClient von KeyVault akzeptiert werden |
| CryptographyOptions |
Eine Schnittstelle, die die Optionen der Kryptografie-API-Methoden darstellt, wechseln Sie zum CryptographyClient-, um weitere Informationen zu erfahren. |
| DecryptOptions |
Optionen für decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
Ergebnis des decrypt(DecryptParameters, DecryptOptions) Vorgangs. |
| DeletedKey |
Eine Schnittstelle, die einen gelöschten Key Vault Key darstellt. |
| EncryptOptions |
Optionen für encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
Ergebnis des encrypt(EncryptParameters, EncryptOptions) Vorgangs. |
| GetCryptographyClientOptions |
Optionen für getCryptographyClient. |
| GetDeletedKeyOptions |
Optionen für getDeletedKey(string, GetDeletedKeyOptions). |
| GetKeyAttestationOptions |
Optionen für getKeyAttestation(string, GetKeyAttestationOptions). |
| GetKeyOptions |
Optionen für getKey(string, GetKeyOptions). |
| GetKeyRotationPolicyOptions |
Optionen für <xref:KeyClient.getRotationPolicy> |
| GetRandomBytesOptions |
Optionen für getRandomBytes- |
| ImportKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an importKey(string, JsonWebKey, ImportKeyOptions) übergeben werden können |
| JsonWebKey |
Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyAttestation |
Eine Schnittstelle, die die Eigenschaften des Nachweises eines Schlüssels darstellt |
| KeyClientOptions |
Die optionalen Parameter, die vom KeyVault-KeyClient akzeptiert werden |
| KeyPollerOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteKey(string, BeginDeleteKeyOptions) und beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) übergeben werden können |
| KeyProperties |
Eine Schnittstelle, die die Eigenschaften von KeyVaultKey- |
| KeyReleasePolicy |
Die Richtlinienregeln, unter denen ein Schlüssel exportiert werden kann. |
| KeyRotationLifetimeAction |
Eine Aktion und der entsprechende Trigger, der von Key Vault während der Lebensdauer eines Schlüssels ausgeführt wird. |
| KeyRotationPolicy |
Die vollständige Schlüsseldrehungsrichtlinie, die zu einem Schlüssel gehört. |
| KeyRotationPolicyProperties |
Die Eigenschaften einer Schlüsseldrehungsrichtlinie, die der Client für einen bestimmten Schlüssel festlegen kann. Sie können die Schlüsseldrehungsrichtlinie auch auf ihre Standardwerte zurücksetzen, indem Sie lifetimeActions auf ein leeres Array festlegen. |
| KeyVaultKey |
Eine Schnittstelle, die einen Key Vault Key mit dem Namen, dem Wert und KeyProperties-darstellt. |
| KeyVaultKeyIdentifier |
Stellt die Segmente dar, die eine Key Vault-Schlüssel-ID erstellen. |
| ListDeletedKeysOptions |
Eine Schnittstelle, die optionale Parameter für KeyClient-Seitenvorgänge darstellt, die an listDeletedKeys(ListDeletedKeysOptions)übergeben werden. |
| ListPropertiesOfKeyVersionsOptions |
Eine Schnittstelle, die optionale Parameter für KeyClient-Seitenvorgänge darstellt, die an listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)übergeben werden. |
| ListPropertiesOfKeysOptions |
Eine Schnittstelle, die optionale Parameter für KeyClient-Seitenvorgänge darstellt, die an listPropertiesOfKeys(ListPropertiesOfKeysOptions)übergeben werden. |
| PageSettings |
Eine Schnittstelle, die die Einstellungen für die seitenseitige Iteration nachverfolgt |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| PollOperationState |
PollOperationState enthält eine Meinungsliste der kleinsten Gruppe von Eigenschaften, die zum Definieren eines Abfragevorgangs mit langer Ausführung erforderlich sind. Während die Poller-Klasse als lokaler Steuerungsmechanismus funktioniert, um mit dem Auslösen zu beginnen, warten und möglicherweise einen Vorgang mit langer Ausführung abzubrechen, dokumentiert der PollOperationState den Status des Remote-Vorgangs für lange Ausführung. Es sollte mindestens aktualisiert werden, wenn der Vorgang gestartet wird, wann er beendet ist und wann er abgebrochen wird. Implementierungen können jedoch eine beliebige andere Anzahl von Eigenschaften aufweisen, die aus anderen Gründen aktualisiert werden können. |
| PollerLike |
Abstrakte Darstellung eines Pollers, die nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss. |
| PurgeDeletedKeyOptions |
Optionen für purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
Optionen für releaseKey- |
| ReleaseKeyResult |
Ergebnis des releaseKey--Vorgangs. |
| RestoreKeyBackupOptions |
Optionen für restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
| RotateKeyOptions |
Optionen für rotateKey- |
| RsaDecryptParameters |
Entschlüsselungsparameter für RSA-Verschlüsselungsalgorithmen. |
| RsaEncryptParameters |
Verschlüsselungsparameter für RSA-Verschlüsselungsalgorithmen. |
| SignOptions |
Optionen für sign(string, Uint8Array, SignOptions). |
| SignResult |
Ergebnis des sign(string, Uint8Array, SignOptions) Vorgangs. |
| UnwrapKeyOptions |
Optionen für unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
Ergebnis des <xref:unwrap> Vorgangs. |
| UpdateKeyPropertiesOptions |
Optionen für updateKeyProperties(string, string, UpdateKeyPropertiesOptions). |
| UpdateKeyRotationPolicyOptions |
Optionen für updateKeyRotationPolicy |
| VerifyDataOptions |
Optionen für verifyData(string, Uint8Array, Uint8Array, VerifyOptions) |
| VerifyOptions |
Optionen für verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| VerifyResult |
Ergebnis des verify(string, Uint8Array, Uint8Array, VerifyOptions) Vorgangs. |
| WrapKeyOptions |
Optionen für wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| WrapResult |
Ergebnis des <xref:wrap> Vorgangs. |
Typaliase
| AesCbcEncryptionAlgorithm |
Ein Union-Typ, der alle unterstützten AES-CBC Verschlüsselungsalgorithmen darstellt. |
| AesGcmEncryptionAlgorithm |
Ein Union-Typ, der alle unterstützten AES-GCM Verschlüsselungsalgorithmen darstellt. |
| DecryptParameters |
Ein Typ, der alle derzeit unterstützten Entschlüsselungsparameter darstellt, während sie auf verschiedene Verschlüsselungsalgorithmen angewendet werden. |
| DeletionRecoveryLevel |
Gibt die Löschwiederherstellungsebene wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen. Bekannte Werte, die vom Dienst unterstützt werden
bereinigungsfähig: Gibt einen Tresorstatus an, in dem das Löschen ein unumkehrbarer Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Stufe entspricht keinem Schutz vor einem Löschvorgang; die Daten werden unwiderruflich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher akzeptieren (Tresor, Ressourcengruppe, Abonnement usw.) |
| EncryptParameters |
Ein Typ, der alle derzeit unterstützten Verschlüsselungsparameter darstellt, während sie auf verschiedene Verschlüsselungsalgorithmen angewendet werden. |
| EncryptionAlgorithm |
Ein Algorithmus, der für die Verschlüsselung und Entschlüsselung verwendet wird. Bekannte Werte, die vom Dienst unterstützt werden
RSA-OAEP-: [Nicht empfohlen] RSAES unter Verwendung des optimalen asymmetrischen Verschlüsselungsabstands (OAEP), wie in https://tools.ietf.org/html/rfc3447beschrieben, mit den standardparametern, die in RFC 3447 in Abschnitt A.2.1 angegeben sind. Diese Standardparameter verwenden eine Hashfunktion von SHA-1 und eine Maskengenerierungsfunktion von MGF1 mit SHA-1. Microsoft empfiehlt für mehr Sicherheit, RSA_OAEP_256 oder stärkere Algorithmen zu verwenden. Microsoft nicht empfehlen, RSA_OAEP zu empfehlen, die ausschließlich aus Gründen der Abwärtskompatibilität enthalten ist. RSA_OAEP verwendet SHA1, das bekannte Kollisionsprobleme hat. |
| KeyCurveName |
Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName. Bekannte Werte, die vom Dienst unterstützt werden
P-256: Die NIST P-256 elliptische Kurve, AKA SECG-Kurve SECP256R1. |
| KeyExportEncryptionAlgorithm |
Definiert Werte für KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm austauschbar mit KeyEncryptionAlgorithm verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
JSON-Webschlüsselvorgänge. Weitere Informationen finden Sie unter JsonWebKeyOperation. Bekannte Werte, die vom Dienst unterstützt werden
verschlüsseln: Gibt an, dass der Schlüssel zum Verschlüsseln verwendet werden kann. |
| KeyRotationPolicyAction |
Die Aktion, die ausgeführt wird. |
| KeyType |
JsonWebKey Key Type (kty), wie in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40definiert. Bekannte Werte, die vom Dienst unterstützt werden
EC-: Elliptische Kurve. |
| KeyWrapAlgorithm |
Unterstützte Algorithmen für den Schlüsselumbruch/Entschlüsselung |
| RsaEncryptionAlgorithm |
Ein Union-Typ, der alle unterstützten RSA-Verschlüsselungsalgorithmen darstellt. |
| SignatureAlgorithm |
Der Signatur-/Überprüfungsalgorithmusbezeichner. Weitere Informationen zu möglichen Algorithmustypen finden Sie unter JsonWebKeySignatureAlgorithm. Bekannte Werte, die vom Dienst unterstützt werden
PS256: RSASSA-PSS mit SHA-256 und MGF1 mit SHA-256, wie in https://tools.ietf.org/html/rfc7518 |
Enumerationen
| KnownDeletionRecoveryLevel |
Gibt die Löschwiederherstellungsebene wieder, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls löschen. |
| KnownEncryptionAlgorithms |
Ein Algorithmus, der für die Verschlüsselung und Entschlüsselung verwendet wird. |
| KnownKeyCurveNames |
Elliptische Kurvenname. Gültige Werte finden Sie unter JsonWebKeyCurveName. |
| KnownKeyExportEncryptionAlgorithm |
Der Verschlüsselungsalgorithmus zum Schutz des exportierten Schlüsselmaterials |
| KnownKeyOperations |
Bekannte Werte von KeyOperation, die der Dienst akzeptiert. |
| KnownKeyTypes |
JsonWebKey Key Type (kty), wie in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40definiert. |
| KnownSignatureAlgorithms |
Der Signatur-/Überprüfungsalgorithmusbezeichner. Weitere Informationen zu möglichen Algorithmustypen finden Sie unter JsonWebKeySignatureAlgorithm. |
Functions
| parse |
Analysiert die angegebene Key Vault-Schlüssel-ID. Beispiel: https://< keyvault-name.vault.azure.net/keys/<> key-name>/<unique-version-id> Bei der Analyse der obigen ID gibt diese Funktion Folgendes zurück: |
Details zur Funktion
parseKeyVaultKeyIdentifier(string)
Analysiert die angegebene Key Vault-Schlüssel-ID. Beispiel:
https://< keyvault-name.vault.azure.net/keys/<> key-name>/<unique-version-id>
Bei der Analyse 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>"
}
function parseKeyVaultKeyIdentifier(id: string): KeyVaultKeyIdentifierParameter
- id
-
string
Die ID des Schlüsseltresorschlüssels.