KeyClient class

إنشاء مثيل 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)

المعلمات

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

vaultUrl: string

قيمة الخاصية

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

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

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

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

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

المعلمات

المرتجعات

تنطبق عملية الحذف على أي مفتاح مخزن في 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>>

المعلمات

المرتجعات

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

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

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

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

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

المعلمات

المرتجعات

ينشئ أسلوب 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>

المعلمات

المرتجعات

يمكن استخدام عملية إنشاء مفتاح لإنشاء أي نوع مفتاح في 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>

المعلمات

المرتجعات

ينشئ أسلوب 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>

المعلمات

المرتجعات

ينشئ أسلوب 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>

المعلمات

المرتجعات

يحصل على تشفير Client للمفتاح المحدد.

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

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

المعلمات

المرتجعات

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

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

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

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

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

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

المعلمات

المرتجعات

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

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

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

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

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

المعلمات

المرتجعات

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

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

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

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

المعلمات

المرتجعات

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

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

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

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

المعلمات

المرتجعات

يمكن استخدام عملية مفتاح الاستيراد لاستيراد أي نوع مفتاح إلى Azure Key Vault. إذا كان المفتاح المسمى موجودا بالفعل، يقوم 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, options?: ImportKeyOptions): Promise<KeyVaultKey>

المعلمات

المرتجعات

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

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

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>

المعلمات

المرتجعات

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

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

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>

المعلمات

المرتجعات

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

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

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>

المعلمات

المرتجعات

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

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

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>

المعلمات

المرتجعات

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

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

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

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

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

المعلمات

المرتجعات

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

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

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>

المعلمات

المرتجعات

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

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

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

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

المعلمات

المرتجعات

يغير أسلوب 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>

المعلمات

المرتجعات

يغير أسلوب 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>

المعلمات

المرتجعات

تحديث نهج التدوير لمفتاح 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>

المعلمات

المرتجعات