@azure/keyvault-secrets package

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

خيارات <xref:backupSecretOptions>.

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteSecret(string, BeginDeleteSecretOptions)

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

واجهة تمثل KeyVault Secret محذوف.

خيارات getDeletedSecret(string, GetDeletedSecretOptions).

خيارات getSecret(string, GetSecretOptions).

واجهة تمثل KeyVault Secret، مع اسمها وقيمتها SecretProperties.

يمثل المقاطع التي تشكل معرف سري ل Key Vault.

خيارات listDeletedSecrets(ListDeletedSecretsOptions).

خيارات listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

خيارات listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

واجهة تتعقب إعدادات التكرار المصفح

واجهة تسمح بالتكرار غير المتزامن حتى الاكتمال والصفحة.

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

بينما تعمل فئة Poller كآلية تحكم محلية لبدء التشغيل والانتظار والإلغاء المحتمل لعملية تشغيل طويلة، توثق PollOperationState حالة عملية التشغيل الطويل البعيد.

يجب تحديثه على الأقل عند بدء العملية، ومتى تنتهي، ومتى يتم إلغاؤها. على الرغم من ذلك، يمكن أن يكون للتطبيقات أي عدد آخر من الخصائص التي يمكن تحديثها لأسباب أخرى.

تمثيل تجريدي للمطلع، يهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.

خيارات purgeDeletedSecret(string, PurgeDeletedSecretOptions).

خيارات restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

المعلمات الاختيارية المقبولة من قبل KeyVault's KeyClient

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteSecret(string, BeginDeleteSecretOptions)<xref:beginRecoverDeletedKey>.

واجهة تمثل خصائص KeyVaultSecret.

خيارات setSecret(string, string, SetSecretOptions).

خيارات updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

نوع الوسائط (نوع MIME) للشهادة. إذا تم تحديد تنسيق مدعوم، يتم تحويل محتوى الشهادة إلى التنسيق المطلوب. حاليا، يدعم فقط تحويل PFX إلى PEM.

يعكس مستوى استرداد الحذف الساري حاليا للبيانات السرية في المخزن الحالي. إذا كان يحتوي على "قابل للإزالة"، يمكن حذف السر نهائيا من قبل مستخدم متميز؛ وإلا، يمكن للنظام فقط إزالة البيانات السرية، في نهاية الفاصل الزمني للاحتفاظ.
KnownDeletionRecoveryLevel يمكن استخدامها بالتبادل مع DeleteionRecoveryLevel، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

القابلة للإزالة: تشير إلى حالة المخزن التي يكون فيها الحذف عملية لا رجعة فيها، دون إمكانية الاسترداد. يتوافق هذا المستوى مع عدم توفر أي حماية ضد عملية الحذف؛ يتم فقدان البيانات بشكل لا يمكن إصلاحه عند قبول عملية حذف على مستوى الكيان أو أعلى (المخزن ومجموعة الموارد والاشتراك وما إلى ذلك)
Recoverable+Purgeable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد، والذي يسمح أيضا بالحذف الفوري والدائم (أي الإزالة). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء (90 يوما)، ما لم يتم طلب عملية إزالة، أو تم إلغاء الاشتراك. النظام حذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده
قابل للاسترداد: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد دون إمكانية الحذف الفوري والدائم (أي الإزالة). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء (90 يوما) وبينما لا يزال الاشتراك متوفرا. النظام حذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده
Recoverable+ProtectedSubscription: يشير إلى حالة المخزن والاشتراك التي يكون فيها الحذف قابلا للاسترداد خلال فترة الاستبقاء (90 يوما)، ولا يسمح بالحذف الفوري والدائم (أي التطهير)، ولا يمكن فيه إلغاء الاشتراك نفسه نهائيا. النظام حذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده
CustomizedRecoverable+Purgeable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد، والذي يسمح أيضا بالحذف الفوري والدائم (أي الإزالة عند 7 <= SoftDeleteRetentionInDays < 90). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ما لم يتم طلب عملية إزالة، أو تم إلغاء الاشتراك.
CustomizedRecoverable : يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد دون إمكانية الحذف الفوري والدائم (أي الإزالة عند 7 <= SoftDeleteRetentionInDays < 90). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء الفاصل الزمني للاستبقاء وبينما لا يزال الاشتراك متوفرا.
CustomizedRecoverable+ProtectedSubscription: يشير إلى حالة المخزن والاشتراك التي يكون فيها الحذف قابلا للاسترداد، والحذف الفوري والدائم (أي الإزالة)، ولا يمكن فيه إلغاء الاشتراك نفسه بشكل دائم عند 7 <= SoftDeleteRetentionInDays < 90. يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ويعكس أيضا حقيقة أنه لا يمكن إلغاء الاشتراك نفسه.

القيم المعروفة لنوع المحتوى التي تقبلها الخدمة.

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

يحلل معرف السر الخاص ب Key Vault المعطا. مثال على ذلك:

https://< keyvault-name.vault.azure.net/secrets/>< secret-name>/<unique-version-id>

عند تحليل المعرف أعلاه، ترجع هذه الدالة:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

@azure/logger تكوين هذه الحزمة.