SecretClient class

  • Referens
Paket:
@azure/keyvault-secrets

SecretClient tillhandahåller metoder för att hantera KeyVaultSecret i Azure Key Vault. Klienten har stöd för att skapa, hämta, uppdatera, ta bort, rensa, säkerhetskopiera, återställa och lista KeyVaultSecrets. Klienten har också stöd för att lista DeletedSecret för en aktiverad Azure-Key Vault med mjuk borttagning.

Konstruktorer

SecretClient(string, TokenCredential, SecretClientOptions)

Skapar en instans av SecretClient.

Exempel på användning:

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

Egenskaper

vaultUrl

Bas-URL:en till valvet

Metoder

backupSecret(string, BackupSecretOptions)

Begär att en säkerhetskopia av den angivna hemligheten laddas ned till klienten. Alla versioner av hemligheten laddas ned. Den här åtgärden kräver behörigheten hemligheter/säkerhetskopiering.

Exempel på användning:

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

Säkerhetskopierar den angivna hemligheten.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Tar bort en hemlighet som lagras i Azure Key Vault. Den här funktionen returnerar en pollerare för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills hemligheten har tagits bort.

Den här åtgärden kräver behörigheten hemligheter/borttagning.

Exempel på användning:

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

Tar bort en hemlighet från ett angivet nyckelvalv.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Återställer den borttagna hemligheten i det angivna valvet. Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills hemligheten har återställts.

Den här åtgärden kräver behörigheten hemligheter/återställning.

Exempel på användning:

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

Återställer den borttagna hemligheten till den senaste versionen.
getDeletedSecret(string, GetDeletedSecretOptions)

Metoden getDeletedSecret returnerar den angivna borttagna hemligheten tillsammans med dess attribut. Den här åtgärden kräver hemligheterna/behörigheten .

Exempel på användning:

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

Hämtar den angivna borttagna hemligheten.
getSecret(string, GetSecretOptions)

Metoden getSecret gäller för alla hemligheter som lagras i Azure Key Vault. Den här åtgärden kräver hemligheterna/behörigheten .

Exempel på användning:

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

Hämta en angiven hemlighet från ett visst nyckelvalv.
listDeletedSecrets(ListDeletedSecretsOptions)

Itererar de borttagna hemligheterna i valvet. Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

Exempel på användning:

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

Lista alla hemligheter i valvet.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itererar den senaste versionen av alla hemligheter i valvet. Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

Exempel på användning:

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

Lista alla hemligheter i valvet.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itererar alla versioner av den angivna hemligheten i valvet. Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

Exempel på användning:

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)

Den borttagna hemliga åtgärden tar bort hemligheten permanent, utan möjlighet till återställning. Den här åtgärden kan bara aktiveras i ett aktiverat valv med mjuk borttagning. Den här åtgärden kräver behörigheten hemligheter/rensning.

Exempel på användning:

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

Tar bort den angivna hemligheten permanent.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Återställer en säkerhetskopierad hemlighet och alla dess versioner till ett valv. Den här åtgärden kräver behörigheten hemligheter/återställning.

Exempel på användning:

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

Återställer en säkerhetskopierad hemlighet till ett valv.
setSecret(string, string, SetSecretOptions)

Metoden setSecret lägger till en hemlig eller hemlig version i Azure-Key Vault. Om den namngivna hemligheten redan finns skapar Azure Key Vault en ny version av hemligheten. Den här åtgärden kräver behörigheten hemligheter/uppsättningar.

Exempel på användning:

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

Lägger till en hemlighet i ett angivet nyckelvalv.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metoden updateSecret ändrar angivna attribut för en befintlig lagrad hemlighet. Egenskaper som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva hemligheten. Den här åtgärden kräver behörigheten hemligheter/uppsättningar.

Exempel på användning:

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

Uppdateringar attributen som är associerade med en angiven hemlighet i ett visst nyckelvalv.

Konstruktorinformation

SecretClient(string, TokenCredential, SecretClientOptions)

Skapar en instans av SecretClient.

Exempel på användning:

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)

Parametrar

vaultUrl

string

Bas-URL:en till valvet. Du bör kontrollera att den här URL:en refererar till en giltig Key Vault resurs. Mer information finns under https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ett objekt som implementerar gränssnittet som används för att autentisera TokenCredential begäranden till tjänsten. Använd paketet @azure/identity för att skapa en autentiseringsuppgift som passar dina behov.

pipelineOptions
SecretClientOptions

Pipelinealternativ som används för att konfigurera Key Vault API-begäranden. Utelämna den här parametern för att använda standardkonfigurationen för pipelinen.

Egenskapsinformation

vaultUrl

Bas-URL:en till valvet

vaultUrl: string

Egenskapsvärde

string

Metodinformation

backupSecret(string, BackupSecretOptions)

Begär att en säkerhetskopia av den angivna hemligheten laddas ned till klienten. Alla versioner av hemligheten laddas ned. Den här åtgärden kräver behörigheten hemligheter/säkerhetskopiering.

Exempel på användning:

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

Säkerhetskopierar den angivna hemligheten.

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

Parametrar

secretName

string

Namnet på hemligheten.

options
BackupSecretOptions

De valfria parametrarna.

Returer

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Tar bort en hemlighet som lagras i Azure Key Vault. Den här funktionen returnerar en pollerare för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills hemligheten har tagits bort.

Den här åtgärden kräver behörigheten hemligheter/borttagning.

Exempel på användning:

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

Tar bort en hemlighet från ett angivet nyckelvalv.

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

Parametrar

name

string

options
BeginDeleteSecretOptions

De valfria parametrarna.

Returer

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Återställer den borttagna hemligheten i det angivna valvet. Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills hemligheten har återställts.

Den här åtgärden kräver behörigheten hemligheter/återställning.

Exempel på användning:

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

Återställer den borttagna hemligheten till den senaste versionen.

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

Parametrar

name

string

options
BeginRecoverDeletedSecretOptions

De valfria parametrarna.

Returer

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

getDeletedSecret(string, GetDeletedSecretOptions)

Metoden getDeletedSecret returnerar den angivna borttagna hemligheten tillsammans med dess attribut. Den här åtgärden kräver hemligheterna/behörigheten .

Exempel på användning:

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

Hämtar den angivna borttagna hemligheten.

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

Parametrar

secretName

string

Namnet på hemligheten.

options
GetDeletedSecretOptions

De valfria parametrarna.

Returer

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Metoden getSecret gäller för alla hemligheter som lagras i Azure Key Vault. Den här åtgärden kräver hemligheterna/behörigheten .

Exempel på användning:

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

Hämta en angiven hemlighet från ett visst nyckelvalv.

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

Parametrar

secretName

string

Namnet på hemligheten.

options
GetSecretOptions

De valfria parametrarna.

Returer

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Itererar de borttagna hemligheterna i valvet. Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

Exempel på användning:

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

Lista alla hemligheter i valvet.

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

Parametrar

options
ListDeletedSecretsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itererar den senaste versionen av alla hemligheter i valvet. Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

Exempel på användning:

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

Lista alla hemligheter i valvet.

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

Parametrar

options
ListPropertiesOfSecretsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itererar alla versioner av den angivna hemligheten i valvet. Den fullständiga hemliga identifieraren och attributen anges i svaret. Inga värden returneras för hemligheterna. De här åtgärderna kräver behörigheten hemligheter/lista.

Exempel på användning:

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>

Parametrar

secretName

string

Namnet på hemligheten som du vill hämta versioner för.

options
ListPropertiesOfSecretVersionsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Den borttagna hemliga åtgärden tar bort hemligheten permanent, utan möjlighet till återställning. Den här åtgärden kan bara aktiveras i ett aktiverat valv med mjuk borttagning. Den här åtgärden kräver behörigheten hemligheter/rensning.

Exempel på användning:

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

Tar bort den angivna hemligheten permanent.

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

Parametrar

secretName

string

Namnet på hemligheten.

options
PurgeDeletedSecretOptions

De valfria parametrarna.

Returer

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Återställer en säkerhetskopierad hemlighet och alla dess versioner till ett valv. Den här åtgärden kräver behörigheten hemligheter/återställning.

Exempel på användning:

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

Återställer en säkerhetskopierad hemlighet till ett valv.

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

Parametrar

secretBundleBackup

Uint8Array

Säkerhetskopieringsbloben som är associerad med ett hemligt paket.

options
RestoreSecretBackupOptions

De valfria parametrarna.

Returer

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Metoden setSecret lägger till en hemlig eller hemlig version i Azure-Key Vault. Om den namngivna hemligheten redan finns skapar Azure Key Vault en ny version av hemligheten. Den här åtgärden kräver behörigheten hemligheter/uppsättningar.

Exempel på användning:

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

Lägger till en hemlighet i ett angivet nyckelvalv.

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

Parametrar

secretName

string

Namnet på hemligheten.

value

string

Hemlighetens värde.

options
SetSecretOptions

De valfria parametrarna.

Returer

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metoden updateSecret ändrar angivna attribut för en befintlig lagrad hemlighet. Egenskaper som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva hemligheten. Den här åtgärden kräver behörigheten hemligheter/uppsättningar.

Exempel på användning:

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

Uppdateringar attributen som är associerade med en angiven hemlighet i ett visst nyckelvalv.

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

Parametrar

secretName

string

Namnet på hemligheten.

secretVersion

string

Versionen av hemligheten.

options
UpdateSecretPropertiesOptions

De valfria parametrarna.

Returer

Promise<SecretProperties>