مشاركة عبر

KeyClient class

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

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

المنشئون

KeyClient(string, TokenCredential, KeyClientOptions)

إنشاء مثيل KeyClient.

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

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

const credential = new DefaultAzureCredential();

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

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

الخصائص

vaultUrl

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

الأساليب

backupKey(string, BackupKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

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

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

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const poller = await client.beginDeleteKey(keyName);
await poller.pollUntilDone();

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

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

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedKey(keyName);
const recoveredKey = await recoverPoller.pollUntilDone();

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createEcKey(keyName, { curve: "P-256" });
console.log("result: ", result);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createKey(keyName, "RSA");
console.log("result: ", result);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createOctKey("MyKey", { hsm: true });
console.log("result: ", result);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createRsaKey("MyKey", { keySize: 2048 });
console.log("result: ", result);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

// Get a cryptography client for a given key
const cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

await client.getDeletedKey(keyName);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKey(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKey(keyName, { version: latestKey.properties.version! });
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKeyAttestation(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKeyAttestation(keyName, {
  version: latestKey.properties.version!,
});
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.getKeyRotationPolicy(keyName);
getRandomBytes(number, GetRandomBytesOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const bytes = await client.getRandomBytes(10);
importKey(string, JsonWebKey, ImportKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};

const result = await client.importKey("MyKey", jsonWebKey);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

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

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

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

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

await client.purgeDeletedKey(keyName);

حذف المفتاح المحدد بشكل دائم.
releaseKey(string, string, ReleaseKeyOptions)

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.releaseKey("myKey", "<attestation-target>");
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

const key = await client.restoreKeyBackup(backupContents);

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

// Set the key's automated rotation policy to rotate the key 30 days before expiry.
const policy = await client.updateKeyRotationPolicy(keyName, {
  lifetimeActions: [
    {
      action: "Rotate",
      timeBeforeExpiry: "P30D",
    },
  ],
  // You may also specify the duration after which any newly rotated key will expire.
  // In this case, any new key versions will expire after 90 days.
  expiresIn: "P90D",
});

// You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
const currentPolicy = await client.getKeyRotationPolicy(keyName);

// Finally, you can rotate a key on-demand by creating a new version of the given key.
const rotatedKey = await client.rotateKey(keyName);
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const myPolicy = await client.getKeyRotationPolicy(keyName);

const setPolicy = await client.updateKeyRotationPolicy(keyName, myPolicy);

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

KeyClient(string, TokenCredential, KeyClientOptions)

إنشاء مثيل KeyClient.

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

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

const credential = new DefaultAzureCredential();

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

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

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)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

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

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

المعلمات

name

string

اسم المفتاح.

options
BackupKeyOptions

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

المرتجعات

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

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

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const poller = await client.beginDeleteKey(keyName);
await poller.pollUntilDone();

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

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

المعلمات

name

string

اسم المفتاح.

options
BeginDeleteKeyOptions

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

المرتجعات

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedKey(keyName);
const recoveredKey = await recoverPoller.pollUntilDone();

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

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 بإنشاء إصدار جديد من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createEcKey(keyName, { curve: "P-256" });
console.log("result: ", result);

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

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

المعلمات

name

string

اسم المفتاح.

options
CreateEcKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createKey(keyName, "RSA");
console.log("result: ", result);

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

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 بإنشاء إصدار جديد من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createOctKey("MyKey", { hsm: true });
console.log("result: ", result);

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

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 بإنشاء إصدار جديد من المفتاح. يتطلب إذن المفاتيح/الإنشاء.

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createRsaKey("MyKey", { keySize: 2048 });
console.log("result: ", result);

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

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

المعلمات

name

string

اسم المفتاح.

options
CreateRsaKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

// Get a cryptography client for a given key
const cryptographyClient = client.getCryptographyClient("MyKey");

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

المعلمات

keyName

string

options
GetCryptographyClientOptions

المرتجعات

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

await client.getDeletedKey(keyName);

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

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

المعلمات

name

string

اسم المفتاح.

options
GetDeletedKeyOptions

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

المرتجعات

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKey(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKey(keyName, { version: latestKey.properties.version! });
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

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

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

المعلمات

name

string

اسم المفتاح.

options
GetKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

getKeyAttestation(string, GetKeyAttestationOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKeyAttestation(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKeyAttestation(keyName, {
  version: latestKey.properties.version!,
});
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

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

function getKeyAttestation(name: string, options?: GetKeyAttestationOptions): Promise<KeyVaultKey>

المعلمات

name

string

اسم المفتاح.

options
GetKeyAttestationOptions

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

المرتجعات

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.getKeyRotationPolicy(keyName);

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

المعلمات

keyName

string

اسم المفتاح.

options
GetKeyRotationPolicyOptions

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

المرتجعات

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const bytes = await client.getRandomBytes(10);

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

المعلمات

count

number

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

options
GetRandomBytesOptions

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

المرتجعات

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};

const result = await client.importKey("MyKey", jsonWebKey);

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

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

المعلمات

name

string

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

key
JsonWebKey

مفتاح ويب JSON.

options
ImportKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

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

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

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

المعلمات

options
ListDeletedKeysOptions

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

المرتجعات

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

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

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

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

المعلمات

options
ListPropertiesOfKeysOptions

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

المرتجعات

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

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

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

المعلمات

name

string

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

options
ListPropertiesOfKeyVersionsOptions

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

المرتجعات

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

await client.purgeDeletedKey(keyName);

حذف المفتاح المحدد بشكل دائم.

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

المعلمات

name

string

اسم المفتاح.

options
PurgeDeletedKeyOptions

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

المرتجعات

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

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

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.releaseKey("myKey", "<attestation-target>");

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

المعلمات

name

string

اسم المفتاح.

targetAttestationToken

string

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

options
ReleaseKeyOptions

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

المرتجعات

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

const key = await client.restoreKeyBackup(backupContents);

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

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

المعلمات

backup

Uint8Array

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

options
RestoreKeyBackupOptions

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

المرتجعات

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

// Set the key's automated rotation policy to rotate the key 30 days before expiry.
const policy = await client.updateKeyRotationPolicy(keyName, {
  lifetimeActions: [
    {
      action: "Rotate",
      timeBeforeExpiry: "P30D",
    },
  ],
  // You may also specify the duration after which any newly rotated key will expire.
  // In this case, any new key versions will expire after 90 days.
  expiresIn: "P90D",
});

// You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
const currentPolicy = await client.getKeyRotationPolicy(keyName);

// Finally, you can rotate a key on-demand by creating a new version of the given key.
const rotatedKey = await client.rotateKey(keyName);

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

المعلمات

name

string

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

options
RotateKeyOptions

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

المرتجعات

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.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 الخصائص المحددة لأحدث إصدار من مفتاح مخزن موجود. يتم ترك الخصائص غير المحددة في الطلب دون تغيير. لا يمكن تغيير قيمة المفتاح نفسه. تتطلب هذه العملية إذن المفاتيح/التعيين.

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

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

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

المعلمات

name

string

اسم المفتاح.

options
UpdateKeyPropertiesOptions

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

المرتجعات

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

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

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

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

const credential = new DefaultAzureCredential();

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

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const myPolicy = await client.getKeyRotationPolicy(keyName);

const setPolicy = await client.updateKeyRotationPolicy(keyName, myPolicy);

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

المعلمات

keyName

string

اسم المفتاح.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

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

المرتجعات

Promise<KeyRotationPolicy>