SecretClient class
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.
Konstruktoren
Secret |
Erstellt eine Instanz von SecretClient. Beispielverwendung:
|
Eigenschaften
vault |
Die Basis-URL zum Tresor |
Methoden
backup |
Fordert an, dass eine Sicherung des angegebenen geheimen Schlüssels auf den Client heruntergeladen wird. Alle Versionen des geheimen Schlüssels werden heruntergeladen. Für diesen Vorgang sind die Geheim-/Sicherungsberechtigungen erforderlich. Beispielverwendung:
Sichert den angegebenen geheimen Schlüssel. |
begin |
Löscht einen geheimen Schlüssel, der in Azure Key Vault gespeichert ist. Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der geheime Schlüssel gelöscht wird. Für diesen Vorgang sind die Berechtigung "Geheime Schlüssel/Löschvorgänge" erforderlich. Beispielverwendung:
Löscht einen geheimen Schlüssel aus einem angegebenen Schlüsseltresor. |
begin |
Stellt den gelöschten Geheimschlüssel im angegebenen Tresor wieder her. Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der geheime Schlüssel wiederhergestellt wird. Für diesen Vorgang sind die Geheimen/Wiederherstellungsberechtigungen erforderlich. Beispielverwendung:
Stellt den gelöschten Geheimschlüssel auf die neueste Version wieder her. |
get |
Die getDeletedSecret-Methode gibt den angegebenen gelöschten Geheimschlüssel zusammen mit seinen Attributen zurück. Für diesen Vorgang sind die Geheimen/Abrufen-Berechtigungen erforderlich. Beispielverwendung:
Ruft den angegebenen gelöschten geheimen Schlüssel ab. |
get |
Die getSecret-Methode gilt für alle geheimen Daten, die in Azure Key Vault gespeichert sind. Für diesen Vorgang sind die Geheimen/Abrufen-Berechtigungen erforderlich. Beispielverwendung:
Ruft einen angegebenen geheimen Schlüssel aus einem bestimmten Schlüsseltresor ab. |
list |
Iterates the deleted secrets in the vault. Der vollständige geheime Bezeichner und die Attribute werden in der Antwort bereitgestellt. Für die geheimen Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Berechtigung "Geheime Schlüssel/Liste" erforderlich. Beispielverwendung:
Listet alle geheimen Schlüssel im Tresor auf. |
list |
Iterates the latest version of all secrets in the vault. Der vollständige geheime Bezeichner und die Attribute werden in der Antwort bereitgestellt. Für die geheimen Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Berechtigung "Geheime Schlüssel/Liste" erforderlich. Beispielverwendung:
Listet alle geheimen Schlüssel im Tresor auf. |
list |
Durchläuft alle Versionen des angegebenen Geheimniss im Tresor. Der vollständige geheime Bezeichner und die Attribute werden in der Antwort bereitgestellt. Für die geheimen Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Berechtigung "Geheime Schlüssel/Liste" erforderlich. Beispielverwendung:
|
purge |
Der gelöschte geheime Vorgang entfernt den geheimen Schlüssel dauerhaft, ohne die Möglichkeit der Wiederherstellung. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor aktiviert werden. Für diesen Vorgang sind die Berechtigung "Geheime Schlüssel/Bereinigung" erforderlich. Beispielverwendung:
Löscht den angegebenen geheimen Schlüssel endgültig. |
restore |
Stellt einen gesicherten geheimen Schlüssel und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Berechtigung "Geheime Schlüssel/Wiederherstellung" erforderlich. Beispielverwendung:
Stellt einen gesicherten Geheimschlüssel in einem Tresor wieder her. |
set |
Die setSecret-Methode fügt dem Azure Key Vault eine geheime oder geheime Version hinzu. Wenn der benannte Geheimschlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version dieses geheimen Schlüssels. Für diesen Vorgang sind die geheimen/festgelegten Berechtigungen erforderlich. Beispielverwendung:
Fügt einen geheimen Schlüssel in einem angegebenen Schlüsseltresor hinzu. |
update |
Die updateSecret-Methode ändert die angegebenen Attribute eines vorhandenen gespeicherten geheimen Schlüssels. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert eines geheimen Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang sind die geheimen/festgelegten Berechtigungen erforderlich. Beispielverwendung:
Aktualisiert die Attribute, die einem angegebenen Geheimschlüssel 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 zum Tresor. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault-Ressource verweist. Weitere Informationen finden Sie unter https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Ein Objekt, das die TokenCredential
Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.
- pipelineOptions
- SecretClientOptions
Pipelineoptionen zum Konfigurieren von Key Vault-API-Anforderungen. Lassen Sie diesen Parameter aus, um die Standardpipelinekonfiguration zu verwenden.
Details zur Eigenschaft
vaultUrl
Die Basis-URL zum Tresor
vaultUrl: string
Eigenschaftswert
string
Details zur Methode
backupSecret(string, BackupSecretOptions)
Fordert an, dass eine Sicherung des angegebenen geheimen Schlüssels auf den Client heruntergeladen wird. Alle Versionen des geheimen Schlüssels werden heruntergeladen. Für diesen Vorgang sind die Geheim-/Sicherungsberechtigungen erforderlich.
Beispielverwendung:
let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");
Sichert den angegebenen geheimen Schlüssel.
function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>
Parameter
- secretName
-
string
Der Name des geheimen Schlüssels.
- options
- BackupSecretOptions
Die optionalen Parameter.
Gibt zurück
Promise<undefined | Uint8Array>
beginDeleteSecret(string, BeginDeleteSecretOptions)
Löscht einen geheimen Schlüssel, der in Azure Key Vault gespeichert ist. Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der geheime Schlüssel gelöscht wird.
Für diesen Vorgang sind die Berechtigung "Geheime Schlüssel/Löschvorgänge" 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 einen geheimen Schlüssel 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 den gelöschten Geheimschlüssel im angegebenen Tresor wieder her. Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der geheime Schlüssel wiederhergestellt wird.
Für diesen Vorgang sind die Geheimen/Wiederherstellungsberechtigungen 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 den gelöschten Geheimschlüssel auf die neueste 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 den angegebenen gelöschten Geheimschlüssel zusammen mit seinen Attributen zurück. Für diesen Vorgang sind die Geheimen/Abrufen-Berechtigungen erforderlich.
Beispielverwendung:
let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");
Ruft den angegebenen gelöschten geheimen Schlüssel ab.
function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>
Parameter
- secretName
-
string
Der Name des geheimen Schlüssels.
- options
- GetDeletedSecretOptions
Die optionalen Parameter.
Gibt zurück
Promise<DeletedSecret>
getSecret(string, GetSecretOptions)
Die getSecret-Methode gilt für alle geheimen Daten, die in Azure Key Vault gespeichert sind. Für diesen Vorgang sind die Geheimen/Abrufen-Berechtigungen erforderlich.
Beispielverwendung:
let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");
Ruft einen angegebenen geheimen Schlüssel aus einem bestimmten Schlüsseltresor ab.
function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>
Parameter
- secretName
-
string
Der Name des geheimen Schlüssels.
- options
- GetSecretOptions
Die optionalen Parameter.
Gibt zurück
Promise<KeyVaultSecret>
listDeletedSecrets(ListDeletedSecretsOptions)
Iterates the deleted secrets in the vault. Der vollständige geheime Bezeichner und die Attribute werden in der Antwort bereitgestellt. Für die geheimen Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Berechtigung "Geheime Schlüssel/Liste" erforderlich.
Beispielverwendung:
let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
console.log("deleted secret: ", deletedSecret);
}
Listet alle geheimen Schlüssel im Tresor auf.
function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>
Parameter
- options
- ListDeletedSecretsOptions
Die optionalen Parameter.
Gibt zurück
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)
Iterates the latest version of all secrets in the vault. Der vollständige geheime Bezeichner und die Attribute werden in der Antwort bereitgestellt. Für die geheimen Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Berechtigung "Geheime Schlüssel/Liste" 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 geheimen Schlüssel im Tresor auf.
function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>
Parameter
- options
- ListPropertiesOfSecretsOptions
Die optionalen Parameter.
Gibt zurück
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)
Durchläuft alle Versionen des angegebenen Geheimniss im Tresor. Der vollständige geheime Bezeichner und die Attribute werden in der Antwort bereitgestellt. Für die geheimen Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Berechtigung "Geheime Schlüssel/Liste" 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
Der Name des geheimen Schlüssels, für den Versionen abgerufen werden sollen.
Die optionalen Parameter.
Gibt zurück
purgeDeletedSecret(string, PurgeDeletedSecretOptions)
Der gelöschte geheime Vorgang entfernt den geheimen Schlüssel dauerhaft, ohne die Möglichkeit der Wiederherstellung. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor aktiviert werden. Für diesen Vorgang sind die Berechtigung "Geheime Schlüssel/Bereinigung" erforderlich.
Beispielverwendung:
const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");
Löscht den angegebenen geheimen Schlüssel endgültig.
function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>
Parameter
- secretName
-
string
Der Name des geheimen Schlüssels.
- options
- PurgeDeletedSecretOptions
Die optionalen Parameter.
Gibt zurück
Promise<void>
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)
Stellt einen gesicherten geheimen Schlüssel und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Berechtigung "Geheime Schlüssel/Wiederherstellung" erforderlich.
Beispielverwendung:
let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);
Stellt einen gesicherten Geheimschlüssel in einem Tresor wieder her.
function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>
Parameter
- secretBundleBackup
-
Uint8Array
Das Sicherungs-BLOB, 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 geheime oder geheime Version hinzu. Wenn der benannte Geheimschlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version dieses geheimen Schlüssels. Für diesen Vorgang sind die geheimen/festgelegten Berechtigungen erforderlich.
Beispielverwendung:
let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");
Fügt einen geheimen Schlüssel in einem angegebenen Schlüsseltresor hinzu.
function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>
Parameter
- secretName
-
string
Der Name des geheimen Schlüssels.
- 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 geheimen Schlüssels. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert eines geheimen Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang sind die geheimen/festgelegten Berechtigungen 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 });
Aktualisiert die Attribute, die einem angegebenen Geheimschlüssel in einem bestimmten Schlüsseltresor zugeordnet sind.
function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>
Parameter
- secretName
-
string
Der Name des geheimen Schlüssels.
- secretVersion
-
string
Die Version des geheimen Schlüssels.
- options
- UpdateSecretPropertiesOptions
Die optionalen Parameter.
Gibt zurück
Promise<SecretProperties>