Megosztás:

SecretClient class

Csomag:
@azure/keyvault-secrets

A SecretClient metódusokat biztosít KeyVaultSecret kezelésére az Azure Key Vaultban. 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 felsorolását. Az ügyfél emellett támogatja a DeletedSecret listáját a helyreállítható törlést engedélyező Azure Key Vaulthoz.

Konstruktorok

SecretClient(string, TokenCredential, SecretClientOptions)

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

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

// Lastly, create our keys client and connect to the service
const client = new SecretClient(url, credential);

Tulajdonságok

vaultUrl

A tároló alap URL-címe

Metódusok

backupSecret(string, BackupSecretOptions)

Kéri, hogy a megadott titkos kód biztonsági másolatát letöltse az ügyfélre. A titkos kód minden verziója letöltődik. Ehhez a művelethez titkos kulcsok/biztonsági mentési engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

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

Törli az Azure Key Vaultban tárolt titkos kódot. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja 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:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

await client.beginDeleteSecret(secretName);

Egy titkos kulcsot töröl egy megadott kulcstartóból.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

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

Ehhez a művelethez titkos kulcsok/helyreállítás engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret(secretName);
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

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

A getDeletedSecret metódus a megadott törölt titkos kulcsot adja vissza az attribútumaival együtt. Ehhez a művelethez titkos kulcsok/engedélyek szükségesek.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getDeletedSecret("MyDeletedSecret");

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

A getSecret metódus az Azure Key Vaultban tárolt titkos kódokra alkalmazható. Ehhez a művelethez titkos kulcsok/engedélyek szükségesek.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const latestSecret = await client.getSecret(secretName);
console.log(`Latest version of the secret ${secretName}: `, latestSecret);

const specificSecret = await client.getSecret(secretName, {
  version: latestSecret.properties.version!,
});
console.log(
  `The secret ${secretName} at the version ${latestSecret.properties.version!}: `,
  specificSecret,
);

Adott titkos kulcs 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álasz adja meg. A titkos kulcsok értéke nem lesz visszaadva. Ehhez a művelethez titkos kulcsok/listák engedélyére van szükség.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

Sorolja fel az összes titkos kódot a tárolóban.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iterates a legújabb verzióját az összes titkos kulcs a tárolóban. A teljes titkos azonosítót és attribútumokat a válasz adja meg. A titkos kulcsok értéke nem lesz visszaadva. Ehhez a művelethez titkos kulcsok/listák engedélyére van szükség.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

Sorolja fel az összes titkos kódot a tárolóban.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iterálja az adott titkos kód minden verzióját a tárolóban. A teljes titkos azonosítót és attribútumokat a válasz adja meg. A titkos kulcsok értéke nem lesz visszaadva. Ehhez a művelethez titkos kulcsok/listák engedélyére van szükség.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

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

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

await client.purgeDeletedSecret(secretName);

Véglegesen törli a megadott titkos kódot.
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:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

await client.restoreSecretBackup(backupResult);

Visszaállít egy biztonsági másolatként létrehozott titkos kulcsot egy tárolóba.
setSecret(string, string, SetSecretOptions)

A setSecret metódus titkos vagy titkos verziót ad hozzá az Azure Key Vaulthoz. Ha a névvel ellátott 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 kulcsok/beállítások megadása szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.setSecret(secretName, "MySecretValue");
console.log("result: ", result);

Titkos kulcsot ad hozzá egy megadott 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 kulcsok/beállítások megadása szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, result.properties.version, { enabled: false });

Frissíti az 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 { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

// Lastly, create our keys client and connect to the service
const client = new SecretClient(url, credential);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

Paraméterek

vaultUrl

string

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

credential
TokenCredential

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

pipelineOptions
SecretClientOptions

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

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ód biztonsági másolatát letöltse az ügyfélre. A titkos kód minden verziója letöltődik. Ehhez a művelethez titkos kulcsok/biztonsági mentési engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

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

Az opcionális paraméterek.

Válaszok

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Törli az Azure Key Vaultban tárolt titkos kódot. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja 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:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

await client.beginDeleteSecret(secretName);

Egy titkos kulcsot töröl egy megadott kulcstartóból.

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

Paraméterek

name

string

options
BeginDeleteSecretOptions

Az opcionális paraméterek.

Válaszok

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

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

Ehhez a művelethez titkos kulcsok/helyreállítás engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret(secretName);
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Helyreállítja a törölt titkos kódot a legújabb verzióra.

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

Paraméterek

name

string

options
BeginRecoverDeletedSecretOptions

Az opcionális paraméterek.

Válaszok

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

getDeletedSecret(string, GetDeletedSecretOptions)

A getDeletedSecret metódus a megadott törölt titkos kulcsot adja vissza az attribútumaival együtt. Ehhez a művelethez titkos kulcsok/engedélyek szükségesek.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = 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

Az opcionális paraméterek.

Válaszok

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

A getSecret metódus az Azure Key Vaultban tárolt titkos kódokra alkalmazható. Ehhez a művelethez titkos kulcsok/engedélyek szükségesek.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const latestSecret = await client.getSecret(secretName);
console.log(`Latest version of the secret ${secretName}: `, latestSecret);

const specificSecret = await client.getSecret(secretName, {
  version: latestSecret.properties.version!,
});
console.log(
  `The secret ${secretName} at the version ${latestSecret.properties.version!}: `,
  specificSecret,
);

Adott titkos kulcs 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

Az opcionális 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álasz adja meg. A titkos kulcsok értéke nem lesz visszaadva. Ehhez a művelethez titkos kulcsok/listák engedélyére van szükség.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

Sorolja fel az összes titkos kódot a tárolóban.

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

Paraméterek

options
ListDeletedSecretsOptions

Az opcionális paraméterek.

Válaszok

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Iterates a legújabb verzióját az összes titkos kulcs a tárolóban. A teljes titkos azonosítót és attribútumokat a válasz adja meg. A titkos kulcsok értéke nem lesz visszaadva. Ehhez a művelethez titkos kulcsok/listák engedélyére van szükség.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

Sorolja fel az összes titkos kódot a tárolóban.

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

Paraméterek

options
ListPropertiesOfSecretsOptions

Az opcionális paraméterek.

Válaszok

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Iterálja az adott titkos kód minden verzióját a tárolóban. A teljes titkos azonosítót és attribútumokat a válasz adja meg. A titkos kulcsok értéke nem lesz visszaadva. Ehhez a művelethez titkos kulcsok/listák engedélyére van szükség.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Paraméterek

secretName

string

A verziók lekéréséhez szükséges titkos kód neve.

options
ListPropertiesOfSecretVersionsOptions

Az opcionális 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 anélkül, hogy lehetséges lett a helyreállítás. Ez a művelet csak helyreállítható törlést engedélyező tárolón engedélyezhető. Ehhez a művelethez titkos kulcsok/törlési engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

await client.purgeDeletedSecret(secretName);

Véglegesen törli a megadott titkos kódot.

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

Paraméterek

secretName

string

A titkos kód neve.

options
PurgeDeletedSecretOptions

Az opcionális 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:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

await client.restoreSecretBackup(backupResult);

Visszaállít egy biztonsági másolatként létrehozott titkos kulcsot egy tárolóba.

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

Paraméterek

secretBundleBackup

Uint8Array

Titkos csomaghoz társított biztonsági mentési blob.

options
RestoreSecretBackupOptions

Az opcionális paraméterek.

Válaszok

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

A setSecret metódus titkos vagy titkos verziót ad hozzá az Azure Key Vaulthoz. Ha a névvel ellátott 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 kulcsok/beállítások megadása szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.setSecret(secretName, "MySecretValue");
console.log("result: ", result);

Titkos kulcsot ad hozzá egy megadott 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

Az opcionális 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 kulcsok/beállítások megadása szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, result.properties.version, { enabled: false });

Frissíti az 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

Az opcionális paraméterek.

Válaszok

Promise<SecretProperties>