@azure/keyvault-secrets package

Der SecretClient stellt Methoden zur Verfügung, um KeyVaultSecret im Azure Key Vault zu verwalten. Der Client unterstützt das Erstellen, Abrufen, Aktualisieren, Löschen, Löschen, Sichern, Wiederherstellen und Auflisten von KeyVaultSecrets. Der Client unterstützt außerdem die Auflistung von DeletedSecret für eine Soft-Delete-aktivierte Azure Key Vault.

Optionen für <xref:backupSecretOptions>.

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

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

Eine Schnittstelle, die einen gelöschten KeyVault Secret darstellt.

Optionen für getDeletedSecret(string, GetDeletedSecretOptions).

Optionen für getSecret(string, GetSecretOptions).

Eine Schnittstelle, die einen KeyVault Secret mit dem Namen, dem Wert und SecretPropertiesdarstellt.

Repräsentiert die Segmente, aus denen eine Key Vault Secret ID besteht.

Optionen für listDeletedSecrets(ListDeletedSecretsOptions).

Optionen für listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Optionen für listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

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

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.

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.

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

Optionen für purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Optionen für restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Die optionalen Parameter, die vom KeyVault-KeyClient akzeptiert werden

Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteSecret(string, BeginDeleteSecretOptions) und <xref:beginRecoverDeletedKey>übergeben werden können.

Eine Schnittstelle, die die Eigenschaften eines KeyVaultSecretdarstellt.

Optionen für setSecret(string, string, SetSecretOptions).

Optionen für updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Der Medientyp (MIME-Typ) des Zertifikats. Wenn ein unterstütztes Format angegeben ist, wird der Zertifikatsinhalt in das angeforderte Format konvertiert. Derzeit wird nur die Umwandlung von PFX in PEM unterstützt.

Gibt die Löschwiederherstellungsebene wieder, die derzeit für geheime Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der geheime Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.
KnownDeletionRecoveryLevel austauschbar mit DeleteRecoveryLevel verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

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.)
Wiederherstellbare+bereinigungsfähige: Gibt einen Tresorstatus an, in dem die Löschung wiederherstellbar ist und die auch sofortige und dauerhafte Löschung (d. h. Löschvorgang) zulässt. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, ein Bereinigungsvorgang wird angefordert, oder das Abonnement wird gekündigt. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt.
Wiederherstellbare: Gibt einen Tresorstatus an, in dem die Löschung ohne die Möglichkeit zum sofortigen und dauerhaften Löschen (d. h. Löschen) wiederhergestellt werden kann. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und während das Abonnement noch verfügbar ist. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt.
Wiederherstellbare+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem die Löschung innerhalb des Aufbewahrungsintervalls (90 Tage), sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft storniert werden kann. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt.
CustomRecoverable+Purgeable: Gibt einen Tresorstatus an, in dem die Löschung wiederherstellbar ist und die auch sofortige und dauerhafte Löschung ermöglicht (d. h. 7 <= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, ein Löschvorgang wird angefordert, oder das Abonnement wird gekündigt.
CustomRecoverable: Gibt einen Tresorstatus an, in dem die Löschung ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (d. h. 7 <= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und während der Verfügbarkeit des Abonnements.
CustomRecoverable+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem löschungsfähig, sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft storniert werden kann, wenn 7 <= SoftDeleteRetentionInDays < 90. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht storniert werden kann.

Bekannte Werte von ContentType, die der Dienst akzeptiert.

Gibt die Löschwiederherstellungsebene wieder, die derzeit für geheime Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der geheime Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.

Analysiert die gegebene Key Vault Secret ID. Ein Beispiel ist:

https://< keyvault-name.vault.azure.net/secrets/>< secret-name>/<unique-version-id>

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

Die Konfiguration @azure/logger dieses Pakets.