@azure/keyvault-certificates package

‏‏المرجع

الفصول

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

الواجهات

AdministratorContact	تفاصيل مسؤول المؤسسة لمصدر الشهادة.
BackupCertificateResult	نتيجة شهادة النسخ الاحتياطي، التي تحتوي على كائن ثنائي كبير الحجم للنسخ الاحتياطي.
BeginCreateCertificateOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	المعلمات الاختيارية المقبولة من قبل CertificateClient الخاص ب KeyVault
CertificateContactAll	شكل معلومات جهة الاتصال لشهادات المخزن.
CertificateIssuer	واجهة تمثل خصائص المصدر.
CertificateOperation	يتم إرجاع عملية شهادة في حالة الطلبات غير المتزامنة.
CertificateOperationError	خطأ خادم مخزن المفاتيح.
CertificateOperationState	واجهة تمثل الخصائص المتاحة للجمهور لحالة CertificateOperationPoller.
CertificatePolicyProperties	واجهة تمثل نهج الشهادة (بدون خصائص الموضوع).
CertificatePollerOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)و beginDeleteCertificate(string, CertificatePollerOptions)beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	واجهة تمثل خصائص الشهادة
CoreSubjectAlternativeNames	الأسماء البديلة للموضوع لكائن X509.
CreateCertificateOptions	خيارات ل <xref:createCertificate>.
CreateIssuerOptions	خيارات ل createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	واجهة تمثل شهادة محذوفة.
ErrorModel	نموذج خطأ خادم مخزن المفاتيح.
ImportCertificateOptions	خيارات ل importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes	سمات المصدر التي تديرها خدمة Key Vault.
IssuerCredentials	بيانات الاعتماد التي سيتم استخدامها لمصدر الشهادة.
IssuerParameters	معلمات المصدر لمكون X509 للشهادة.
IssuerProperties	واجهة تمثل خصائص مصدر الشهادة
KeyVaultCertificate	واجهة تمثل شهادة بدون نهج الشهادة
KeyVaultCertificateIdentifier	يمثل المقاطع التي تشكل معرف شهادة Key Vault.
KeyVaultCertificatePollOperationState	واجهة تمثل الشكل العام لحالة عمليات Key Vault Certificate Poller.
KeyVaultCertificateWithPolicy	واجهة تمثل شهادة مع نهجها
LifetimeAction	الإجراء ومشغله الذي سيتم تنفيذه بواسطة Key Vault على مدى عمر الشهادة.
ListDeletedCertificatesOptions	واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions	واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties	واجهة تمثل خصائص الموضوع المحتملة لنهج الشهادة. يتطلب النوع الأخير وجود خاصية واحدة على الأقل من هذه الخصائص.
PollerLike	تمثيل مجرد لأداة الاستقصاء، يهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.
SubjectAlternativeNamesAll	واجهة تمثل الأسماء البديلة لموضوع نهج الشهادة.
UpdateCertificateOptions	خيارات ل <xref:updateCertificate>.
UpdateIssuerOptions	خيارات ل updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	خصائص مكون X509 للشهادة.

النوع أسماء مستعارة

ActionType	يحدد قيم ActionType.
ArrayOneOrMore	صفيف بخاصية واحدة كحد أدنى.
BackupCertificateOptions	خيارات ل backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	خيارات ل <xref:cancelCertificateOperation>.
CertificateContact	معلومات جهة الاتصال لشهادات المخزن. سيكون لكل جهة اتصال واحدة على الأقل من خصائص CertificateContactAll، وهي: emailAddress أو الاسم أو الهاتف.
CertificateContentType	يحدد قيم contentType. تتضمن القيم المحتملة: "application/x-pem-file" و"application/x-pkcs12"
CertificateKeyCurveName	يحدد قيم JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> يمكن استخدامها بالتبادل مع JsonWebKeyCurveName، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة P-256 P-384 P-521 P-256K
CertificateKeyType	يحدد قيم JsonWebKeyType. <xref:KnownJsonWebKeyType> يمكن استخدامها بالتبادل مع JsonWebKeyType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة EC EC-HSM RSA RSA-HSM اكتوبر oct-HSM
CertificatePolicy	نوع يمثل نهج الشهادة مع واحدة على الأقل من خصائص الموضوع.
CertificatePolicyAction	الإجراء الذي سيتم تنفيذه.
CertificateTags	واجهة تمثل شكل علامات الشهادة. العلامات هي مجرد أزواج من قيمة مفتاح السلسلة.
CreateCertificateState	التمثيل العام لحالة عملية CreateCertificatePoller.
DeleteCertificateOperationOptions	خيارات ل deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	التمثيل العام لحالة عملية DeleteCertificatePoller.
DeleteContactsOptions	خيارات ل deleteContacts(OperationOptions).
DeleteIssuerOptions	خيارات ل deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	يحدد قيم DeleteionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> يمكن استخدام بالتبادل مع DeletionRecoveryLevel، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة قابل للإزالة: يشير إلى حالة المخزن التي يكون فيها الحذف عملية لا رجعة فيها، دون إمكانية الاسترداد. يتوافق هذا المستوى مع عدم توفر أي حماية ضد عملية الحذف؛ يتم فقدان البيانات بشكل لا يمكن إصلاحه عند قبول عملية حذف على مستوى الكيان أو أعلى (المخزن ومجموعة الموارد والاشتراك وما إلى ذلك) Recoverable+Purgeable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد، والذي يسمح أيضا بالحذف الفوري ودائم (أي الإزالة). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء (90 يوما)، ما لم يتم طلب عملية إزالة، أو تم إلغاء الاشتراك. النظام يحذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده قابل للاسترداد: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد دون إمكانية الحذف الفوري والدائم (أي الإزالة). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء (90 يوما) وبينما لا يزال الاشتراك متوفرا. النظام يحذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده Recoverable+ProtectedSubscription: يشير إلى حالة المخزن والاشتراك التي يكون فيها الحذف قابلا للاسترداد خلال فترة الاستبقاء (90 يوما)، ولا يسمح بالحذف الفوري ودائم (أي الإزالة)، ولا يمكن فيه إلغاء الاشتراك نفسه نهائيا. النظام يحذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده CustomizedRecoverable+Purgeable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد، والذي يسمح أيضا بالحذف الفوري ودائم (أي الإزالة عند 7<= SoftDeleteRetentionInDays < 90). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء الفاصل الزمني للاستبقاء، ما لم يتم طلب عملية إزالة، أو إلغاء الاشتراك. CustomizedRecoverable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد دون إمكانية الحذف الفوري والدائم (أي الإزالة عند 7<= SoftDeleteRetentionInDays < 90). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء الفاصل الزمني للاستبقاء وبينما لا يزال الاشتراك متوفرا. CustomizedRecoverable+ProtectedSubscription: يشير إلى المخزن وحالة الاشتراك التي يكون فيها الحذف قابلا للاسترداد، والحذف الفوري ودائم (أي الإزالة) غير مسموح به، ولا يمكن فيه إلغاء الاشتراك نفسه نهائيا عند 7<= SoftDeleteRetentionInDays < 90. يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ويعكس أيضا حقيقة أنه لا يمكن إلغاء الاشتراك نفسه.
GetCertificateOperationOptions	خيارات ل getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	خيارات ل getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	خيارات ل getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	خيارات ل getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	خيارات ل getContacts(OperationOptions).
GetDeletedCertificateOptions	خيارات ل getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	خيارات ل getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	خيارات ل <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	نوع يمثل نهج الشهادة للاستيراد الذي لا يتطلب SAN أو موضوعا
KVPollerLike	نسخة KeyVault المهملة من PollerLike ل core-lro.
KeyUsageType	يحدد قيم KeyUsageType. <xref:KnownKeyUsageType> يمكن استخدام بالتبادل مع KeyUsageType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة توقيع رقمي عدم الإنكار تشفير المفتاح تشفير البيانات keyAgreement keyCertSign cRLSign تشفير فقط فك التشفير فقط
ListPropertiesOfCertificateVersionsOptions	واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions	واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions	واجهة تمثل معلمات اختيارية ل mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions	خيارات ل purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	مهمل: التمثيل العام لاسترداد عملية استقصاء شهادة محذوفة
RequireAtLeastOne	يساعد 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 فقط.
RestoreCertificateBackupOptions	واجهة تمثل معلمات اختيارية ل restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions	خيارات ل setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	بدائل لخاصية الموضوع. إذا كان موجودا، يجب أن يكون له على الأقل إحدى خصائص SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions	خيارات ل updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

التعدادات

KnownCertificateKeyCurveNames	القيم المعروفة ل CertificateKeyCurveName التي تقبلها الخدمة.
KnownCertificateKeyTypes	القيم المعروفة ل CertificateKeyType التي تقبلها الخدمة.
KnownDeletionRecoveryLevels	القيم المعروفة ل DeleteionRecoveryLevel التي تقبلها الخدمة.
KnownKeyUsageTypes	القيم المعروفة ل KeyUsageType التي تقبلها الخدمة.
WellKnownIssuer	المصدرون المعروفون لاختيار افتراضي

الوظائف

parseKeyVaultCertificateIdentifier(string)

تحليل معرف شهادة 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>"
  }

تفاصيل الوظيفة

parseKeyVaultCertificateIdentifier(string)

تحليل معرف شهادة 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>"
  }

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

المعلمات

id: string

معرف شهادة Key Vault.

المرتجعات

KeyVaultCertificateIdentifier

مشاركة عبر

@azure/keyvault-certificates package

الفصول

الواجهات

النوع أسماء مستعارة

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

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

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

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

التعدادات

الوظائف

تفاصيل الوظيفة

parseKeyVaultCertificateIdentifier(string)

المعلمات

المرتجعات

الموارد الإضافية