@azure/keyvault-keys package
Klassen
| CryptographyClient |
Ein Client, der zum Ausführen kryptografischer Vorgänge für einen Azure Key Vault-Schlüssel oder einen lokalen JsonWebKey verwendet wird. |
| KeyClient |
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. |
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 übergeben werden können beginDeleteKey(string, BeginDeleteKeyOptions) |
| BeginRecoverDeletedKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| CreateEcKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createEcKey(string, CreateEcKeyOptions) |
| CreateKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createKey(string, string, CreateKeyOptions) |
| CreateOctKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createOctKey(string, CreateOctKeyOptions) |
| CreateRsaKeyOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können createRsaKey(string, CreateRsaKeyOptions) |
| CryptographyClientOptions |
Die optionalen Parameter, die vom CryptographyClient des KeyVault akzeptiert werden |
| CryptographyOptions |
Eine Schnittstelle, die die Optionen der Kryptografie-API-Methoden darstellt. Weitere Informationen findest du unter CryptographyClient . |
| DecryptOptions |
Optionen für decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
Ergebnis des Vorgangs decrypt(DecryptParameters, DecryptOptions) . |
| DeletedKey |
Eine Schnittstelle, die einen gelöschten Key Vault Key darstellt. |
| EncryptOptions |
Optionen für encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
Ergebnis des Vorgangs encrypt(EncryptParameters, EncryptOptions) . |
| GetCryptographyClientOptions |
Optionen für getCryptographyClient. |
| GetDeletedKeyOptions |
Optionen für getDeletedKey(string, GetDeletedKeyOptions). |
| 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 übergeben werden können importKey(string, JsonWebKey_2, ImportKeyOptions) |
| JsonWebKey |
Ab http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
Die optionalen Parameter, die vom KeyClient des KeyVault akzeptiert werden |
| KeyPollerOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteKey(string, BeginDeleteKeyOptions) und übergeben werden können beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| KeyProperties |
Eine Schnittstelle, die die Eigenschaften von KeyVaultKey darstellt |
| KeyReleasePolicy |
Die Richtlinienregeln, unter denen ein Schlüssel exportiert werden kann. |
| KeyRotationLifetimeAction |
Eine Aktion und der zugehörige Trigger, die von Key Vault während der Lebensdauer eines Schlüssels ausgeführt werden. |
| KeyRotationPolicy |
Die vollständige Schlüsselrotationsrichtlinie, die zu einem Schlüssel gehört. |
| KeyRotationPolicyProperties |
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. |
| KeyVaultKey |
Eine Schnittstelle, die einen Key Vault Key mit name, wert und KeyProperties darstellt. |
| KeyVaultKeyIdentifier |
Stellt die Segmente dar, die eine Key Vault Schlüssel-ID bilden. |
| ListDeletedKeysOptions |
Eine Schnittstelle, die optionale Parameter für ausgelagerte KeyClient-Vorgänge darstellt, die an listDeletedKeys(ListDeletedKeysOptions)übergeben werden. |
| ListPropertiesOfKeyVersionsOptions |
Eine Schnittstelle, die optionale Parameter für ausgelagerte KeyClient-Vorgänge darstellt, die an listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)übergeben werden. |
| ListPropertiesOfKeysOptions |
Eine Schnittstelle, die optionale Parameter für ausgelagerte KeyClient-Vorgänge darstellt, die an listPropertiesOfKeys(ListPropertiesOfKeysOptions)übergeben werden. |
| PageSettings |
Eine Schnittstelle, die die Einstellungen für seitenseitige Iteration nachverfolgt |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zur Vervollständigung als auch nach Seite ermöglicht. |
| PollOperationState |
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. |
| PollerLike |
Abstrakte Darstellung eines Pollers, der 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 Vorgangs sign(string, Uint8Array, SignOptions) . |
| UnwrapKeyOptions |
Optionen für unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
Ergebnis des Vorgangs <xref:unwrap> . |
| 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 Vorgangs verify(string, Uint8Array, Uint8Array, VerifyOptions) . |
| WrapKeyOptions |
Optionen für wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| WrapResult |
Ergebnis des Vorgangs <xref:wrap> . |
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, die für verschiedene Verschlüsselungsalgorithmen gelten. |
| DeletionRecoveryLevel |
Definiert Werte für DeletionRecoveryLevel. 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. |
| EncryptParameters |
Ein Typ, der alle derzeit unterstützten Verschlüsselungsparameter darstellt, die für verschiedene Verschlüsselungsalgorithmen gelten. |
| EncryptionAlgorithm |
Definiert Werte für JsonWebKeyEncryptionAlgorithm. Vom Dienst unterstützte bekannte Werte
RSA-OAEP |
| KeyCurveName |
Definiert Werte für JsonWebKeyCurveName. Vom Dienst unterstützte bekannte Werte
P-256: Die NIST P-256 elliptische Kurve, AKA SECG-Kurve SECP256R1. |
| KeyExportEncryptionAlgorithm |
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 |
| KeyOperation |
Definiert Werte für JsonWebKeyOperation. Vom Dienst unterstützte bekannte Werte
encrypt |
| KeyRotationPolicyAction |
Die Aktion, die ausgeführt wird. |
| KeyType |
Definiert Werte für JsonWebKeyType. Vom Dienst unterstützte bekannte Werte
EC: Elliptische Kurve. |
| KeyWrapAlgorithm |
Unterstützte Algorithmen zum Umbruch/Entpacken von Schlüsseln |
| RsaEncryptionAlgorithm |
Ein Union-Typ, der alle unterstützten RSA-Verschlüsselungsalgorithmen darstellt. |
| SignatureAlgorithm |
Definiert Werte für JsonWebKeySignatureAlgorithm. 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 |
Enumerationen
| KnownDeletionRecoveryLevel |
Bekannte Werte von DeletionRecoveryLevel , die der Dienst akzeptiert. |
| KnownEncryptionAlgorithms |
Bekannte Werte von EncryptionAlgorithm , die der Dienst akzeptiert. |
| KnownKeyCurveNames |
Bekannte Werte von <xref:JsonWebKeyCurveName> , die der Dienst akzeptiert. |
| KnownKeyExportEncryptionAlgorithm |
Bekannte Werte von KeyExportEncryptionAlgorithm , die der Dienst akzeptiert. |
| KnownKeyOperations |
Bekannte Werte von KeyOperation , die der Dienst akzeptiert. |
| KnownKeyTypes |
Bekannte Werte von <xref:JsonWebKeyType> , die der Dienst akzeptiert. |
| KnownSignatureAlgorithms |
Bekannte Werte von <xref:JsonWebKeySignatureAlgorithm> , die der Dienst akzeptiert. |
Functions
| parse |
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: |
Details zur Funktion
parseKeyVaultKeyIdentifier(string)
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>"
}
function parseKeyVaultKeyIdentifier(id: string): KeyVaultKeyIdentifierParameter
- id
-
string
Die ID des Key Vault-Schlüssels.