@azure/keyvault-certificates package

الفصول

CertificateClient

العميل للتفاعل مع وظيفة شهادات 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.
KeyVaultCertificateWithPolicy	واجهة تمثل شهادة مع نهجها
LifetimeAction	الإجراء وتشغيله الذي ستنفذه Key Vault طوال عمر الشهادة.
ListDeletedCertificatesOptions	واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions	واجهة تمثل معلمات اختيارية لعمليات CertificateClient المصفحة التي تم تمريرها إلى listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties	واجهة تمثل خصائص الموضوع المحتملة لنهج الشهادة. يتطلب النوع الأخير وجود خاصية واحدة على الأقل من هذه الخصائص.
PollerLike	تمثيل تجريدي للمطلع، يهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.
PollerLikeWithCancellation	تمثيل تجريدي للمطلع، يهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.
SubjectAlternativeNamesAll	واجهة تمثل الأسماء البديلة لموضوع نهج الشهادة.
UpdateCertificateOptions	خيارات <xref:updateCertificate>.
UpdateIssuerOptions	خيارات updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	خصائص مكون X509 للشهادة.

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

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: منحنى القطع الناقص NIST P-256، منحنى AKA SECG SECP256R1. P-384: منحنى القطع الناقص NIST P-384، منحنى AKA SECG SECP384R1. P-521: منحنى القطع الناقص NIST P-521، منحنى AKA SECG SECP521R1. P-256K: المنحنى الناقص SECP256K1 SECG.
CertificateKeyType	نوع المفتاح المزدوج الذي سيتم استخدامه للشهادة. يمكن استخدام <xref:KnownJsonWebKeyType> بالتبادل مع JsonWebKeyType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة EC: منحنى القطع الناقص. EC-HSM: منحنى القطع الناقص مع مفتاح خاص غير قابل للتصدير من HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447). RSA-HSM: RSA مع مفتاح خاص غير قابل للتصدير من HSM. oct: تسلسل ثماني (يستخدم لتمثيل المفاتيح المتماثلة). oct-HSM: تسلسل Octet مع مفتاح خاص غير قابل للتصدير من HSM.
CertificatePolicy	نوع يمثل نهج الشهادة مع خاصية واحدة على الأقل من خصائص الموضوع.
CertificatePolicyAction	الإجراء الذي سيتم تنفيذه.
CertificateTags	واجهة تمثل شكل علامات الشهادة. العلامات هي مجرد أزواج من قيمة مفتاح السلسلة.
CreateCertificateState	التمثيل العام لحالة عملية CreateCertificatePoller.
DeleteCertificateOperationOptions	خيارات deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	التمثيل العام لحالة عملية DeleteCertificatePoller.
DeleteContactsOptions	خيارات deleteContacts(OperationOptions).
DeleteIssuerOptions	خيارات deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	يعكس مستوى استرداد الحذف الساري حاليا للبيانات السرية في المخزن الحالي. إذا كان يحتوي على "قابل للإزالة"، يمكن حذف السر نهائيا من قبل مستخدم متميز؛ وإلا، يمكن للنظام فقط إزالة البيانات السرية، في نهاية الفاصل الزمني للاحتفاظ. يمكن استخدام <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. يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ويعكس أيضا حقيقة أنه لا يمكن إلغاء الاشتراك نفسه.
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 المهملة من Core-lro's PollerLike.
KeyUsageType	استخدامات مدعومة لمفتاح الشهادة. يمكن استخدام <xref:KnownKeyUsageType> بالتبادل مع KeyUsageType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة digitalSignature: يشير إلى أنه يمكن استخدام مفتاح الشهادة كتوقيع رقمي. nonRepudiation: يشير إلى أنه يمكن استخدام مفتاح الشهادة للمصادقة. keyEncipherment: يشير إلى أنه يمكن استخدام مفتاح الشهادة لتشفير المفتاح. dataEncipherment: يشير إلى أنه يمكن استخدام مفتاح الشهادة لتشفير البيانات. keyAgreement: يشير إلى أنه يمكن استخدام مفتاح الشهادة لتحديد اتفاقية المفاتيح، مثل مفتاح تم إنشاؤه باستخدام خوارزمية اتفاقية المفاتيح Diffie-Hellman. keyCertSign: يشير إلى أنه يمكن استخدام مفتاح الشهادة لتوقيع الشهادات. cRLSign: يشير إلى أنه يمكن استخدام مفتاح الشهادة لتوقيع قائمة إبطال الشهادة. encipherOnly: يشير إلى أنه يمكن استخدام مفتاح الشهادة للتشفير فقط. فك التشفيرOnly: يشير إلى أنه يمكن استخدام مفتاح الشهادة لفك التشفير فقط.
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	يعكس مستوى استرداد الحذف الساري حاليا للبيانات السرية في المخزن الحالي. إذا كان يحتوي على "قابل للإزالة"، يمكن حذف السر نهائيا من قبل مستخدم متميز؛ وإلا، يمكن للنظام فقط إزالة البيانات السرية، في نهاية الفاصل الزمني للاحتفاظ.
KnownKeyUsageTypes	القيم المعروفة KeyUsageType التي تقبلها الخدمة.
WellKnownIssuer	المصدرون المعروفون لاختيار افتراضي

الوظائف

parseKeyVaultCertificateIdentifier(string)

يحلل معرف شهادة Key Vault المعطا. مثال على ذلك: https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id> عند تحليل المعرف أعلاه، ترجع هذه الدالة: { 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>" }

المتغيرات

DefaultCertificatePolicy	تقوم سياسة DefaultCertificatePolicy بتصدير القيم التي تكون مفيدة كمعلمات افتراضية إلى طرق تعدل سياسة الشهادة.
logger

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

parseKeyVaultCertificateIdentifier(string)

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

https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id>

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

  {
     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

تفاصيل المُتغيّر

DefaultCertificatePolicy

تقوم سياسة DefaultCertificatePolicy بتصدير القيم التي تكون مفيدة كمعلمات افتراضية إلى طرق تعدل سياسة الشهادة.

DefaultCertificatePolicy: { issuerName: string, subject: string }

النوع

{ issuerName: string, subject: string }

logger

logger: AzureLogger

النوع

AzureLogger