مشاركة عبر

SecretClient class

الحزمة:
@azure/keyvault-secrets

يوفر SecretClient أساليب لإدارة KeyVaultSecret في Azure Key Vault. يدعم العميل إنشاء KeyVaultSecrets واستردادها وتحديثها وحذفها وتطهيرها ونسخها احتياطيا واستعادتها وإدراجها. يدعم العميل أيضا سرد DeletedSecret ل Azure Key Vault ممكن للحذف المبدئي.

المنشئون

SecretClient(string, TokenCredential, SecretClientOptions)

إنشاء مثيل SecretClient.

مثال على الاستخدام:

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

الخصائص

vaultUrl

عنوان URL الأساسي للمخزن

الأساليب

backupSecret(string, BackupSecretOptions)

يطلب تنزيل نسخة احتياطية من السر المحدد إلى العميل. سيتم تنزيل جميع إصدارات البيانات السرية. تتطلب هذه العملية إذن البيانات السرية/النسخ الاحتياطي.

مثال على الاستخدام:

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

نسخ البيانات السرية المحددة احتياطيا.
beginDeleteSecret(string, BeginDeleteSecretOptions)

حذف سر مخزن في Azure Key Vault. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم حذف السر.

تتطلب هذه العملية إذن الأسرار/الحذف.

مثال على الاستخدام:

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

حذف سر من مخزن مفاتيح محدد.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

استرداد البيانات السرية المحذوفة في المخزن المحدد. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد التي تسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد السر.

تتطلب هذه العملية إذن الأسرار/الاسترداد.

مثال على الاستخدام:

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

استرداد البيانات السرية المحذوفة إلى أحدث إصدار.
getDeletedSecret(string, GetDeletedSecretOptions)

يقوم الأسلوب getDeletedSecret بإرجاع السر المحذوف المحدد مع سماته. تتطلب هذه العملية الحصول على البيانات السرية/الحصول على إذن.

مثال على الاستخدام:

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

يحصل على البيانات السرية المحذوفة المحددة.
getSecret(string, GetSecretOptions)

تنطبق طريقة getSecret على أي بيانات سرية مخزنة في Azure Key Vault. تتطلب هذه العملية الحصول على البيانات السرية/الحصول على إذن.

مثال على الاستخدام:

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

احصل على سر محدد من مخزن مفاتيح معين.
listDeletedSecrets(ListDeletedSecretsOptions)

تكرار الأسرار المحذوفة في المخزن. يتم توفير المعرف السري الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للبيانات السرية. تتطلب هذه العمليات إذن البيانات السرية/القائمة.

مثال على الاستخدام:

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

سرد جميع الأسرار في المخزن.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

تكرار أحدث إصدار من جميع الأسرار في المخزن. يتم توفير المعرف السري الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للبيانات السرية. تتطلب هذه العمليات إذن البيانات السرية/القائمة.

مثال على الاستخدام:

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

سرد جميع الأسرار في المخزن.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

يكرر جميع إصدارات البيانات السرية المحددة في المخزن. يتم توفير المعرف السري الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للبيانات السرية. تتطلب هذه العمليات إذن البيانات السرية/القائمة.

مثال على الاستخدام:

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)

عملية مسح البيانات السرية المحذوفة يزيل السر بشكل دائم، دون إمكانية الاسترداد. يمكن تمكين هذه العملية فقط على مخزن ممكن للحذف المبدئي. تتطلب هذه العملية إذن الأسرار/التطهير.

مثال على الاستخدام:

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

حذف البيانات السرية المحددة بشكل دائم.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

استعادة سر تم نسخه احتياطيا، وجميع إصداراته، إلى مخزن. تتطلب هذه العملية إذن الأسرار/الاستعادة.

مثال على الاستخدام:

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

استعادة سر تم نسخه احتياطيا إلى مخزن.
setSecret(string, string, SetSecretOptions)

يضيف أسلوب setSecret إصدارا سريا أو سريا إلى Azure Key Vault. إذا كان السر المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من هذا السر. تتطلب هذه العملية إذن البيانات السرية/تعيين.

مثال على الاستخدام:

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

إضافة سر في مخزن مفاتيح محدد.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

يغير أسلوب updateSecret السمات المحددة لسر مخزن موجود. يتم ترك الخصائص غير المحددة في الطلب دون تغيير. لا يمكن تغيير قيمة البيانات السرية نفسها. تتطلب هذه العملية إذن البيانات السرية/تعيين.

مثال على الاستخدام:

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

تحديث السمات المقترنة بسر محدد في مخزن مفاتيح معين.

تفاصيل المنشئ

SecretClient(string, TokenCredential, SecretClientOptions)

إنشاء مثيل SecretClient.

مثال على الاستخدام:

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)

المعلمات

vaultUrl

string

عنوان URL الأساسي للمخزن. يجب التحقق من أن عنوان URL هذا يشير إلى مورد Key Vault صالح. راجع https://aka.ms/azsdk/blog/vault-uri للحصول على التفاصيل.

credential
TokenCredential

كائن ينفذ واجهة TokenCredential المستخدمة لمصادقة الطلبات إلى الخدمة. استخدم حزمة @azure/identity لإنشاء بيانات اعتماد تناسب احتياجاتك.

pipelineOptions
SecretClientOptions

خيارات البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة لتكوين طلبات واجهة برمجة تطبيقات Key Vault. احذف هذه المعلمة لاستخدام تكوين المسار الافتراضي.

تفاصيل الخاصية

vaultUrl

عنوان URL الأساسي للمخزن

vaultUrl: string

قيمة الخاصية

string

تفاصيل الأسلوب

backupSecret(string, BackupSecretOptions)

يطلب تنزيل نسخة احتياطية من السر المحدد إلى العميل. سيتم تنزيل جميع إصدارات البيانات السرية. تتطلب هذه العملية إذن البيانات السرية/النسخ الاحتياطي.

مثال على الاستخدام:

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

نسخ البيانات السرية المحددة احتياطيا.

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

المعلمات

secretName

string

اسم السر.

options
BackupSecretOptions

المعلمات الاختيارية.

المرتجعات

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

حذف سر مخزن في Azure Key Vault. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم حذف السر.

تتطلب هذه العملية إذن الأسرار/الحذف.

مثال على الاستخدام:

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

حذف سر من مخزن مفاتيح محدد.

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

المعلمات

name

string

options
BeginDeleteSecretOptions

المعلمات الاختيارية.

المرتجعات

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

استرداد البيانات السرية المحذوفة في المخزن المحدد. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد التي تسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد السر.

تتطلب هذه العملية إذن الأسرار/الاسترداد.

مثال على الاستخدام:

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

استرداد البيانات السرية المحذوفة إلى أحدث إصدار.

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

المعلمات

name

string

options
BeginRecoverDeletedSecretOptions

المعلمات الاختيارية.

المرتجعات

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

getDeletedSecret(string, GetDeletedSecretOptions)

يقوم الأسلوب getDeletedSecret بإرجاع السر المحذوف المحدد مع سماته. تتطلب هذه العملية الحصول على البيانات السرية/الحصول على إذن.

مثال على الاستخدام:

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

يحصل على البيانات السرية المحذوفة المحددة.

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

المعلمات

secretName

string

اسم السر.

options
GetDeletedSecretOptions

المعلمات الاختيارية.

المرتجعات

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

تنطبق طريقة getSecret على أي بيانات سرية مخزنة في Azure Key Vault. تتطلب هذه العملية الحصول على البيانات السرية/الحصول على إذن.

مثال على الاستخدام:

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

احصل على سر محدد من مخزن مفاتيح معين.

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

المعلمات

secretName

string

اسم السر.

options
GetSecretOptions

المعلمات الاختيارية.

المرتجعات

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

تكرار الأسرار المحذوفة في المخزن. يتم توفير المعرف السري الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للبيانات السرية. تتطلب هذه العمليات إذن البيانات السرية/القائمة.

مثال على الاستخدام:

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 listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

المعلمات

options
ListDeletedSecretsOptions

المعلمات الاختيارية.

المرتجعات

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

تكرار أحدث إصدار من جميع الأسرار في المخزن. يتم توفير المعرف السري الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للبيانات السرية. تتطلب هذه العمليات إذن البيانات السرية/القائمة.

مثال على الاستخدام:

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 listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

المعلمات

options
ListPropertiesOfSecretsOptions

المعلمات الاختيارية.

المرتجعات

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

يكرر جميع إصدارات البيانات السرية المحددة في المخزن. يتم توفير المعرف السري الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للبيانات السرية. تتطلب هذه العمليات إذن البيانات السرية/القائمة.

مثال على الاستخدام:

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>

المعلمات

secretName

string

اسم السر لجلب الإصدارات له.

options
ListPropertiesOfSecretVersionsOptions

المعلمات الاختيارية.

المرتجعات

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

عملية مسح البيانات السرية المحذوفة يزيل السر بشكل دائم، دون إمكانية الاسترداد. يمكن تمكين هذه العملية فقط على مخزن ممكن للحذف المبدئي. تتطلب هذه العملية إذن الأسرار/التطهير.

مثال على الاستخدام:

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

حذف البيانات السرية المحددة بشكل دائم.

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

المعلمات

secretName

string

اسم السر.

options
PurgeDeletedSecretOptions

المعلمات الاختيارية.

المرتجعات

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

استعادة سر تم نسخه احتياطيا، وجميع إصداراته، إلى مخزن. تتطلب هذه العملية إذن الأسرار/الاستعادة.

مثال على الاستخدام:

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

استعادة سر تم نسخه احتياطيا إلى مخزن.

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

المعلمات

secretBundleBackup

Uint8Array

كائن ثنائي كبير الحجم للنسخ الاحتياطي المرتبط بمجموعة بيانات سرية.

options
RestoreSecretBackupOptions

المعلمات الاختيارية.

المرتجعات

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

يضيف أسلوب setSecret إصدارا سريا أو سريا إلى Azure Key Vault. إذا كان السر المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من هذا السر. تتطلب هذه العملية إذن البيانات السرية/تعيين.

مثال على الاستخدام:

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

إضافة سر في مخزن مفاتيح محدد.

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

المعلمات

secretName

string

اسم السر.

value

string

قيمة السر.

options
SetSecretOptions

المعلمات الاختيارية.

المرتجعات

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

يغير أسلوب updateSecret السمات المحددة لسر مخزن موجود. يتم ترك الخصائص غير المحددة في الطلب دون تغيير. لا يمكن تغيير قيمة البيانات السرية نفسها. تتطلب هذه العملية إذن البيانات السرية/تعيين.

مثال على الاستخدام:

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

تحديث السمات المقترنة بسر محدد في مخزن مفاتيح معين.

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

المعلمات

secretName

string

اسم السر.

secretVersion

string

نسخة السر.

options
UpdateSecretPropertiesOptions

المعلمات الاختيارية.

المرتجعات

Promise<SecretProperties>