Поделиться через

AuthenticationOptions interface

  • Ссылка
Пакет:
azure-maps-control

Параметры для указания способа проверки подлинности элемента управления картой в службах Azure Maps.

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 Maps клиента. Это уникальный идентификатор, используемый для идентификации учетной записи карты. Рекомендуется всегда указывать, но необходимо указывать для типов AAD и анонимной проверки подлинности.
getToken

Обратный вызов для использования с механизмом анонимной проверки подлинности или проверки подлинности SAS. Этот обратный вызов будет отвечать за разрешение маркера проверки подлинности. Например, получение защищенного маркера CORS из конечной точки.
sasToken

При необходимости укажите начальный маркер для проверки подлинности SAS.
subscriptionKey

Ключ подписки из учетной записи Azure Maps. Необходимо указать для типа проверки подлинности с помощью ключа подписки.

Методы

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 Maps клиента. Это уникальный идентификатор, используемый для идентификации учетной записи карты. Рекомендуется всегда указывать, но необходимо указывать для типов AAD и анонимной проверки подлинности.

clientId?: string

Значение свойства

string

getToken

Обратный вызов для использования с механизмом анонимной проверки подлинности или проверки подлинности SAS. Этот обратный вызов будет отвечать за разрешение маркера проверки подлинности. Например, получение защищенного маркера CORS из конечной точки.

getToken?: getAuthTokenCallback

Значение свойства

getAuthTokenCallback

sasToken

При необходимости укажите начальный маркер для проверки подлинности SAS.

sasToken?: string

Значение свойства

string

subscriptionKey

Ключ подписки из учетной записи Azure Maps. Необходимо указать для типа проверки подлинности с помощью ключа подписки.

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 Maps

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

Функция обратного вызова, отвечающая за разрешение маркера проверки подлинности.