SecretClient class

  • Odwołanie
Pakiet:
@azure/keyvault-secrets

Obiekt SecretClient udostępnia metody zarządzania usługą KeyVaultSecret w usłudze Azure Key Vault. Klient obsługuje tworzenie, pobieranie, aktualizowanie, usuwanie, przeczyszczanie, tworzenie kopii zapasowych, przywracanie i wyświetlanie listy kluczy KeyVaultSecrets. Klient obsługuje również wyświetlanie listy DeletedSecret dla nietrwałego usuwania z włączoną usługą Azure Key Vault.

Konstruktory

SecretClient(string, TokenCredential, SecretClientOptions)

Tworzy wystąpienie klasy SecretClient.

Przykład użycia: 

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

Właściwości

vaultUrl

Podstawowy adres URL magazynu

Metody

backupSecret(string, BackupSecretOptions)

Żądania pobrania kopii zapasowej określonego wpisu tajnego do klienta. Wszystkie wersje wpisu tajnego zostaną pobrane. Ta operacja wymaga uprawnień do tworzenia wpisów tajnych/kopii zapasowej.

Przykład użycia: 

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

Wykonuje kopię zapasową określonego wpisu tajnego.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Usuwa wpis tajny przechowywany w usłudze Azure Key Vault. Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do momentu usunięcia wpisu tajnego.

Ta operacja wymaga uprawnień do wpisów tajnych/usuwania.

Przykład użycia: 

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

Usuwa wpis tajny z określonego magazynu kluczy.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Odzyskuje usunięty wpis tajny w określonym magazynie. Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do momentu odzyskania wpisu tajnego.

Ta operacja wymaga uprawnień do wpisów tajnych/odzyskiwania.

Przykład użycia: 

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

Odzyskuje usunięty wpis tajny do najnowszej wersji.
getDeletedSecret(string, GetDeletedSecretOptions)

Metoda getDeletedSecret zwraca określony usunięty wpis tajny wraz z jego atrybutami. Ta operacja wymaga uprawnień wpisów tajnych/uzyskiwania.

Przykład użycia: 

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

Pobiera określony usunięty wpis tajny.
getSecret(string, GetSecretOptions)

Metoda getSecret ma zastosowanie do dowolnego wpisu tajnego przechowywanego w usłudze Azure Key Vault. Ta operacja wymaga uprawnień wpisów tajnych/uzyskiwania.

Przykład użycia: 

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

Pobierz określony wpis tajny z danego magazynu kluczy.
listDeletedSecrets(ListDeletedSecretsOptions)

Iteruje usunięte wpisy tajne w magazynie. Pełny identyfikator i atrybuty wpisu tajnego są udostępniane w odpowiedzi. Dla wpisów tajnych nie są zwracane żadne wartości. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

Przykład użycia: 

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

Wyświetl listę wszystkich wpisów tajnych w magazynie.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iteruje najnowszą wersję wszystkich wpisów tajnych w magazynie. Pełny identyfikator i atrybuty wpisu tajnego są udostępniane w odpowiedzi. Dla wpisów tajnych nie są zwracane żadne wartości. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

Przykład użycia: 

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

Wyświetl listę wszystkich wpisów tajnych w magazynie.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iteruje wszystkie wersje danego wpisu tajnego w magazynie. Pełny identyfikator i atrybuty wpisu tajnego są udostępniane w odpowiedzi. Dla wpisów tajnych nie są zwracane żadne wartości. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

Przykład użycia: 

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)

Operacja przeczyszczania usuniętego wpisu tajnego powoduje trwałe usunięcie wpisu tajnego bez możliwości odzyskiwania. Tę operację można włączyć tylko w magazynie z włączoną obsługą usuwania nietrwałego. Ta operacja wymaga uprawnień do wpisów tajnych/przeczyszczania.

Przykład użycia: 

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

Trwale usuwa określony wpis tajny.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Przywraca kopię zapasową wpisu tajnego i wszystkie jego wersje do magazynu. Ta operacja wymaga uprawnień wpisów tajnych/przywracania.

Przykład użycia: 

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

Przywraca kopię zapasową wpisu tajnego do magazynu.
setSecret(string, string, SetSecretOptions)

Metoda setSecret dodaje wersję wpisu tajnego lub tajnego do usługi Azure Key Vault. Jeśli nazwany wpis tajny już istnieje, usługa Azure Key Vault tworzy nową wersję tego wpisu tajnego. Ta operacja wymaga uprawnień wpisów tajnych/zestawu.

Przykład użycia: 

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

Dodaje wpis tajny w określonym magazynie kluczy.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metoda updateSecret zmienia określone atrybuty istniejącego przechowywanego wpisu tajnego. Właściwości, które nie zostały określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego wpisu tajnego. Ta operacja wymaga uprawnień wpisów tajnych/zestawu.

Przykład użycia: 

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

Aktualizacje atrybuty skojarzone z określonym wpisem tajnym w danym magazynie kluczy.

Szczegóły konstruktora

SecretClient(string, TokenCredential, SecretClientOptions)

Tworzy wystąpienie klasy SecretClient.

Przykład użycia: 

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)

Parametry

vaultUrl

string

Podstawowy adres URL magazynu. Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu Key Vault. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Obiekt, który implementuje TokenCredential interfejs używany do uwierzytelniania żądań w usłudze. @azure/identity Użyj pakietu, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.

pipelineOptions
SecretClientOptions

Opcje potoku używane do konfigurowania żądań interfejsu API Key Vault. Pomiń ten parametr, aby użyć domyślnej konfiguracji potoku.

Szczegóły właściwości

vaultUrl

Podstawowy adres URL magazynu

vaultUrl: string

Wartość właściwości

string

Szczegóły metody

backupSecret(string, BackupSecretOptions)

Żądania pobrania kopii zapasowej określonego wpisu tajnego do klienta. Wszystkie wersje wpisu tajnego zostaną pobrane. Ta operacja wymaga uprawnień do tworzenia wpisów tajnych/kopii zapasowej.

Przykład użycia: 

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

Wykonuje kopię zapasową określonego wpisu tajnego.

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

Parametry

secretName

string

Nazwa wpisu tajnego.

options
BackupSecretOptions

Parametry opcjonalne.

Zwraca

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Usuwa wpis tajny przechowywany w usłudze Azure Key Vault. Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do momentu usunięcia wpisu tajnego.

Ta operacja wymaga uprawnień do wpisów tajnych/usuwania.

Przykład użycia: 

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

Usuwa wpis tajny z określonego magazynu kluczy.

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

Parametry

name

string

options
BeginDeleteSecretOptions

Parametry opcjonalne.

Zwraca

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Odzyskuje usunięty wpis tajny w określonym magazynie. Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do momentu odzyskania wpisu tajnego.

Ta operacja wymaga uprawnień do wpisów tajnych/odzyskiwania.

Przykład użycia: 

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

Odzyskuje usunięty wpis tajny do najnowszej wersji.

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

Parametry

name

string

options
BeginRecoverDeletedSecretOptions

Parametry opcjonalne.

Zwraca

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

getDeletedSecret(string, GetDeletedSecretOptions)

Metoda getDeletedSecret zwraca określony usunięty wpis tajny wraz z jego atrybutami. Ta operacja wymaga uprawnień wpisów tajnych/uzyskiwania.

Przykład użycia: 

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

Pobiera określony usunięty wpis tajny.

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

Parametry

secretName

string

Nazwa wpisu tajnego.

options
GetDeletedSecretOptions

Parametry opcjonalne.

Zwraca

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Metoda getSecret ma zastosowanie do dowolnego wpisu tajnego przechowywanego w usłudze Azure Key Vault. Ta operacja wymaga uprawnień wpisów tajnych/uzyskiwania.

Przykład użycia: 

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

Pobierz określony wpis tajny z danego magazynu kluczy.

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

Parametry

secretName

string

Nazwa wpisu tajnego.

options
GetSecretOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Iteruje usunięte wpisy tajne w magazynie. Pełny identyfikator i atrybuty wpisu tajnego są udostępniane w odpowiedzi. Dla wpisów tajnych nie są zwracane żadne wartości. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

Przykład użycia: 

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

Wyświetl listę wszystkich wpisów tajnych w magazynie.

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

Parametry

options
ListDeletedSecretsOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iteruje najnowszą wersję wszystkich wpisów tajnych w magazynie. Pełny identyfikator i atrybuty wpisu tajnego są udostępniane w odpowiedzi. Dla wpisów tajnych nie są zwracane żadne wartości. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

Przykład użycia: 

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

Wyświetl listę wszystkich wpisów tajnych w magazynie.

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

Parametry

options
ListPropertiesOfSecretsOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iteruje wszystkie wersje danego wpisu tajnego w magazynie. Pełny identyfikator i atrybuty wpisu tajnego są udostępniane w odpowiedzi. Dla wpisów tajnych nie są zwracane żadne wartości. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

Przykład użycia: 

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>

Parametry

secretName

string

Nazwa wpisu tajnego do pobierania wersji.

options
ListPropertiesOfSecretVersionsOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Operacja przeczyszczania usuniętego wpisu tajnego powoduje trwałe usunięcie wpisu tajnego bez możliwości odzyskiwania. Tę operację można włączyć tylko w magazynie z włączoną obsługą usuwania nietrwałego. Ta operacja wymaga uprawnień do wpisów tajnych/przeczyszczania.

Przykład użycia: 

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

Trwale usuwa określony wpis tajny.

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

Parametry

secretName

string

Nazwa wpisu tajnego.

options
PurgeDeletedSecretOptions

Parametry opcjonalne.

Zwraca

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Przywraca kopię zapasową wpisu tajnego i wszystkie jego wersje do magazynu. Ta operacja wymaga uprawnień wpisów tajnych/przywracania.

Przykład użycia: 

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

Przywraca kopię zapasową wpisu tajnego do magazynu.

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

Parametry

secretBundleBackup

Uint8Array

Obiekt blob kopii zapasowej skojarzony z pakietem tajnym.

options
RestoreSecretBackupOptions

Opcjonalne parametry.

Zwraca

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Metoda setSecret dodaje wersję wpisu tajnego lub tajnego do usługi Azure Key Vault. Jeśli nazwany wpis tajny już istnieje, usługa Azure Key Vault tworzy nową wersję tego wpisu tajnego. Ta operacja wymaga uprawnień wpisów tajnych/zestawu.

Przykład użycia: 

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

Dodaje wpis tajny w określonym magazynie kluczy.

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

Parametry

secretName

string

Nazwa wpisu tajnego.

value

string

Wartość wpisu tajnego.

options
SetSecretOptions

Opcjonalne parametry.

Zwraca

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metoda updateSecret zmienia określone atrybuty istniejącego przechowywanego wpisu tajnego. Właściwości, które nie zostały określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego wpisu tajnego. Ta operacja wymaga uprawnień wpisów tajnych/zestawu.

Przykład użycia: 

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

Aktualizacje atrybuty skojarzone z określonym wpisem tajnym w danym magazynie kluczy.

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

Parametry

secretName

string

Nazwa wpisu tajnego.

secretVersion

string

Wersja wpisu tajnego.

options
UpdateSecretPropertiesOptions

Opcjonalne parametry.

Zwraca

Promise<SecretProperties>