SecretClient class

  • Referencia
Csomag:
@azure/keyvault-secrets

A SecretClient metódusokat biztosít a KeyVaultSecret kezeléséhez az Azure Key Vault. Az ügyfél támogatja a KeyVaultSecrets létrehozását, lekérését, frissítését, törlését, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél emellett támogatja a DeletedSecret listázását a helyreállítható törlést támogató Azure-Key Vault esetében.

Konstruktorok

SecretClient(string, TokenCredential, SecretClientOptions)

Létrehoz egy SecretClient-példányt.

Példahasználat:

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

Tulajdonságok

vaultUrl

A tároló alap URL-címe

Metódusok

backupSecret(string, BackupSecretOptions)

Kéri, hogy a megadott titkos kódról készítsen biztonsági másolatot az ügyfélre. A titkos kód minden verziója le lesz töltve. Ehhez a művelethez titkos kulcsok/biztonsági mentési engedély szükséges.

Példahasználat:

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

Biztonsági másolatot készít a megadott titkos kódról.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Törli az Azure Key Vault tárolt titkos kódokat. Ez a függvény egy hosszú ideig futó művelet lekérdezőt ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a titkos kód törlődik.

Ehhez a művelethez titkos kulcsok/törlési engedélyek szükségesek.

Példahasználat:

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

Egy titkos kulcs törlése egy megadott kulcstartóból.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Helyreállítja a törölt titkos kulcsot a megadott tárolóban. Ez a függvény egy hosszú ideig futó művelet lekérdezőt ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a titkos kód helyreáll.

Ehhez a művelethez titkos kódokra/helyreállításra vonatkozó engedély szükséges.

Példahasználat:

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

Visszaállítja a törölt titkos kulcsot a legújabb verzióra.
getDeletedSecret(string, GetDeletedSecretOptions)

A getDeletedSecret metódus a megadott törölt titkos kulcsot és attribútumait adja vissza. Ehhez a művelethez titkos kódokra/lekérési engedélyekre van szükség.

Példahasználat:

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

Lekéri a megadott törölt titkos kulcsot.
getSecret(string, GetSecretOptions)

A getSecret metódus az Azure Key Vault tárolt titkos kódokra alkalmazható. Ehhez a művelethez titkos kódokra/lekérési engedélyekre van szükség.

Példahasználat:

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

Adott titkos kód lekérése egy adott kulcstartóból.
listDeletedSecrets(ListDeletedSecretsOptions)

Iterálja a törölt titkos kulcsokat a tárolóban. A teljes titkos azonosítót és attribútumokat a válaszban adták meg. A titkos kódokhoz nem adnak vissza értékeket. Ehhez a művelethez titkos kódokra/listákra vonatkozó engedély szükséges.

Példahasználat:

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

Sorolja fel a tároló összes titkos kulcsát.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iterálja a tárolóban lévő összes titkos kód legújabb verzióját. A teljes titkos azonosítót és attribútumokat a válaszban adták meg. A titkos kódokhoz nem adnak vissza értékeket. Ehhez a művelethez titkos kódokra/listákra vonatkozó engedély szükséges.

Példahasználat:

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

Sorolja fel a tároló összes titkos kulcsát.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iterálja a megadott titkos kód összes verzióját a tárolóban. A teljes titkos azonosítót és attribútumokat a válaszban adták meg. A titkos kódokhoz nem adnak vissza értékeket. Ehhez a művelethez titkos kódokra/listákra vonatkozó engedély szükséges.

Példahasználat:

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)

A törölt titkos kód törlése művelet véglegesen eltávolítja a titkos kódot, a helyreállítás lehetősége nélkül. Ez a művelet csak helyreállítható törlést engedélyező tárolón engedélyezhető. Ehhez a művelethez titkos kulcsra/törlésre vonatkozó engedély szükséges.

Példahasználat:

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

Véglegesen törli a megadott titkos kulcsot.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Visszaállít egy biztonsági másolatot a titkos kódról és annak minden verziójáról egy tárolóba. Ehhez a művelethez titkos kulcsok/visszaállítási engedély szükséges.

Példahasználat:

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

Visszaállít egy biztonsági másolatban tárolt titkos kódot egy tárolóba.
setSecret(string, string, SetSecretOptions)

A setSecret metódus titkos vagy titkos verziót ad hozzá az Azure Key Vault. Ha a nevesített titkos kód már létezik, az Azure Key Vault létrehozza a titkos kód új verzióját. Ehhez a művelethez titkos kódokra/beállítási engedélyekre van szükség.

Példahasználat:

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

Hozzáad egy titkos kódot egy adott kulcstartóhoz.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Az updateSecret metódus módosítja egy meglévő tárolt titkos kód megadott attribútumait. A kérelemben nem megadott tulajdonságok változatlanok maradnak. Maga a titkos kód értéke nem módosítható. Ehhez a művelethez titkos kódokra/beállítási engedélyekre van szükség.

Példahasználat:

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

Frissítések egy adott kulcstartóban megadott titkos kódhoz társított attribútumokat.

Konstruktor adatai

SecretClient(string, TokenCredential, SecretClientOptions)

Létrehoz egy SecretClient-példányt.

Példahasználat:

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)

Paraméterek

vaultUrl

string

A tároló alap URL-címe. Ellenőrizze, hogy az URL-cím érvényes Key Vault erőforrásra hivatkozik-e. További részletek: https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Egy objektum, amely a TokenCredential szolgáltatás kéréseinek hitelesítéséhez használt felületet implementálja. @azure/identity A csomag használatával hozzon létre egy, az igényeinek megfelelő hitelesítő adatot.

pipelineOptions
SecretClientOptions

A Key Vault API-kérések konfigurálásához használt folyamatbeállítások. Ezt a paramétert kihagyva használja az alapértelmezett folyamatkonfigurációt.

Tulajdonság adatai

vaultUrl

A tároló alap URL-címe

vaultUrl: string

Tulajdonság értéke

string

Metódus adatai

backupSecret(string, BackupSecretOptions)

Kéri, hogy a megadott titkos kódról készítsen biztonsági másolatot az ügyfélre. A titkos kód minden verziója le lesz töltve. Ehhez a művelethez titkos kulcsok/biztonsági mentési engedély szükséges.

Példahasználat:

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

Biztonsági másolatot készít a megadott titkos kódról.

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

Paraméterek

secretName

string

A titkos kód neve.

options
BackupSecretOptions

A választható paraméterek.

Válaszok

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Törli az Azure Key Vault tárolt titkos kódokat. Ez a függvény egy hosszú ideig futó művelet lekérdezőt ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a titkos kód törlődik.

Ehhez a művelethez titkos kulcsok/törlési engedélyek szükségesek.

Példahasználat:

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

Egy titkos kulcs törlése egy megadott kulcstartóból.

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

Paraméterek

name

string

options
BeginDeleteSecretOptions

A választható paraméterek.

Válaszok

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Helyreállítja a törölt titkos kulcsot a megadott tárolóban. Ez a függvény egy hosszú ideig futó művelet lekérdezőt ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a titkos kód helyreáll.

Ehhez a művelethez titkos kódokra/helyreállításra vonatkozó engedély szükséges.

Példahasználat:

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

Visszaállítja a törölt titkos kulcsot a legújabb verzióra.

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

Paraméterek

name

string

options
BeginRecoverDeletedSecretOptions

A választható paraméterek.

Válaszok

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

getDeletedSecret(string, GetDeletedSecretOptions)

A getDeletedSecret metódus a megadott törölt titkos kulcsot és attribútumait adja vissza. Ehhez a művelethez titkos kódokra/lekérési engedélyekre van szükség.

Példahasználat:

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

Lekéri a megadott törölt titkos kulcsot.

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

Paraméterek

secretName

string

A titkos kód neve.

options
GetDeletedSecretOptions

A választható paraméterek.

Válaszok

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

A getSecret metódus az Azure Key Vault tárolt titkos kódokra alkalmazható. Ehhez a művelethez titkos kódokra/lekérési engedélyekre van szükség.

Példahasználat:

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

Adott titkos kód lekérése egy adott kulcstartóból.

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

Paraméterek

secretName

string

A titkos kód neve.

options
GetSecretOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Iterálja a törölt titkos kulcsokat a tárolóban. A teljes titkos azonosítót és attribútumokat a válaszban adták meg. A titkos kódokhoz nem adnak vissza értékeket. Ehhez a művelethez titkos kódokra/listákra vonatkozó engedély szükséges.

Példahasználat:

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

Sorolja fel a tároló összes titkos kulcsát.

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

Paraméterek

options
ListDeletedSecretsOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iterálja a tárolóban lévő összes titkos kód legújabb verzióját. A teljes titkos azonosítót és attribútumokat a válaszban adták meg. A titkos kódokhoz nem adnak vissza értékeket. Ehhez a művelethez titkos kódokra/listákra vonatkozó engedély szükséges.

Példahasználat:

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

Sorolja fel a tároló összes titkos kulcsát.

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

Paraméterek

options
ListPropertiesOfSecretsOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iterálja a megadott titkos kód összes verzióját a tárolóban. A teljes titkos azonosítót és attribútumokat a válaszban adták meg. A titkos kódokhoz nem adnak vissza értékeket. Ehhez a művelethez titkos kódokra/listákra vonatkozó engedély szükséges.

Példahasználat:

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>

Paraméterek

secretName

string

Annak a titkos kódnak a neve, amelyhez verziókat szeretne lekérni.

options
ListPropertiesOfSecretVersionsOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

A törölt titkos kód törlése művelet véglegesen eltávolítja a titkos kódot, a helyreállítás lehetősége nélkül. Ez a művelet csak helyreállítható törlést engedélyező tárolón engedélyezhető. Ehhez a művelethez titkos kulcsra/törlésre vonatkozó engedély szükséges.

Példahasználat:

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

Véglegesen törli a megadott titkos kulcsot.

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

Paraméterek

secretName

string

A titkos kód neve.

options
PurgeDeletedSecretOptions

A választható paraméterek.

Válaszok

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Visszaállít egy biztonsági másolatot a titkos kódról és annak minden verziójáról egy tárolóba. Ehhez a művelethez titkos kulcsok/visszaállítási engedély szükséges.

Példahasználat:

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

Visszaállít egy biztonsági másolatban tárolt titkos kódot egy tárolóba.

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

Paraméterek

secretBundleBackup

Uint8Array

A titkos kódcsomaghoz társított biztonsági mentési blob.

options
RestoreSecretBackupOptions

A választható paraméterek.

Válaszok

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

A setSecret metódus titkos vagy titkos verziót ad hozzá az Azure Key Vault. Ha a nevesített titkos kód már létezik, az Azure Key Vault létrehozza a titkos kód új verzióját. Ehhez a művelethez titkos kódokra/beállítási engedélyekre van szükség.

Példahasználat:

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

Hozzáad egy titkos kódot egy adott kulcstartóhoz.

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

Paraméterek

secretName

string

A titkos kód neve.

value

string

A titkos kód értéke.

options
SetSecretOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Az updateSecret metódus módosítja egy meglévő tárolt titkos kód megadott attribútumait. A kérelemben nem megadott tulajdonságok változatlanok maradnak. Maga a titkos kód értéke nem módosítható. Ehhez a művelethez titkos kódokra/beállítási engedélyekre van szükség.

Példahasználat:

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

Frissítések egy adott kulcstartóban megadott titkos kódhoz társított attribútumokat.

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

Paraméterek

secretName

string

A titkos kód neve.

secretVersion

string

A titkos kód verziója.

options
UpdateSecretPropertiesOptions

A választható paraméterek.

Válaszok

Promise<SecretProperties>