ClientCertificateCredential class

الحزمة:

@azure/identity

يتيح المصادقة إلى Microsoft Entra ID باستخدام شهادة مشفرة ب PEM ويتم تعيينها لتسجيل التطبيق. يمكن العثور على مزيد من المعلومات حول كيفية تكوين مصادقة الشهادة هنا:

https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

المنشئون

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	ينشئ نسخة من ClientCertificateCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع الشهادة.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	ينشئ نسخة من ClientCertificateCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع الشهادة.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	ينشئ نسخة من ClientCertificateCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع الشهادة.

الأساليب

getToken(string | string[], GetTokenOptions)

يتم التحقق من المصادقة باستخدام معرف Microsoft Entra ID ويعيد رمز الوصول إذا نجحت. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل.

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

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

ينشئ نسخة من ClientCertificateCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع الشهادة.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)

المعلمات

tenantId

string

معرف مستأجر (المجلد) في Microsoft Entra.

clientId

string

معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

configuration

ClientCertificatePEMCertificate

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

options

ClientCertificateCredentialOptions

خيارات لتكوين العميل الذي يقوم بطلب المصادقة.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

ينشئ نسخة من ClientCertificateCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع الشهادة.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

المعلمات

tenantId

string

معرف مستأجر (المجلد) في Microsoft Entra.

clientId

string

معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

configuration

ClientCertificatePEMCertificatePath

المعلمات الأخرى المطلوبة، بما في ذلك مسار الشهادة على نظام الملفات. إذا تم تجاهل النوع، فسنطرح قيمة المسار إلى شهادة PEM.

options

ClientCertificateCredentialOptions

خيارات لتكوين العميل الذي يقوم بطلب المصادقة.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

ينشئ نسخة من ClientCertificateCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع الشهادة.

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

المعلمات

tenantId

string

معرف مستأجر (المجلد) في Microsoft Entra.

clientId

string

معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

certificatePath

string

المسار إلى شهادة مفتاح عام/خاص مرمزة من PEM على نظام الملفات. تأكد من أن الشهادة بتنسيق PEM وتحتوي على كل من المفاتيح العامة والخاصة.

options

ClientCertificateCredentialOptions

خيارات لتكوين العميل الذي يقوم بطلب المصادقة.

تفاصيل الأسلوب

getToken(string | string[], GetTokenOptions)

يتم التحقق من المصادقة باستخدام معرف Microsoft Entra ID ويعيد رمز الوصول إذا نجحت. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

المعلمات

scopes

string | string[]

قائمة النطاقات التي سيكون للرمز المميز حق الوصول إليها.

options

GetTokenOptions

الخيارات المستخدمة لتكوين أي طلبات قد يقدمها تطبيق TokenCredential هذا.

المرتجعات

Promise<AccessToken>