Sdílet prostřednictvím

SecretClient class

  • Reference
Balíček:
@azure/keyvault-secrets

SecretClient poskytuje metody pro správu KeyVaultSecret v Azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultSecrets. Klient také podporuje výpis odstraněnéhosecretu pro Key Vault Azure s povoleným obnovitelném odstraněním.

Konstruktory

SecretClient(string, TokenCredential, SecretClientOptions)

Vytvoří instanci SecretClient.

Příklad použití:

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

Vlastnosti

vaultUrl

Základní adresa URL trezoru

Metody

backupSecret(string, BackupSecretOptions)

Požaduje stažení zálohy zadaného tajného klíče do klienta. Stáhnou se všechny verze tajného kódu. Tato operace vyžaduje oprávnění k tajným kódům nebo zálohování.

Příklad použití:

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

Zálohuje zadaný tajný kód.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Odstraní tajný kód uložený v Azure Key Vault. Tato funkce vrátí dlouho běžící operaci poller, která umožňuje čekat neomezeně dlouho, dokud se tajný klíč odstraní.

Tato operace vyžaduje oprávnění k odstranění nebo tajné kódy.

Příklad použití:

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

Odstraní tajný kód ze zadaného trezoru klíčů.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Obnoví odstraněný tajný kód v zadaném trezoru. Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud se tajný klíč neobnoví.

Tato operace vyžaduje oprávnění pro tajné kódy nebo obnovení.

Příklad použití:

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

Obnoví odstraněný tajný kód na nejnovější verzi.
getDeletedSecret(string, GetDeletedSecretOptions)

Metoda getDeletedSecret vrátí zadaný odstraněný tajný klíč spolu s jeho atributy. Tato operace vyžaduje tajné kódy nebo oprávnění získat.

Příklad použití:

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

Získá zadaný odstraněný tajný klíč.
getSecret(string, GetSecretOptions)

Metoda getSecret se dá použít pro všechny tajné kódy uložené v Azure Key Vault. Tato operace vyžaduje tajné kódy nebo oprávnění získat.

Příklad použití:

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

Získejte zadaný tajný kód z daného trezoru klíčů.
listDeletedSecrets(ListDeletedSecretsOptions)

Iteruje odstraněné tajné kódy v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy tajného klíče. Pro tajné kódy se nevrácejí žádné hodnoty. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

Příklad použití:

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

Vypíše všechny tajné kódy v trezoru.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iteruje nejnovější verzi všech tajných kódů v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy tajného klíče. Pro tajné kódy se nevrácejí žádné hodnoty. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

Příklad použití:

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

Vypíše všechny tajné kódy v trezoru.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iteruje všechny verze daného tajného kódu v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy tajného klíče. Pro tajné kódy se nevrácejí žádné hodnoty. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

Příklad použití:

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)

Operace vymazání odstraněného tajného klíče trvale odebere tajný klíč bez možnosti obnovení. Tuto operaci je možné povolit pouze v trezoru s povoleným obnovitelném odstranění. Tato operace vyžaduje oprávnění k vyprázdnění nebo tajné kódy.

Příklad použití:

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

Trvale odstraní zadaný tajný klíč.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Obnoví zálohovaný tajný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k tajným kódům nebo obnovení.

Příklad použití:

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

Obnoví zálohovaný tajný kód do trezoru.
setSecret(string, string, SetSecretOptions)

Metoda setSecret přidá tajný kód nebo verzi tajného kódu do Key Vault Azure. Pokud už pojmenovaný tajný klíč existuje, Azure Key Vault vytvoří novou verzi tohoto tajného klíče. Tato operace vyžaduje oprávnění k tajným kódům nebo nastavení.

Příklad použití:

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

Přidá tajný kód do zadaného trezoru klíčů.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metoda updateSecret změní zadané atributy existujícího uloženého tajného klíče. Vlastnosti, které nejsou v požadavku zadané, zůstanou beze změny. Hodnotu samotného tajného kódu nelze změnit. Tato operace vyžaduje oprávnění k tajným kódům nebo nastavení.

Příklad použití:

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

Aktualizace atributy přidružené k zadanému tajnému klíči v daném trezoru klíčů.

Podrobnosti konstruktoru

SecretClient(string, TokenCredential, SecretClientOptions)

Vytvoří instanci SecretClient.

Příklad použití:

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

Základní adresa URL trezoru. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek Key Vault. Podrobnosti viz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objekt, který implementuje TokenCredential rozhraní používané k ověřování požadavků na službu. @azure/identity Pomocí balíčku vytvořte přihlašovací údaje, které vyhovují vašim potřebám.

pipelineOptions
SecretClientOptions

Možnosti kanálu používané ke konfiguraci požadavků rozhraní API Key Vault Pokud chcete použít výchozí konfiguraci kanálu, tento parametr vynecháte.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

backupSecret(string, BackupSecretOptions)

Požaduje stažení zálohy zadaného tajného klíče do klienta. Stáhnou se všechny verze tajného kódu. Tato operace vyžaduje oprávnění k tajným kódům nebo zálohování.

Příklad použití:

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

Zálohuje zadaný tajný kód.

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

Parametry

secretName

string

Název tajného kódu.

options
BackupSecretOptions

Volitelné parametry.

Návraty

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Odstraní tajný kód uložený v Azure Key Vault. Tato funkce vrátí dlouho běžící operaci poller, která umožňuje čekat neomezeně dlouho, dokud se tajný klíč odstraní.

Tato operace vyžaduje oprávnění k odstranění nebo tajné kódy.

Příklad použití:

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

Odstraní tajný kód ze zadaného trezoru klíčů.

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

Parametry

name

string

options
BeginDeleteSecretOptions

Volitelné parametry.

Návraty

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Obnoví odstraněný tajný kód v zadaném trezoru. Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud se tajný klíč neobnoví.

Tato operace vyžaduje oprávnění pro tajné kódy nebo obnovení.

Příklad použití:

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

Obnoví odstraněný tajný kód na nejnovější verzi.

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

Parametry

name

string

options
BeginRecoverDeletedSecretOptions

Volitelné parametry.

Návraty

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

getDeletedSecret(string, GetDeletedSecretOptions)

Metoda getDeletedSecret vrátí zadaný odstraněný tajný klíč spolu s jeho atributy. Tato operace vyžaduje tajné kódy nebo oprávnění získat.

Příklad použití:

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

Získá zadaný odstraněný tajný klíč.

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

Parametry

secretName

string

Název tajného kódu.

options
GetDeletedSecretOptions

Volitelné parametry.

Návraty

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Metoda getSecret se dá použít pro všechny tajné kódy uložené v Azure Key Vault. Tato operace vyžaduje tajné kódy nebo oprávnění získat.

Příklad použití:

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

Získejte zadaný tajný kód z daného trezoru klíčů.

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

Parametry

secretName

string

Název tajného kódu.

options
GetSecretOptions

Volitelné parametry.

Návraty

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Iteruje odstraněné tajné kódy v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy tajného klíče. Pro tajné kódy se nevrácejí žádné hodnoty. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

Příklad použití:

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

Vypíše všechny tajné kódy v trezoru.

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

Parametry

options
ListDeletedSecretsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iteruje nejnovější verzi všech tajných kódů v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy tajného klíče. Pro tajné kódy se nevrácejí žádné hodnoty. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

Příklad použití:

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

Vypíše všechny tajné kódy v trezoru.

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

Parametry

options
ListPropertiesOfSecretsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iteruje všechny verze daného tajného kódu v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy tajného klíče. Pro tajné kódy se nevrácejí žádné hodnoty. Tato operace vyžaduje oprávnění k tajným kódům nebo seznamům.

Příklad použití:

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

Název tajného kódu, pro který se mají načíst verze.

options
ListPropertiesOfSecretVersionsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Operace vymazání odstraněného tajného klíče trvale odebere tajný klíč bez možnosti obnovení. Tuto operaci je možné povolit pouze v trezoru s povoleným obnovitelném odstranění. Tato operace vyžaduje oprávnění k vyprázdnění nebo tajné kódy.

Příklad použití:

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

Trvale odstraní zadaný tajný klíč.

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

Parametry

secretName

string

Název tajného kódu.

options
PurgeDeletedSecretOptions

Volitelné parametry.

Návraty

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Obnoví zálohovaný tajný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k tajným kódům nebo obnovení.

Příklad použití:

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

Obnoví zálohovaný tajný kód do trezoru.

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

Parametry

secretBundleBackup

Uint8Array

Záložní objekt blob přidružený k tajné sadě.

options
RestoreSecretBackupOptions

Volitelné parametry.

Návraty

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Metoda setSecret přidá tajný kód nebo verzi tajného kódu do Key Vault Azure. Pokud už pojmenovaný tajný klíč existuje, Azure Key Vault vytvoří novou verzi tohoto tajného klíče. Tato operace vyžaduje oprávnění k tajným kódům nebo nastavení.

Příklad použití:

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

Přidá tajný kód do zadaného trezoru klíčů.

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

Parametry

secretName

string

Název tajného kódu.

value

string

Hodnota tajného kódu.

options
SetSecretOptions

Volitelné parametry.

Návraty

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metoda updateSecret změní zadané atributy existujícího uloženého tajného klíče. Vlastnosti, které nejsou v požadavku zadané, zůstanou beze změny. Hodnotu samotného tajného kódu nelze změnit. Tato operace vyžaduje oprávnění k tajným kódům nebo nastavení.

Příklad použití:

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

Aktualizace atributy přidružené k zadanému tajnému klíči v daném trezoru klíčů.

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

Parametry

secretName

string

Název tajného kódu.

secretVersion

string

Verze tajného kódu.

options
UpdateSecretPropertiesOptions

Volitelné parametry.

Návraty

Promise<SecretProperties>