Sdílet prostřednictvím

SecretClient class

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

SecretClient poskytuje metody pro správu KeyVaultSecret ve službě 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 podporuje také výpis DeletedSecret pro obnovitelné odstranění služby Azure Key Vault.

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, aby se do klienta stáhla záloha zadaného tajného klíče. 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ý klíč uložený ve službě Azure Key Vault. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se tajný klíč nesmazat.

Tato operace vyžaduje oprávnění k tajným kódům nebo odstranění.

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ý klíč ze zadaného trezoru klíčů.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Obnoví odstraněný tajný klíč v zadaném trezoru. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se tajný klíč neobnoví.

Tato operace vyžaduje oprávnění k tajným kódům 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)

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

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 vztahuje na všechny tajné kódy uložené ve službě Azure Key Vault. Tato operace vyžaduje tajné kódy nebo získat oprávnění.

Příklad použití:

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

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

Iteruje odstraněné tajné kódy v trezoru. Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují 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);
}

Výpis všech tajných kódů v trezoru
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iteruje nejnovější verzi všech tajných kódů v trezoru. Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují 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);
}

Výpis všech tajných kódů v trezoru
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iteruje všechny verze daného tajného kódu v trezoru. Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují 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 kódu trvale odebere tajný kód bez možnosti obnovení. Tuto operaci lze povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění k vyprázdnění tajných kódů.

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á do služby Azure Key Vault tajnou nebo tajnou verzi. Pokud pojmenovaný tajný klíč již existuje, Azure Key Vault vytvoří novou verzi tohoto tajného kódu. Tato operace vyžaduje oprávnění tajného klíče nebo sady.

Příklad použití:

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

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

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

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

Aktualizuje atributy přidružené k zadanému tajnému kódu 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 služby Key Vault. Podrobnosti najdete v https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objekt, který implementuje rozhraní TokenCredential použité k ověřování požadavků na službu. Pomocí balíčku @azure/identity 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 služby Key Vault Tento parametr vynecháte, pokud chcete použít výchozí konfiguraci kanálu.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

backupSecret(string, BackupSecretOptions)

Požaduje, aby se do klienta stáhla záloha zadaného tajného klíče. 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 klíče.

options
BackupSecretOptions

Volitelné parametry.

Návraty

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Odstraní tajný klíč uložený ve službě Azure Key Vault. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se tajný klíč nesmazat.

Tato operace vyžaduje oprávnění k tajným kódům nebo odstranění.

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ý klíč 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ý klíč v zadaném trezoru. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se tajný klíč neobnoví.

Tato operace vyžaduje oprávnění k tajným kódům 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)

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

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 klíče.

options
GetDeletedSecretOptions

Volitelné parametry.

Návraty

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Metoda getSecret se vztahuje na všechny tajné kódy uložené ve službě Azure Key Vault. Tato operace vyžaduje tajné kódy nebo získat oprávnění.

Příklad použití:

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

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

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

Parametry

secretName

string

Název tajného klíče.

options
GetSecretOptions

Volitelné parametry.

Návraty

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Iteruje odstraněné tajné kódy v trezoru. Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují 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);
}

Výpis všech tajných kódů 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. Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují 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);
}

Výpis všech tajných kódů 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. Úplný identifikátor tajného kódu a atributy jsou k dispozici v odpovědi. Pro tajné kódy se nevrácejí žádné hodnoty. Tyto operace vyžadují 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 načtení verzí.

options
ListPropertiesOfSecretVersionsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Operace vymazání odstraněného tajného kódu trvale odebere tajný kód bez možnosti obnovení. Tuto operaci lze povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění k vyprázdnění tajných kódů.

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 klíče.

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á do služby Azure Key Vault tajnou nebo tajnou verzi. Pokud pojmenovaný tajný klíč již existuje, Azure Key Vault vytvoří novou verzi tohoto tajného kódu. Tato operace vyžaduje oprávnění tajného klíče nebo sady.

Příklad použití:

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

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

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

Parametry

secretName

string

Název tajného klíče.

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 kódu. Vlastnosti, které nejsou zadány v požadavku, zůstanou beze změny. Hodnotu samotného tajného kódu nelze změnit. Tato operace vyžaduje oprávnění tajného klíče nebo sady.

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

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

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

Parametry

secretName

string

Název tajného klíče.

secretVersion

string

Verze tajného kódu.

options
UpdateSecretPropertiesOptions

Volitelné parametry.

Návraty

Promise<SecretProperties>