مشاركة عبر

EnvironmentCredential class

الحزمة:
@azure/identity

تمكين المصادقة على معرف Microsoft Entra باستخدام سر العميل أو الشهادة.

المنشئون

EnvironmentCredential(EnvironmentCredentialOptions)

ينشئ مثيلا لفئة EnvironmentCredential ويقرر بيانات الاعتماد التي يجب استخدامها اعتمادا على متغيرات البيئة المتوفرة.

متغيرات البيئة المطلوبة:

  • AZURE_TENANT_ID: معرف مستأجر Microsoft Entra (الدليل).
  • AZURE_CLIENT_ID: معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

إذا قمت بتعيين AZURE_TENANT_ID، يمكنك أيضا تعيين المستأجرين المسموح بهم بالإضافة إلى ذلك

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد الخاصة بهم على رموز مميزة بسلسلة محددة بفاصلة منقوطة واحدة. استخدم * للسماح لجميع المستأجرين.

متغيرات البيئة المستخدمة لمصادقة بيانات اعتماد العميل:

  • AZURE_CLIENT_SECRET: سر عميل تم إنشاؤه لتسجيل التطبيق.
  • AZURE_CLIENT_CERTIFICATE_PATH: المسار إلى شهادة PEM لاستخدامها أثناء المصادقة، بدلا من سر العميل.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (اختياري) كلمة المرور لملف الشهادة.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (اختياري) يشير إلى أنه يجب تعيين سلسلة الشهادات في رأس x5c لدعم اسم الموضوع / المصادقة المستندة إلى المصدر.

تم إهمال مصادقة اسم المستخدم وكلمة المرور، نظرا لأنها لا تدعم المصادقة متعددة العوامل (MFA). راجع https://aka.ms/azsdk/identity/mfa لمزيد من التفاصيل. لا يزال بإمكان المستخدمين توفير متغيرات البيئة لأسلوب المصادقة هذا:

  • AZURE_USERNAME: اسم المستخدم للمصادقة معه.
  • AZURE_PASSWORD: كلمة المرور للمصادقة معها.

إذا كانت متغيرات البيئة المطلوبة لتنفيذ المصادقة مفقودة، طرح CredentialUnavailableError. إذا فشلت المصادقة، أو إذا كان هناك خطأ غير معروف، طرح AuthenticationError.

الأساليب

getToken(string | string[], GetTokenOptions)

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

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

EnvironmentCredential(EnvironmentCredentialOptions)

ينشئ مثيلا لفئة EnvironmentCredential ويقرر بيانات الاعتماد التي يجب استخدامها اعتمادا على متغيرات البيئة المتوفرة.

متغيرات البيئة المطلوبة:

  • AZURE_TENANT_ID: معرف مستأجر Microsoft Entra (الدليل).
  • AZURE_CLIENT_ID: معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

إذا قمت بتعيين AZURE_TENANT_ID، يمكنك أيضا تعيين المستأجرين المسموح بهم بالإضافة إلى ذلك

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد الخاصة بهم على رموز مميزة بسلسلة محددة بفاصلة منقوطة واحدة. استخدم * للسماح لجميع المستأجرين.

متغيرات البيئة المستخدمة لمصادقة بيانات اعتماد العميل:

  • AZURE_CLIENT_SECRET: سر عميل تم إنشاؤه لتسجيل التطبيق.
  • AZURE_CLIENT_CERTIFICATE_PATH: المسار إلى شهادة PEM لاستخدامها أثناء المصادقة، بدلا من سر العميل.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (اختياري) كلمة المرور لملف الشهادة.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (اختياري) يشير إلى أنه يجب تعيين سلسلة الشهادات في رأس x5c لدعم اسم الموضوع / المصادقة المستندة إلى المصدر.

تم إهمال مصادقة اسم المستخدم وكلمة المرور، نظرا لأنها لا تدعم المصادقة متعددة العوامل (MFA). راجع https://aka.ms/azsdk/identity/mfa لمزيد من التفاصيل. لا يزال بإمكان المستخدمين توفير متغيرات البيئة لأسلوب المصادقة هذا:

  • AZURE_USERNAME: اسم المستخدم للمصادقة معه.
  • AZURE_PASSWORD: كلمة المرور للمصادقة معها.

إذا كانت متغيرات البيئة المطلوبة لتنفيذ المصادقة مفقودة، طرح CredentialUnavailableError. إذا فشلت المصادقة، أو إذا كان هناك خطأ غير معروف، طرح AuthenticationError.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

المعلمات

options
EnvironmentCredentialOptions

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

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

getToken(string | string[], GetTokenOptions)

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

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

المعلمات

scopes

string | string[]

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

options
GetTokenOptions

المعلمات الاختيارية. راجعGetTokenOptions .

المرتجعات

Promise<AccessToken>