SecretClient class

  • Referenz
Paket:
@azure/keyvault-secrets

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 vorläufige Löschung aktivierte Azure-Key Vault.

Konstruktoren

SecretClient(string, TokenCredential, SecretClientOptions)

Erstellt eine Instanz von SecretClient.

Beispielverwendung:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

Eigenschaften

vaultUrl

Die Basis-URL des Tresors

Methoden

backupSecret(string, BackupSecretOptions)

Fordert an, dass eine Sicherung des angegebenen Geheimnisses auf den Client heruntergeladen wird. Alle Versionen des Geheimnisses werden heruntergeladen. Für diesen Vorgang ist die Berechtigung geheimnisse/sicherung erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Sichert das angegebene Geheimnis.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Löscht ein in Azure Key Vault gespeichertes Geheimnis. Diese Funktion gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Geheimnis gelöscht wird.

Für diesen Vorgang ist die Berechtigung geheimnisse/lösch erforderlich.

Beispielverwendung:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Löscht ein Geheimnis aus einem angegebenen Schlüsseltresor.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Stellt das gelöschte Geheimnis im angegebenen Tresor wieder her. Diese Funktion gibt einen Abrufvorgang mit langer Ausführungsdauer zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Geheimnis wiederhergestellt wurde.

Für diesen Vorgang ist die Berechtigung "Geheimnisse/Wiederherstellung" erforderlich.

Beispielverwendung:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Stellt das gelöschte Geheimnis in der neuesten Version wieder her.
getDeletedSecret(string, GetDeletedSecretOptions)

Die getDeletedSecret-Methode gibt das angegebene gelöschte Geheimnis zusammen mit seinen Attributen zurück. Für diesen Vorgang ist die Berechtigung "Geheimnisse/Abrufen" erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Ruft das angegebene gelöschte Geheimnis ab.
getSecret(string, GetSecretOptions)

Die getSecret-Methode gilt für alle geheimnissen, die in Azure Key Vault gespeichert sind. Für diesen Vorgang ist die Berechtigung "Geheimnisse/Abrufen" erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Rufen Sie ein angegebenes Geheimnis aus einem bestimmten Schlüsseltresor ab.
listDeletedSecrets(ListDeletedSecretsOptions)

Durchläuft die gelöschten Geheimnisse im Tresor. Der vollständige geheime Bezeichner und Attribute werden in der Antwort bereitgestellt. Für die Geheimnisse werden keine Werte zurückgegeben. Für diese Vorgänge ist die Berechtigung geheimnisse/listen erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Listet alle Geheimnisse im Tresor auf.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Durchläuft die neueste Version aller Geheimnisse im Tresor. Der vollständige geheime Bezeichner und Attribute werden in der Antwort bereitgestellt. Für die Geheimnisse werden keine Werte zurückgegeben. Für diese Vorgänge ist die Berechtigung geheimnisse/listen erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Listet alle Geheimnisse im Tresor auf.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Durchläuft alle Versionen des angegebenen Geheimnisses im Tresor. Der vollständige geheime Bezeichner und Attribute werden in der Antwort bereitgestellt. Für die Geheimnisse werden keine Werte zurückgegeben. Für diese Vorgänge ist die Berechtigung geheimnisse/listen erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Der Vorgang zum Löschen gelöschter Geheimnisse entfernt das Geheimnis dauerhaft, ohne dass eine Wiederherstellung möglich ist. Dieser Vorgang kann nur für einen Tresor mit aktiviertem vorläufigem Löschen aktiviert werden. Für diesen Vorgang ist die Berechtigung geheimnisse/bereinigen erforderlich.

Beispielverwendung:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Löscht das angegebene Geheimnis endgültig.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Stellt ein gesichertes Geheimnis und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Berechtigung Geheimnisse/Wiederherstellung erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Stellt ein gesichertes Geheimnis in einem Tresor wieder her.
setSecret(string, string, SetSecretOptions)

Die setSecret-Methode fügt dem Azure-Key Vault eine Geheimnis- oder Geheimnisversion hinzu. Wenn der benannte geheime Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des geheimen Schlüssels. Für diesen Vorgang ist die Berechtigung geheimnisse/set erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Fügt ein Geheimnis in einem angegebenen Schlüsseltresor hinzu.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Die updateSecret-Methode ändert die angegebenen Attribute eines vorhandenen gespeicherten Geheimnisses. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert einen geheimen Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang ist die Berechtigung geheimnisse/set erforderlich.

Beispielverwendung:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Aktualisierungen die Attribute, die einem angegebenen Geheimnis in einem bestimmten Schlüsseltresor zugeordnet sind.

Details zum Konstruktor

SecretClient(string, TokenCredential, SecretClientOptions)

Erstellt eine Instanz von SecretClient.

Beispielverwendung:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

Parameter

vaultUrl

string

Die Basis-URL für den Tresor. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault-Ressource verweist. Einzelheiten dazu finden Sie unter https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ein -Objekt, das die Schnittstelle implementiert, die TokenCredential zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity Paket, um Anmeldeinformationen zu erstellen, die Ihren Anforderungen entsprechen.

pipelineOptions
SecretClientOptions

Pipelineoptionen, die zum Konfigurieren Key Vault API-Anforderungen verwendet werden. Lassen Sie diesen Parameter aus, um die Standardpipelinekonfiguration zu verwenden.

Details zur Eigenschaft

vaultUrl

Die Basis-URL des Tresors

vaultUrl: string

Eigenschaftswert

string

Details zur Methode

backupSecret(string, BackupSecretOptions)

Fordert an, dass eine Sicherung des angegebenen Geheimnisses auf den Client heruntergeladen wird. Alle Versionen des Geheimnisses werden heruntergeladen. Für diesen Vorgang ist die Berechtigung geheimnisse/sicherung erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Sichert das angegebene Geheimnis.

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

Parameter

secretName

string

Der Name des Geheimnisses.

options
BackupSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Löscht ein in Azure Key Vault gespeichertes Geheimnis. Diese Funktion gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Geheimnis gelöscht wird.

Für diesen Vorgang ist die Berechtigung geheimnisse/lösch erforderlich.

Beispielverwendung:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Löscht ein Geheimnis aus einem angegebenen Schlüsseltresor.

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

Parameter

name

string

options
BeginDeleteSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Stellt das gelöschte Geheimnis im angegebenen Tresor wieder her. Diese Funktion gibt einen Abrufvorgang mit langer Ausführungsdauer zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Geheimnis wiederhergestellt wurde.

Für diesen Vorgang ist die Berechtigung "Geheimnisse/Wiederherstellung" erforderlich.

Beispielverwendung:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Stellt das gelöschte Geheimnis in der neuesten Version wieder her.

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

Parameter

name

string

options
BeginRecoverDeletedSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

Die getDeletedSecret-Methode gibt das angegebene gelöschte Geheimnis zusammen mit seinen Attributen zurück. Für diesen Vorgang ist die Berechtigung "Geheimnisse/Abrufen" erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Ruft das angegebene gelöschte Geheimnis ab.

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

Parameter

secretName

string

Der Name des Geheimnisses.

options
GetDeletedSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Die getSecret-Methode gilt für alle geheimnissen, die in Azure Key Vault gespeichert sind. Für diesen Vorgang ist die Berechtigung "Geheimnisse/Abrufen" erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Rufen Sie ein angegebenes Geheimnis aus einem bestimmten Schlüsseltresor ab.

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

Parameter

secretName

string

Der Name des Geheimnisses.

options
GetSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Durchläuft die gelöschten Geheimnisse im Tresor. Der vollständige geheime Bezeichner und Attribute werden in der Antwort bereitgestellt. Für die Geheimnisse werden keine Werte zurückgegeben. Für diese Vorgänge ist die Berechtigung geheimnisse/listen erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Listet alle Geheimnisse im Tresor auf.

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

Parameter

options
ListDeletedSecretsOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Durchläuft die neueste Version aller Geheimnisse im Tresor. Der vollständige geheime Bezeichner und Attribute werden in der Antwort bereitgestellt. Für die Geheimnisse werden keine Werte zurückgegeben. Für diese Vorgänge ist die Berechtigung geheimnisse/listen erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Listet alle Geheimnisse im Tresor auf.

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Parameter

options
ListPropertiesOfSecretsOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Durchläuft alle Versionen des angegebenen Geheimnisses im Tresor. Der vollständige geheime Bezeichner und Attribute werden in der Antwort bereitgestellt. Für die Geheimnisse werden keine Werte zurückgegeben. Für diese Vorgänge ist die Berechtigung geheimnisse/listen erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Parameter

secretName

string

Name des Geheimnisses, für das Versionen abgerufen werden sollen.

options
ListPropertiesOfSecretVersionsOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Der Vorgang zum Löschen gelöschter Geheimnisse entfernt das Geheimnis dauerhaft, ohne dass eine Wiederherstellung möglich ist. Dieser Vorgang kann nur für einen Tresor mit aktiviertem vorläufigem Löschen aktiviert werden. Für diesen Vorgang ist die Berechtigung geheimnisse/bereinigen erforderlich.

Beispielverwendung:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Löscht das angegebene Geheimnis endgültig.

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

Parameter

secretName

string

Der Name des Geheimnisses.

options
PurgeDeletedSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Stellt ein gesichertes Geheimnis und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Berechtigung Geheimnisse/Wiederherstellung erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Stellt ein gesichertes Geheimnis in einem Tresor wieder her.

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

Parameter

secretBundleBackup

Uint8Array

Das Sicherungsblob, das einem geheimen Bündel zugeordnet ist.

options
RestoreSecretBackupOptions

Die optionalen Parameter.

Gibt zurück

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Die setSecret-Methode fügt dem Azure-Key Vault eine Geheimnis- oder Geheimnisversion hinzu. Wenn der benannte geheime Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des geheimen Schlüssels. Für diesen Vorgang ist die Berechtigung geheimnisse/set erforderlich.

Beispielverwendung:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Fügt ein Geheimnis in einem angegebenen Schlüsseltresor hinzu.

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

Parameter

secretName

string

Der Name des Geheimnisses.

value

string

Der Wert des geheimen Schlüssels.

options
SetSecretOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Die updateSecret-Methode ändert die angegebenen Attribute eines vorhandenen gespeicherten Geheimnisses. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert einen geheimen Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang ist die Berechtigung geheimnisse/set erforderlich.

Beispielverwendung:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Aktualisierungen die Attribute, die einem angegebenen Geheimnis in einem bestimmten Schlüsseltresor zugeordnet sind.

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

Parameter

secretName

string

Der Name des Geheimnisses.

secretVersion

string

Die Version des Geheimnisses.

options
UpdateSecretPropertiesOptions

Die optionalen Parameter.

Gibt zurück

Promise<SecretProperties>