مشاركة عبر

KeyClient class

  • ‏‏المرجع
الحزمة:
@azure/keyvault-keys

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

المنشئون

KeyClient(string, TokenCredential, KeyClientOptions)

إنشاء مثيل KeyClient.

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

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

الخصائص

vaultUrl

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

الأساليب

backupKey(string, BackupKeyOptions)

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

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

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

النسخ الاحتياطي للمفتاح المحدد.
beginDeleteKey(string, BeginDeleteKeyOptions)

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

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

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

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

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

حذف مفتاح من مخزن مفاتيح محدد.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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

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

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

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

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

استرداد المفتاح المحذوف إلى أحدث إصدار.
createEcKey(string, CreateEcKeyOptions)

ينشئ أسلوب createEcKey مفتاح منحنى قطع ناقص جديد في Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.
createKey(string, string, CreateKeyOptions)

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

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

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.
createOctKey(string, CreateOctKeyOptions)

ينشئ أسلوب createOctKey مفتاح OCT جديدا في Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.
createRsaKey(string, CreateRsaKeyOptions)

ينشئ أسلوب createRSAKey مفتاح RSA جديدا في Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.
getCryptographyClient(string, GetCryptographyClientOptions)

يحصل على CryptographyClient للمفتاح المحدد.

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

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

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

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

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

يحصل على المفتاح المحذوف المحدد.
getKey(string, GetKeyOptions)

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

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

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

احصل على مفتاح محدد من مخزن مفاتيح معين.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

يحصل على نهج التدوير لمفتاح Key Vault. بشكل افتراضي، تحتوي جميع المفاتيح على نهج سيخطر قبل 30 يوما من انتهاء الصلاحية.

تتطلب هذه العملية الحصول على المفاتيح/الحصول على إذن. استخدام المثال:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");
getRandomBytes(number, GetRandomBytesOptions)

يحصل على العدد المطلوب من وحدات البايت التي تحتوي على قيم عشوائية من HSM مدار. تتطلب هذه العملية إذن managedHsm/rng.

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

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);
importKey(string, JsonWebKey_2, ImportKeyOptions)

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

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

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

استيراد مفتاح تم إنشاؤه خارجيا وتخزينه وإرجاع معلمات وخصائص المفتاح إلى العميل.
listDeletedKeys(ListDeletedKeysOptions)

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

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

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

سرد جميع المفاتيح في المخزن
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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

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

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

سرد جميع المفاتيح في المخزن
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

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

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

حذف المفتاح المحدد نهائيا.
releaseKey(string, string, ReleaseKeyOptions)

إصدار مفتاح من HSM مدار.

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

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

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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

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

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

استعادة مفتاح تم نسخه احتياطيا إلى مخزن.
rotateKey(string, RotateKeyOptions)

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

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

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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

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

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

التحديثات الخصائص المقترنة بمفتاح محدد في مخزن مفاتيح معين.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

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

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

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

التحديثات الخصائص المقترنة بمفتاح محدد في مخزن مفاتيح معين.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

التحديثات نهج التدوير لمفتاح Key Vault. تتطلب هذه العملية إذن المفاتيح/التحديث.

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

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

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

KeyClient(string, TokenCredential, KeyClientOptions)

إنشاء مثيل KeyClient.

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

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

المعلمات

vaultUrl

string

عنوان URL Key Vault. يجب أن يحتوي على هذا الشكل: https://${your-key-vault-name}.vault.azure.net. يجب التحقق من أن عنوان URL هذا يشير إلى مورد Key Vault أو HSM مدار صالح. راجع https://aka.ms/azsdk/blog/vault-uri للحصول على التفاصيل.

credential
TokenCredential

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

pipelineOptions
KeyClientOptions

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

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

vaultUrl

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

vaultUrl: string

قيمة الخاصية

string

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

backupKey(string, BackupKeyOptions)

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

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

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

النسخ الاحتياطي للمفتاح المحدد.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

المعلمات

name

string

اسم المفتاح.

options
BackupKeyOptions

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

المرتجعات

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

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

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

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

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

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

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

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

المعلمات

name

string

اسم المفتاح.

options
BeginDeleteKeyOptions

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

المرتجعات

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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

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

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

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

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

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

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

المعلمات

name

string

اسم المفتاح المحذوف.

options
BeginRecoverDeletedKeyOptions

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

المرتجعات

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

ينشئ أسلوب createEcKey مفتاح منحنى قطع ناقص جديد في Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

options
CreateEcKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

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

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

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

keyType

string

نوع المفتاح. أحد الإجراءات التالية: "EC"، "EC-HSM"، "RSA"، "RSA-HSM"، "oct".

options
CreateKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

ينشئ أسلوب createOctKey مفتاح OCT جديدا في Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

options
CreateOctKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

ينشئ أسلوب createRSAKey مفتاح RSA جديدا في Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، فإن Azure Key Vault ينشئ إصدارا جديدا من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

ينشئ مفتاحا جديدا، ويخزنه، ثم يرجع معلمات وخصائص المفتاح إلى العميل.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

options
CreateRsaKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

يحصل على CryptographyClient للمفتاح المحدد.

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

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

المعلمات

keyName

string

options
GetCryptographyClientOptions

المرتجعات

CryptographyClient
  • تشفيرClient باستخدام نفس الخيارات وبيانات الاعتماد وعميل http مثل KeyClient هذا

getDeletedKey(string, GetDeletedKeyOptions)

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

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

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

يحصل على المفتاح المحذوف المحدد.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

المعلمات

name

string

اسم المفتاح.

options
GetDeletedKeyOptions

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

المرتجعات

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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

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

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

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

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

options
GetKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

يحصل على نهج التدوير لمفتاح Key Vault. بشكل افتراضي، تحتوي جميع المفاتيح على نهج سيخطر قبل 30 يوما من انتهاء الصلاحية.

تتطلب هذه العملية الحصول على المفاتيح/الحصول على إذن. استخدام المثال:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

المعلمات

keyName

string

اسم المفتاح.

options
GetKeyRotationPolicyOptions

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

المرتجعات

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

يحصل على العدد المطلوب من وحدات البايت التي تحتوي على قيم عشوائية من HSM مدار. تتطلب هذه العملية إذن managedHsm/rng.

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

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

المعلمات

count

number

عدد وحدات البايت المراد إنشاؤها بين 1 و128 ضمنا.

options
GetRandomBytesOptions

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

المرتجعات

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

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

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

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

استيراد مفتاح تم إنشاؤه خارجيا وتخزينه وإرجاع معلمات وخصائص المفتاح إلى العميل.

function importKey(name: string, key: JsonWebKey_2, options?: ImportKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح المستورد.

key
JsonWebKey

مفتاح ويب JSON.

options
ImportKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

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

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

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

سرد جميع المفاتيح في المخزن

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

المعلمات

options
ListDeletedKeysOptions

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

المرتجعات

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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

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

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

سرد جميع المفاتيح في المخزن

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

المعلمات

options
ListPropertiesOfKeysOptions

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

المرتجعات

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

المعلمات

name

string

اسم المفتاح لجلب الإصدارات ل

options
ListPropertiesOfKeyVersionsOptions

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

المرتجعات

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

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

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

حذف المفتاح المحدد نهائيا.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

المعلمات

name

string

اسم المفتاح.

options
PurgeDeletedKeyOptions

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

المرتجعات

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

إصدار مفتاح من HSM مدار.

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

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

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

المعلمات

name

string

اسم المفتاح.

targetAttestationToken

string

تأكيد التصديق لهدف إصدار المفتاح.

options
ReleaseKeyOptions

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

المرتجعات

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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

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

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

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

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

المعلمات

backup

Uint8Array

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

options
RestoreKeyBackupOptions

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

المرتجعات

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

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

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

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح المراد تدويره.

options
RotateKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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

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

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

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

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

keyVersion

string

إصدار المفتاح.

options
UpdateKeyPropertiesOptions

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

المرتجعات

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

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

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

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

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

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

options
UpdateKeyPropertiesOptions

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

المرتجعات

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

التحديثات نهج التدوير لمفتاح Key Vault. تتطلب هذه العملية إذن المفاتيح/التحديث.

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

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

المعلمات

keyName

string

اسم المفتاح.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

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

المرتجعات

Promise<KeyRotationPolicy>