@azure/keyvault-secrets package

Klassen

SecretClient

Der SecretClient stellt Methoden zum Verwalten von 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 das Auflisten von DeletedSecret für eine azure-Key Vault, die vorläufiges Löschen aktiviert ist.

Schnittstellen

BackupSecretOptions	Optionen für <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Eine Schnittstelle, die ein gelöschtes KeyVault-Geheimnis darstellt.
GetDeletedSecretOptions	Optionen für getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Optionen für getSecret(string, GetSecretOptions).
KeyVaultSecret	Eine Schnittstelle, die ein KeyVault-Geheimnis mit seinem Namen, Wert und SecretProperties darstellt.
KeyVaultSecretIdentifier	Stellt die Segmente dar, aus denen eine Key Vault Geheimnis-ID besteht.
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 ausgelagerte Iteration nachverfolgt.
PagedAsyncIterableIterator	Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl bis zum Abschluss als auch nach Seite zulässt.
PollOperationState	PollOperationState enthält eine liste der kleinsten Eigenschaften, die zum Definieren von Abfragevorgängen mit langer Ausführungszeit erforderlich sind. Während die Poller-Klasse als lokaler Steuerungsmechanismus zum Starten des Auslösens, Wartens und Abbrechen eines vorgangs mit langer Ausführung funktioniert, 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, 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 KeyClient des KeyVault 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 KeyVaultSecret darstellt.
SetSecretOptions	Optionen für setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Optionen für updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Typaliase

DeletionRecoveryLevel

Definiert Werte für DeletionRecoveryLevel. KnownDeletionRecoveryLevel kann austauschbar mit DeletionRecoveryLevel verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Bereinigend: Gibt einen Tresorzustand an, in dem das Löschen ein irreversibler Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Ebene entspricht keinem Schutz vor einem Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn Sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren. Wiederherstellbar+Bereinigungsfähig: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch das sofortige und dauerhafte 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, ein Bereinigungsvorgang wird angefordert oder das Abonnement wird gekündigt. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird Wiederherstellbar: Gibt einen Tresorzustand an, in dem der Löschvorgang wiederhergestellt werden kann, ohne dass die Möglichkeit einer sofortigen und dauerhaften Löschung (d. h. bereinigen) besteht. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und solange das Abonnement noch verfügbar ist. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird Wiederherstellbar+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem der Löschvorgang innerhalb eines Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, sofortiges und dauerhaftes Löschen (d. h. Löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird CustomizedRecoverable+Purgeable: 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 Bereinigungsvorgang angefordert oder das Abonnement gekündigt. CustomizedRecoverable: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, ohne die Möglichkeit eines sofortigen und dauerhaften Löschens (d. h. Löschvorgang, wenn 7< = SoftDeleteRetentionInDays < 90) ist. 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 Abonnementzustand an, in dem das Löschen wiederhergestellt werden kann, sofortiges und dauerhaftes 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.

Enumerationen

KnownDeletionRecoveryLevel

Bekannte Werte von DeletionRecoveryLevel , die der Dienst akzeptiert.

Functions

parseKeyVaultSecretIdentifier(string)

Analysiert die angegebene Key Vault Geheimnis-ID. Ein Beispiel hierfür ist: 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>" }

Details zur Funktion

parseKeyVaultSecretIdentifier(string)

Analysiert die angegebene Key Vault Geheimnis-ID. Ein Beispiel hierfür ist:

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 Key Vault Geheimnisses.

Gibt zurück

KeyVaultSecretIdentifier