InteractiveBrowserCredentialInBrowserOptions interface

الحزمة:

@azure/identity

يحدد الخيارات الشائعة لفئة InteractiveBrowserCredential.

Extends

InteractiveCredentialOptions

الخصائص

clientId	معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر. هذه المعلمة مطلوبة على المستعرض.
loginHint	يسمح loginHint بتحديد اسم المستخدم مسبقا لتسجيلات الدخول التفاعلية. يؤدي تعيين هذا الخيار إلى تخطي مطالبة تحديد الحساب ومحاولة تسجيل الدخول على الفور باستخدام الحساب المحدد.
loginStyle	يحدد ما إذا كان يجب استخدام إعادة توجيه أو نافذة منبثقة لبدء تدفق مصادقة المستخدم. القيم المحتملة هي "إعادة توجيه" أو "منبثقة" (افتراضي) للمستعرض و"منبثقة" (افتراضي) للعقدة.
redirectUri	يحصل على عنوان URI لإعادة التوجيه للتطبيق. يجب أن يكون هذا هو نفس القيمة في مدخل تسجيل التطبيق. الإعدادات الافتراضية لـ window.location.href. لم يعد هذا الحقل مطلوبا Node.js.
tenantId	معرف المستأجر (الدليل) Microsoft Entra.

الخصائص الموروثة

additionallyAllowedTenants	بالنسبة للتطبيقات متعددة المستأجرين، يحدد المستأجرين الإضافيين الذين قد تحصل بيانات الاعتماد على رموز مميزة لها. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر تم تثبيت التطبيق عليه.
additionalPolicies	نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
allowInsecureConnection	تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
authenticationRecord	نتيجة مصادقة سابقة يمكن استخدامها لاسترداد بيانات الاعتماد المخزنة مؤقتا لكل حساب فردي. هذا ضروري لتوفير في حالة أراد التطبيق العمل مع أكثر من حساب واحد لكل زوج معرف العميل ومعرف المستأجر. يمكن استرداد هذا السجل عن طريق استدعاء أسلوب بيانات الاعتماد authenticate() ، كما يلي: const authenticationRecord = await credential.authenticate();
authorityHost	مضيف المرجع لاستخدامه لطلبات المصادقة. تتوفر القيم المحتملة من خلال AzureAuthorityHosts. الافتراضي هو "https://login.microsoftonline.com".
disableAutomaticAuthentication	يجعل getToken يطرح إذا كانت المصادقة اليدوية ضرورية. سيحتاج المطورون إلى الاتصال بالتحكم authenticate() في وقت المصادقة يدويا.
disableInstanceDiscovery	يحدد الحقل ما إذا كان يتم تنفيذ اكتشاف المثيل عند محاولة المصادقة. سيؤدي تعيين هذا إلى إلى true تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة.
httpClient	HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
loggingOptions	يسمح للمستخدمين بتكوين إعدادات خيارات نهج التسجيل، والسماح بمعلومات حساب التسجيل ومعلومات التعريف الشخصية لدعم العملاء.
proxyOptions	خيارات لتكوين وكيل للطلبات الصادرة.
redirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
retryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
telemetryOptions	خيارات لتعيين معلومات القياس عن بعد والتتبع الشائعة للطلبات الصادرة.
tlsOptions	خيارات لتكوين مصادقة TLS
userAgentOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

تفاصيل الخاصية

clientId

معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر. هذه المعلمة مطلوبة على المستعرض.

clientId: string

قيمة الخاصية

string

loginHint

يسمح loginHint بتحديد اسم المستخدم مسبقا لتسجيلات الدخول التفاعلية. يؤدي تعيين هذا الخيار إلى تخطي مطالبة تحديد الحساب ومحاولة تسجيل الدخول على الفور باستخدام الحساب المحدد.

loginHint?: string

قيمة الخاصية

string

loginStyle

يحدد ما إذا كان يجب استخدام إعادة توجيه أو نافذة منبثقة لبدء تدفق مصادقة المستخدم. القيم المحتملة هي "إعادة توجيه" أو "منبثقة" (افتراضي) للمستعرض و"منبثقة" (افتراضي) للعقدة.

loginStyle?: BrowserLoginStyle

قيمة الخاصية

BrowserLoginStyle

redirectUri

يحصل على عنوان URI لإعادة التوجيه للتطبيق. يجب أن يكون هذا هو نفس القيمة في مدخل تسجيل التطبيق. الإعدادات الافتراضية لـ window.location.href. لم يعد هذا الحقل مطلوبا Node.js.

redirectUri?: string | () => string

قيمة الخاصية

string | () => string

tenantId

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

tenantId?: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

قيمة الخاصية

string[]

موروث منInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروث منInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث منInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

نتيجة مصادقة سابقة يمكن استخدامها لاسترداد بيانات الاعتماد المخزنة مؤقتا لكل حساب فردي. هذا ضروري لتوفير في حالة أراد التطبيق العمل مع أكثر من حساب واحد لكل زوج معرف العميل ومعرف المستأجر.

يمكن استرداد هذا السجل عن طريق استدعاء أسلوب بيانات الاعتماد authenticate() ، كما يلي:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

قيمة الخاصية

AuthenticationRecord

موروث منInteractiveCredentialOptions.authenticationRecord

authorityHost

مضيف المرجع لاستخدامه لطلبات المصادقة. تتوفر القيم المحتملة من خلال AzureAuthorityHosts. الافتراضي هو "https://login.microsoftonline.com".

authorityHost?: string

قيمة الخاصية

string

موروث منInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

يجعل getToken يطرح إذا كانت المصادقة اليدوية ضرورية. سيحتاج المطورون إلى الاتصال بالتحكم authenticate() في وقت المصادقة يدويا.

disableAutomaticAuthentication?: boolean

قيمة الخاصية

boolean

موروث منInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

يحدد الحقل ما إذا كان يتم تنفيذ اكتشاف المثيل عند محاولة المصادقة. سيؤدي تعيين هذا إلى إلى true تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة.

disableInstanceDiscovery?: boolean

قيمة الخاصية

boolean

موروث منInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.

httpClient?: HttpClient

قيمة الخاصية

HttpClient

موروث منInteractiveCredentialOptions.httpClient

loggingOptions

يسمح للمستخدمين بتكوين إعدادات خيارات نهج التسجيل، والسماح بمعلومات حساب التسجيل ومعلومات التعريف الشخصية لدعم العملاء.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

قيمة الخاصية

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

موروث منInteractiveCredentialOptions.loggingOptions

proxyOptions

خيارات لتكوين وكيل للطلبات الصادرة.

proxyOptions?: ProxySettings

قيمة الخاصية

ProxySettings

موروث منInteractiveCredentialOptions.proxyOptions

redirectOptions

خيارات لكيفية معالجة استجابات إعادة التوجيه.

redirectOptions?: RedirectPolicyOptions

قيمة الخاصية

RedirectPolicyOptions

موروث منInteractiveCredentialOptions.redirectOptions

retryOptions

الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.

retryOptions?: PipelineRetryOptions

قيمة الخاصية

PipelineRetryOptions

موروث منInteractiveCredentialOptions.retryOptions

telemetryOptions

خيارات لتعيين معلومات القياس عن بعد والتتبع الشائعة للطلبات الصادرة.

telemetryOptions?: TelemetryOptions

قيمة الخاصية

TelemetryOptions

موروث منInteractiveCredentialOptions.telemetryOptions

tlsOptions

خيارات لتكوين مصادقة TLS

tlsOptions?: TlsSettings

قيمة الخاصية

TlsSettings

موروث منInteractiveCredentialOptions.tlsOptions

userAgentOptions

خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

userAgentOptions?: UserAgentPolicyOptions

قيمة الخاصية

UserAgentPolicyOptions

موروث منInteractiveCredentialOptions.userAgentOptions