AuthenticationOptions interface
Параметры для указания способа проверки подлинности элемента управления картой в службах Azure Maps.
- Extends
Свойства
| aad |
Идентификатор зарегистрированного приложения Azure AD. Это идентификатор приложения, зарегистрированного в клиенте Azure AD. Необходимо указать для типа проверки подлинности AAD. |
| aad |
Экземпляр AAD, используемый для входа в систему.
При необходимости можно указать при использовании типа проверки подлинности AAD.
По умолчанию |
| aad |
Клиент AAD, которому принадлежит зарегистрированное приложение, указанное параметром |
| auth |
При необходимости укажите существующий |
| auth |
Используемый механизм проверки подлинности. |
| client |
Идентификатор Azure Maps клиента. Это уникальный идентификатор, используемый для идентификации учетной записи карты. Рекомендуется всегда указывать, но необходимо указывать для типов AAD и анонимной проверки подлинности. |
| get |
Обратный вызов для использования с механизмом анонимной проверки подлинности или проверки подлинности SAS. Этот обратный вызов будет отвечать за разрешение маркера проверки подлинности. Например, получение защищенного маркера CORS из конечной точки. |
| sas |
При необходимости укажите начальный маркер для проверки подлинности SAS. |
| subscription |
Ключ подписки из учетной записи Azure Maps. Необходимо указать для типа проверки подлинности с помощью ключа подписки. |
Методы
| set |
Задает необходимые параметры проверки подлинности для настройки механизма неявного предоставления AAD. |
| set |
Задает необходимые параметры для настройки метода проверки подлинности SAS. |
| set |
Задает необходимые параметры для настройки механизма проверки подлинности ключа подписки. |
| set |
Задает необходимые параметры для настройки анонимного метода проверки подлинности. |
Сведения о свойстве
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Значение свойства
clientId
Идентификатор Azure Maps клиента. Это уникальный идентификатор, используемый для идентификации учетной записи карты. Рекомендуется всегда указывать, но необходимо указывать для типов AAD и анонимной проверки подлинности.
clientId?: stringЗначение свойства
string
getToken
Обратный вызов для использования с механизмом анонимной проверки подлинности или проверки подлинности SAS. Этот обратный вызов будет отвечать за разрешение маркера проверки подлинности. Например, получение защищенного маркера CORS из конечной точки.
getToken?: 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
Функция обратного вызова, отвечающая за разрешение маркера проверки подлинности.