@azure/keyvault-certificates package

العميل للتفاعل مع وظيفة شهادات KeyVault

تفاصيل مسؤول المؤسسة لمصدر الشهادة.

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

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

المعلمات الاختيارية المقبولة من قبل CertificateClient الخاص ب KeyVault

شكل معلومات جهة الاتصال لشهادات المخزن.

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

يتم إرجاع عملية شهادة في حالة الطلبات غير المتزامنة.

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

واجهة تمثل الخصائص المتاحة للجمهور لحالة CertificateOperationPoller.

واجهة تمثل نهج الشهادة (بدون خصائص الموضوع).

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)beginDeleteCertificate(string, CertificatePollerOptions)beginRecoverDeletedCertificate(string, CertificatePollerOptions)

واجهة تمثل خصائص الشهادة

الأسماء البديلة للموضوع لكائن X509.

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

خيارات createIssuer(string, string, CreateIssuerOptions).

واجهة تمثل شهادة محذوفة.

نموذج خطأ خادم المخزن الرئيسي.

خيارات importCertificate(string, Uint8Array, ImportCertificateOptions).

سمات المصدر التي تديرها خدمة Key Vault.

بيانات الاعتماد التي سيتم استخدامها لمصدر الشهادة.

معلمات المصدر لمكون X509 للشهادة.

واجهة تمثل خصائص مصدر الشهادة

واجهة تمثل شهادة بدون نهج الشهادة

يمثل المقاطع التي تقوم بإنشاء معرف شهادة Key Vault.

واجهة تمثل الشكل العام لحالة عمليات Key Vault Certificate Poller.

واجهة تمثل شهادة مع نهجها

الإجراء ومشغله الذي سيتم تنفيذه بواسطة Key Vault على مدى عمر الشهادة.

واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listDeletedCertificates(ListDeletedCertificatesOptions).

واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).

واجهة تمثل خصائص الموضوع المحتملة لنهج الشهادة. يتطلب النوع الأخير وجود خاصية واحدة على الأقل من هذه الخصائص.

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

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

واجهة تمثل الأسماء البديلة لموضوع نهج الشهادة.

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

خيارات updateIssuer(string, UpdateIssuerOptions).

خصائص مكون X509 للشهادة.

تعريف قيم ActionType.

صفيف بخاصية واحدة كحد أدنى.

خيارات backupCertificate(string, OperationOptions).

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

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

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

معلومات جهة الاتصال لشهادات المخزن. سيكون لكل جهة اتصال واحدة على الأقل من خصائص CertificateContactAll، وهي: emailAddress أو الاسم أو الهاتف.

تعريف قيم contentType. تتضمن القيم المحتملة: "application/x-pem-file" و"application/x-pkcs12"

تعريف قيم JsonWebKeyCurveName.
يمكن استخدام <xref:KnownJsonWebKeyCurveName> بالتبادل مع JsonWebKeyCurveName، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

P-256
P-384
P-521
P-256K

تعريف قيم JsonWebKeyType.
يمكن استخدام <xref:KnownJsonWebKeyType> بالتبادل مع JsonWebKeyType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

EC
EC-HSM
RSA
RSA-HSM
أكتوبر
oct-HSM

نوع يمثل نهج الشهادة مع خاصية واحدة على الأقل من خصائص الموضوع.

الإجراء الذي سيتم تنفيذه.

واجهة تمثل شكل علامات الشهادة. العلامات هي مجرد أزواج من قيمة مفتاح السلسلة.

التمثيل العام لحالة عملية CreateCertificatePoller.

خيارات deleteCertificateOperation(string, OperationOptions).

التمثيل العام لحالة عملية DeleteCertificatePoller.

خيارات deleteContacts(OperationOptions).

خيارات deleteIssuer(string, OperationOptions).

تعريف قيم DeleteionRecoveryLevel.
يمكن استخدام <xref: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. يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ويعكس أيضا حقيقة أنه لا يمكن إلغاء الاشتراك نفسه.

خيارات getCertificateOperation(string, CertificatePollerOptions).

خيارات getCertificate(string, OperationOptions).

خيارات getCertificatePolicy(string, OperationOptions).

خيارات getCertificateVersion(string, string, OperationOptions).

خيارات getContacts(OperationOptions).

خيارات getDeletedCertificate(string, OperationOptions).

خيارات getIssuer(string, OperationOptions).

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

نوع يمثل نهج الشهادة للاستيراد الذي لا يتطلب SAN أو موضوعا

نسخة KeyVault المهملة من Core-lro's PollerLike.

تعريف قيم KeyUsageType.
يمكن استخدام <xref:KnownKeyUsageType> بالتبادل مع KeyUsageType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

digitalSignature
عدم الإنصات
keyEncipherment
تشفير البيانات
keyAgreement
مفتاح CertSign
cRLSign

فك تشفير فقط

واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfCertificateVersions(string, OperationOptions).

واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfIssuers(OperationOptions).

واجهة تمثل معلمات اختيارية mergeCertificate(string, Uint8Array[], OperationOptions).

خيارات purgeDeletedCertificate(string, OperationOptions).

مهمل: التمثيل العام لاسترداد عملية استقصاء شهادة محذوفة

يساعد RequireAtLeastOne على إنشاء نوع حيث يلزم وجود خاصية واحدة على الأقل من خصائص الواجهة (يمكن أن تكون أي خاصية).

يعمل هذا بسبب أنواع الأدوات المساعدة ل TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html دعونا نفحصه:

• [K in keyof T]-? هذه الخاصية (K) صالحة فقط إذا كان لها نفس اسم أي خاصية من خصائص T.
• يقوم Required<Pick<T, K>> بإنشاء نوع جديد من T مع الخاصية الحالية فقط في التكرار، ووضع علامة عليه على أنه مطلوب
• Partial<Pick<T, Exclude<keyof T, K>>> يجعل نوع جديد مع كافة خصائص T، باستثناء من الخاصية K.
• & هو ما يوحد النوع بخاصية واحدة مطلوبة فقط من Required<...> مع جميع الخصائص الاختيارية من Partial<...>.
• يضمن [keyof T] السماح بخصائص T فقط.

واجهة تمثل معلمات اختيارية restoreCertificateBackup(Uint8Array, OperationOptions).

خيارات setContacts(CertificateContact[], OperationOptions).

بدائل لخاصية الموضوع. إذا كان موجودا، يجب أن يكون له على الأقل إحدى خصائص SubjectAlternativeNamesAll.

خيارات updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

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

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

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

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

المصدرون المعروفون لاختيار افتراضي

تحليل معرف شهادة Key Vault المحدد. مثال على ذلك:

https://.vault.azure.net/certificates//

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

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