SecretClient class

  • Referentie
Pakket:
@azure/keyvault-secrets

De SecretClient biedt methoden voor het beheren van KeyVaultSecret in de Azure Key Vault. De client ondersteunt het maken, ophalen, bijwerken, verwijderen, opschonen, back-ups maken, herstellen en vermelden van KeyVaultSecrets. De client ondersteunt ook het vermelden van DeletedSecret voor een Azure-Key Vault waarvoor voorlopig verwijderen is ingeschakeld.

Constructors

SecretClient(string, TokenCredential, SecretClientOptions)

Hiermee maakt u een instantie van SecretClient.

Gebruiksvoorbeeld:

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);

Eigenschappen

vaultUrl

De basis-URL naar de kluis

Methoden

backupSecret(string, BackupSecretOptions)

Hiermee wordt aangevraagd dat een back-up van het opgegeven geheim naar de client wordt gedownload. Alle versies van het geheim worden gedownload. Voor deze bewerking is de machtiging geheimen/back-up vereist.

Gebruiksvoorbeeld:

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

Hiermee maakt u een back-up van het opgegeven geheim.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Hiermee verwijdert u een geheim dat is opgeslagen in Azure Key Vault. Deze functie retourneert een poller voor langdurige bewerking waarmee u voor onbepaalde tijd kunt wachten totdat het geheim is verwijderd.

Voor deze bewerking is de machtiging geheimen/verwijderen vereist.

Gebruiksvoorbeeld:

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);

Hiermee verwijdert u een geheim uit een opgegeven sleutelkluis.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Herstelt het verwijderde geheim in de opgegeven kluis. Deze functie retourneert een poller voor langdurige bewerking waarmee u voor onbepaalde tijd kunt wachten totdat het geheim is hersteld.

Voor deze bewerking is de machtiging geheimen/herstellen vereist.

Gebruiksvoorbeeld:

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);

Herstelt het verwijderde geheim naar de nieuwste versie.
getDeletedSecret(string, GetDeletedSecretOptions)

De methode getDeletedSecret retourneert het opgegeven verwijderde geheim, samen met de bijbehorende kenmerken. Voor deze bewerking is de machtiging geheimen/ophalen vereist.

Gebruiksvoorbeeld:

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

Hiermee haalt u het opgegeven verwijderde geheim op.
getSecret(string, GetSecretOptions)

De methode getSecret is van toepassing op elk geheim dat is opgeslagen in Azure Key Vault. Voor deze bewerking is de machtiging geheimen/ophalen vereist.

Gebruiksvoorbeeld:

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

Haal een opgegeven geheim op uit een bepaalde sleutelkluis.
listDeletedSecrets(ListDeletedSecretsOptions)

De verwijderde geheimen in de kluis worden herhaald. De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerking is de machtiging geheimen/lijsten vereist.

Gebruiksvoorbeeld:

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

Alle geheimen in de kluis weergeven.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Hiermee wordt de nieuwste versie van alle geheimen in de kluis herhaald. De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerking is de machtiging geheimen/lijsten vereist.

Gebruiksvoorbeeld:

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

Alle geheimen in de kluis weergeven.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itereert alle versies van het opgegeven geheim in de kluis. De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerking is de machtiging geheimen/lijsten vereist.

Gebruiksvoorbeeld:

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)

Met de bewerking Verwijderde geheim opschonen wordt het geheim permanent verwijderd, zonder de mogelijkheid van herstel. Deze bewerking kan alleen worden ingeschakeld voor een kluis waarvoor voorlopig verwijderen is ingeschakeld. Voor deze bewerking is de machtiging geheimen/opschonen vereist.

Gebruiksvoorbeeld:

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

Hiermee verwijdert u het opgegeven geheim definitief.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Hiermee herstelt u een back-up van een geheim en alle bijbehorende versies naar een kluis. Voor deze bewerking is de machtiging geheimen/herstellen vereist.

Gebruiksvoorbeeld:

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

Hiermee herstelt u een back-up van een geheim naar een kluis.
setSecret(string, string, SetSecretOptions)

Met de methode setSecret wordt een geheime of geheime versie toegevoegd aan de Azure Key Vault. Als het benoemde geheim al bestaat, maakt Azure Key Vault een nieuwe versie van dat geheim. Voor deze bewerking is de machtiging geheimen/instellen vereist.

Gebruiksvoorbeeld:

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

Hiermee voegt u een geheim toe aan een opgegeven sleutelkluis.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

De methode updateSecret wijzigt opgegeven kenmerken van een bestaand opgeslagen geheim. Eigenschappen die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een geheim zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging geheimen/instellen vereist.

Gebruiksvoorbeeld:

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

Updates de kenmerken die zijn gekoppeld aan een opgegeven geheim in een bepaalde sleutelkluis.

Constructordetails

SecretClient(string, TokenCredential, SecretClientOptions)

Hiermee maakt u een instantie van SecretClient.

Gebruiksvoorbeeld:

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)

Parameters

vaultUrl

string

De basis-URL naar de kluis. Controleer of deze URL verwijst naar een geldige Key Vault resource. Zie https://aka.ms/azsdk/blog/vault-uri voor meer informatie.

credential
TokenCredential

Een object dat de TokenCredential interface implementeert die wordt gebruikt om aanvragen voor de service te verifiëren. Gebruik het @azure/identity pakket om een referentie te maken die aan uw behoeften voldoet.

pipelineOptions
SecretClientOptions

Pijplijnopties die worden gebruikt voor het configureren van Key Vault API-aanvragen. Laat deze parameter weg om de standaardpijplijnconfiguratie te gebruiken.

Eigenschapdetails

vaultUrl

De basis-URL naar de kluis

vaultUrl: string

Waarde van eigenschap

string

Methodedetails

backupSecret(string, BackupSecretOptions)

Hiermee wordt aangevraagd dat een back-up van het opgegeven geheim naar de client wordt gedownload. Alle versies van het geheim worden gedownload. Voor deze bewerking is de machtiging geheimen/back-up vereist.

Gebruiksvoorbeeld:

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

Hiermee maakt u een back-up van het opgegeven geheim.

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

Parameters

secretName

string

De naam van het geheim.

options
BackupSecretOptions

De optionele parameters.

Retouren

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Hiermee verwijdert u een geheim dat is opgeslagen in Azure Key Vault. Deze functie retourneert een poller voor langdurige bewerking waarmee u voor onbepaalde tijd kunt wachten totdat het geheim is verwijderd.

Voor deze bewerking is de machtiging geheimen/verwijderen vereist.

Gebruiksvoorbeeld:

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);

Hiermee verwijdert u een geheim uit een opgegeven sleutelkluis.

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

Parameters

name

string

options
BeginDeleteSecretOptions

De optionele parameters.

Retouren

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Herstelt het verwijderde geheim in de opgegeven kluis. Deze functie retourneert een poller voor langdurige bewerking waarmee u voor onbepaalde tijd kunt wachten totdat het geheim is hersteld.

Voor deze bewerking is de machtiging geheimen/herstellen vereist.

Gebruiksvoorbeeld:

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);

Herstelt het verwijderde geheim naar de nieuwste versie.

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

Parameters

name

string

options
BeginRecoverDeletedSecretOptions

De optionele parameters.

Retouren

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

getDeletedSecret(string, GetDeletedSecretOptions)

De methode getDeletedSecret retourneert het opgegeven verwijderde geheim, samen met de bijbehorende kenmerken. Voor deze bewerking is de machtiging geheimen/ophalen vereist.

Gebruiksvoorbeeld:

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

Hiermee haalt u het opgegeven verwijderde geheim op.

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

Parameters

secretName

string

De naam van het geheim.

options
GetDeletedSecretOptions

De optionele parameters.

Retouren

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

De methode getSecret is van toepassing op elk geheim dat is opgeslagen in Azure Key Vault. Voor deze bewerking is de machtiging geheimen/ophalen vereist.

Gebruiksvoorbeeld:

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

Haal een opgegeven geheim op uit een bepaalde sleutelkluis.

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

Parameters

secretName

string

De naam van het geheim.

options
GetSecretOptions

De optionele parameters.

Retouren

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

De verwijderde geheimen in de kluis worden herhaald. De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerking is de machtiging geheimen/lijsten vereist.

Gebruiksvoorbeeld:

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

Alle geheimen in de kluis weergeven.

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

Parameters

options
ListDeletedSecretsOptions

De optionele parameters.

Retouren

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Hiermee wordt de nieuwste versie van alle geheimen in de kluis herhaald. De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerking is de machtiging geheimen/lijsten vereist.

Gebruiksvoorbeeld:

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

Alle geheimen in de kluis weergeven.

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

Parameters

options
ListPropertiesOfSecretsOptions

De optionele parameters.

Retouren

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itereert alle versies van het opgegeven geheim in de kluis. De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerking is de machtiging geheimen/lijsten vereist.

Gebruiksvoorbeeld:

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>

Parameters

secretName

string

Naam van het geheim waarvoor versies moeten worden opgehaald.

options
ListPropertiesOfSecretVersionsOptions

De optionele parameters.

Retouren

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Met de bewerking Verwijderde geheim opschonen wordt het geheim permanent verwijderd, zonder de mogelijkheid van herstel. Deze bewerking kan alleen worden ingeschakeld voor een kluis waarvoor voorlopig verwijderen is ingeschakeld. Voor deze bewerking is de machtiging geheimen/opschonen vereist.

Gebruiksvoorbeeld:

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

Hiermee verwijdert u het opgegeven geheim definitief.

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

Parameters

secretName

string

De naam van het geheim.

options
PurgeDeletedSecretOptions

De optionele parameters.

Retouren

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Hiermee herstelt u een back-up van een geheim en alle bijbehorende versies naar een kluis. Voor deze bewerking is de machtiging geheimen/herstellen vereist.

Gebruiksvoorbeeld:

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

Hiermee herstelt u een back-up van een geheim naar een kluis.

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

Parameters

secretBundleBackup

Uint8Array

De back-up-blob die is gekoppeld aan een geheime bundel.

options
RestoreSecretBackupOptions

De optionele parameters.

Retouren

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Met de methode setSecret wordt een geheime of geheime versie toegevoegd aan de Azure Key Vault. Als het benoemde geheim al bestaat, maakt Azure Key Vault een nieuwe versie van dat geheim. Voor deze bewerking is de machtiging geheimen/instellen vereist.

Gebruiksvoorbeeld:

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

Hiermee voegt u een geheim toe aan een opgegeven sleutelkluis.

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

Parameters

secretName

string

De naam van het geheim.

value

string

De waarde van het geheim.

options
SetSecretOptions

De optionele parameters.

Retouren

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

De methode updateSecret wijzigt opgegeven kenmerken van een bestaand opgeslagen geheim. Eigenschappen die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een geheim zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging geheimen/instellen vereist.

Gebruiksvoorbeeld:

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

Updates de kenmerken die zijn gekoppeld aan een opgegeven geheim in een bepaalde sleutelkluis.

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

Parameters

secretName

string

De naam van het geheim.

secretVersion

string

De versie van het geheim.

options
UpdateSecretPropertiesOptions

De optionele parameters.

Retouren

Promise<SecretProperties>