你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AuthenticationOptions interface

包:

azure-maps-control

用于指定地图控件应如何使用Azure Maps服务进行身份验证的选项。

Extends

Options

属性

aadAppId	Azure AD 注册的应用 ID。 这是在 Azure AD 租户中注册的应用的应用 ID。 必须为 AAD 身份验证类型指定。
aadInstance	用于登录的 AAD 实例。 可以选择在使用 AAD 身份验证类型时指定。 默认情况下， https://login.microsoftonline.com/ 将使用 实例。
aadTenant	拥有由 aadAppId指定的已注册应用的 AAD 租户。 必须为 AAD 身份验证类型指定。
authContext	（可选）从 MSAL.js 库中提供现有的 PublicClientApplication 。 此身份验证上下文将用于获取 AAD 令牌。 仅与 AAD 身份验证类型一起使用。 必须将此身份验证上下文配置为使用与 相同的 AAD 应用 ID this.aadAppId。 如果未提供此功能，则所有映射实例都将共享其自己的专用身份验证上下文。
authType	要使用的身份验证机制。
clientId	Azure Maps客户端 ID，这是用于标识地图帐户的唯一标识符。 首选始终指定，但必须为 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 注册的应用 ID。 这是在 Azure AD 租户中注册的应用的应用 ID。 必须为 AAD 身份验证类型指定。

aadAppId?: string

属性值

string

aadInstance

用于登录的 AAD 实例。 可以选择在使用 AAD 身份验证类型时指定。 默认情况下， https://login.microsoftonline.com/ 将使用 实例。

aadInstance?: string

属性值

string

aadTenant

拥有由 aadAppId指定的已注册应用的 AAD 租户。 必须为 AAD 身份验证类型指定。

aadTenant?: string

属性值

string

authContext

（可选）从 MSAL.js 库中提供现有的 PublicClientApplication 。 此身份验证上下文将用于获取 AAD 令牌。 仅与 AAD 身份验证类型一起使用。 必须将此身份验证上下文配置为使用与 相同的 AAD 应用 ID this.aadAppId。 如果未提供此功能，则所有映射实例都将共享其自己的专用身份验证上下文。

authContext?: PublicClientApplication

属性值

PublicClientApplication

authType

要使用的身份验证机制。

authType?: AuthenticationType

属性值

AuthenticationType

clientId

Azure Maps客户端 ID，这是用于标识地图帐户的唯一标识符。 首选始终指定，但必须为 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 帐户中的客户端 ID

aadAppId

string

Azure AD 应用 ID

aadTenant

string

Azure AD 租户名称

aadInstance

string

可选的 Azure AD 实例

authContext

PublicClientApplication

MSAL.js 库中的可选PublicClientApplication

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

负责解析为身份验证令牌的回调函数。