مشاركة عبر

EnvironmentCredential class

  • ‏‏المرجع
الحزمة:
@azure/identity

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

المنشئون

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_USERNAME: اسم المستخدم للمصادقة معه.
  • AZURE_PASSWORD: كلمة المرور للمصادقة باستخدام.

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

الأساليب

getToken(string | string[], GetTokenOptions)

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

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

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_USERNAME: اسم المستخدم للمصادقة معه.
  • AZURE_PASSWORD: كلمة المرور للمصادقة باستخدام.

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

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

المعلمات

options
EnvironmentCredentialOptions

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

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

getToken(string | string[], GetTokenOptions)

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

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

المعلمات

scopes

string | string[]

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

options
GetTokenOptions

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

المرتجعات

Promise<AccessToken>