AuthenticationOptions interface

الحزمة:

azure-maps-control

خيارات لتحديد كيفية مصادقة عنصر تحكم الخريطة مع خدمات خرائط Azure.

Extends

Options

الخصائص

aadAppId	معرف التطبيق المسجل Azure AD. هذا هو معرف التطبيق لتطبيق مسجل في مستأجر Azure AD. يجب تحديد نوع مصادقة AAD.
aadInstance	مثيل AAD لاستخدامه لتسجيل الدخول. يمكن تحديد اختياريا عند استخدام نوع مصادقة AAD. بشكل افتراضي، سيتم استخدام المثيل https://login.microsoftonline.com/ .
aadTenant	مستأجر AAD الذي يمتلك التطبيق المسجل المحدد بواسطة aadAppId. يجب تحديد نوع مصادقة AAD.
authContext	توفير موجود PublicClientApplication من مكتبة MSAL.js اختياريا. سيتم استخدام سياق المصادقة هذا للحصول على رمز AAD المميز. يستخدم فقط مع نوع مصادقة AAD. يجب تكوين سياق المصادقة هذا لاستخدام نفس معرف تطبيق AAD مثل this.aadAppId. إذا لم يتم توفير ذلك، فستشارك جميع مثيلات الخريطة سياق المصادقة الخاص بها.
authType	آلية المصادقة التي سيتم استخدامها.
clientId	معرف عميل خرائط Azure، هذا معرف فريد يستخدم لتعريف حساب الخرائط. يفضل تحديده دائما، ولكن يجب تحديده لنوعي المصادقة AAD (دليل Azure النشط) وأنواع المصادقة المجهولة.
getToken	رد اتصال لاستخدامه مع آلية مصادقة مجهول/sas. سيكون رد الاتصال هذا مسؤولا عن الحل إلى رمز المصادقة المميز. على سبيل المثال، إحضار رمز مميز محمي من CORS من نقطة نهاية.
sasToken	توفير رمز مميز أولي لمصادقة sas اختياريا.
subscriptionKey	مفتاح الاشتراك من حساب خرائط Azure الخاص بك. يجب تحديد نوع مصادقة مفتاح الاشتراك.

الأساليب

setAadProperties(string, string, string, string, PublicClientApplication)	تعيين خيارات المصادقة المطلوبة لتكوين آلية المنح الضمنية AAD.
setSasCallbackFunction(getAuthTokenCallback)	تعيين الخيارات المطلوبة لتكوين أسلوب مصادقة sas.
setSubscriptionKey(string)	تعيين الخيارات المطلوبة لتكوين آلية مصادقة مفتاح الاشتراك.
setTokenCallbackFunction(getAuthTokenCallback)	تعيين الخيارات المطلوبة لتكوين أسلوب المصادقة المجهول.

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

aadAppId

معرف التطبيق المسجل Azure AD. هذا هو معرف التطبيق لتطبيق مسجل في مستأجر Azure AD. يجب تحديد نوع مصادقة AAD.

aadAppId?: string

قيمة الخاصية

string

aadInstance

مثيل AAD لاستخدامه لتسجيل الدخول. يمكن تحديد اختياريا عند استخدام نوع مصادقة AAD. بشكل افتراضي، سيتم استخدام المثيل https://login.microsoftonline.com/ .

aadInstance?: string

قيمة الخاصية

string

aadTenant

مستأجر AAD الذي يمتلك التطبيق المسجل المحدد بواسطة aadAppId. يجب تحديد نوع مصادقة AAD.

aadTenant?: string

قيمة الخاصية

string

authContext

توفير موجود PublicClientApplication من مكتبة MSAL.js اختياريا. سيتم استخدام سياق المصادقة هذا للحصول على رمز AAD المميز. يستخدم فقط مع نوع مصادقة AAD. يجب تكوين سياق المصادقة هذا لاستخدام نفس معرف تطبيق AAD مثل this.aadAppId. إذا لم يتم توفير ذلك، فستشارك جميع مثيلات الخريطة سياق المصادقة الخاص بها.

authContext?: PublicClientApplication

قيمة الخاصية

PublicClientApplication

authType

آلية المصادقة التي سيتم استخدامها.

authType?: AuthenticationType

قيمة الخاصية

AuthenticationType

clientId

معرف عميل خرائط Azure، هذا معرف فريد يستخدم لتعريف حساب الخرائط. يفضل تحديده دائما، ولكن يجب تحديده لنوعي المصادقة AAD (دليل Azure النشط) وأنواع المصادقة المجهولة.

clientId?: string

قيمة الخاصية

string

getToken

رد اتصال لاستخدامه مع آلية مصادقة مجهول/sas. سيكون رد الاتصال هذا مسؤولا عن الحل إلى رمز المصادقة المميز. على سبيل المثال، إحضار رمز مميز محمي من CORS من نقطة نهاية.

getToken?: getAuthTokenCallback

قيمة الخاصية

getAuthTokenCallback

sasToken

توفير رمز مميز أولي لمصادقة sas اختياريا.

sasToken?: string

قيمة الخاصية

string

subscriptionKey

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

subscriptionKey?: string

قيمة الخاصية

string

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

setAadProperties(string, string, string, string, PublicClientApplication)

تعيين خيارات المصادقة المطلوبة لتكوين آلية المنح الضمنية AAD.

function setAadProperties(clientId: string, aadAppId: string, aadTenant: string, aadInstance?: string, authContext?: PublicClientApplication)

المعلمات

clientId

string

معرف العميل من حساب خرائط Azure

aadAppId

string

معرف تطبيق Azure AD

aadTenant

string

اسم المستأجر Azure AD

aadInstance

string

مثيل Azure AD اختياري

authContext

PublicClientApplication

اختياري PublicClientApplication من مكتبة MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

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

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

المعلمات

getTokenCallback

getAuthTokenCallback

دالة رد الاتصال المسؤولة عن الحل إلى رمز المصادقة المميز.

setSubscriptionKey(string)

تعيين الخيارات المطلوبة لتكوين آلية مصادقة مفتاح الاشتراك.

function setSubscriptionKey(key: string)

المعلمات

key

string

setTokenCallbackFunction(getAuthTokenCallback)

تعيين الخيارات المطلوبة لتكوين أسلوب المصادقة المجهول.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

المعلمات

getTokenCallback

getAuthTokenCallback

دالة رد الاتصال المسؤولة عن الحل إلى رمز المصادقة المميز.