@azure/keyvault-secrets package
Klassen
SecretClient |
Der SecretClient stellt Methoden zum Verwalten KeyVaultSecret- im Azure Key Vault bereit. Der Client unterstützt das Erstellen, Abrufen, Aktualisieren, Löschen, Löschen, Sichern, Wiederherstellen und Auflisten von KeyVaultSecrets. Der Client unterstützt auch die Auflistung DeletedSecret- für einen vorläufig aktivierten Azure Key Vault. |
Schnittstellen
BackupSecretOptions |
Optionen für <xref:backupSecretOptions>. |
BeginDeleteSecretOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteSecret(string, BeginDeleteSecretOptions) übergeben werden können |
BeginRecoverDeletedSecretOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) übergeben werden können |
DeletedSecret |
Eine Schnittstelle, die einen gelöschten KeyVault Secret darstellt. |
GetDeletedSecretOptions |
Optionen für getDeletedSecret(string, GetDeletedSecretOptions). |
GetSecretOptions |
Optionen für getSecret(string, GetSecretOptions). |
KeyVaultSecret |
Eine Schnittstelle, die einen KeyVault Secret mit dem Namen, dem Wert und SecretPropertiesdarstellt. |
KeyVaultSecretIdentifier |
Stellt die Segmente dar, die eine Schlüsseltresorschlüssel-ID erstellen. |
ListDeletedSecretsOptions |
Optionen für listDeletedSecrets(ListDeletedSecretsOptions). |
ListPropertiesOfSecretVersionsOptions |
Optionen für listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions). |
ListPropertiesOfSecretsOptions |
Optionen für listPropertiesOfSecrets(ListPropertiesOfSecretsOptions). |
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. |
PurgeDeletedSecretOptions |
Optionen für purgeDeletedSecret(string, PurgeDeletedSecretOptions). |
RestoreSecretBackupOptions |
Optionen für restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions). |
SecretClientOptions |
Die optionalen Parameter, die vom KeyVault-KeyClient akzeptiert werden |
SecretPollerOptions |
Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteSecret(string, BeginDeleteSecretOptions) und <xref:beginRecoverDeletedKey>übergeben werden können. |
SecretProperties |
Eine Schnittstelle, die die Eigenschaften eines KeyVaultSecretdarstellt. |
SetSecretOptions |
Optionen für setSecret(string, string, SetSecretOptions). |
UpdateSecretPropertiesOptions |
Optionen für updateSecretProperties(string, string, UpdateSecretPropertiesOptions). |
Typaliase
DeletionRecoveryLevel |
Definiert Werte für DeletionRecoveryLevel. 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.) |
Enumerationen
KnownDeletionRecoveryLevel |
Bekannte Werte von DeletionRecoveryLevel, die der Dienst akzeptiert. |
Functions
parse |
Analysiert die angegebene Schlüsseltresorschlüssel-ID. Beispiel: https://.vault.azure.net/secrets// Bei der Analyse der obigen ID gibt diese Funktion Folgendes zurück:
|
Details zur Funktion
parseKeyVaultSecretIdentifier(string)
Analysiert die angegebene Schlüsseltresorschlüssel-ID. Beispiel:
https://.vault.azure.net/secrets//
Bei der Analyse der obigen ID gibt diese Funktion Folgendes zurück:
{
sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
vaultUrl: "https://<keyvault-name>.vault.azure.net",
version: "<unique-version-id>",
name: "<secret-name>"
}
function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier
Parameter
- id
-
string
Die ID des Schlüsseltresorschlüssels.