AuthenticationOptions interface

套件:

azure-maps-control

指定地圖控制項如何向Azure 地圖服務服務進行驗證的選項。

Extends

Options

屬性

aadAppId	Azure AD 註冊的應用程式識別碼。 這是在 Azure AD 租使用者中註冊之應用程式的應用程式識別碼。 必須針對 AAD 驗證類型指定。
aadInstance	要用於登入的 AAD 實例。 在使用 AAD 驗證類型時，可以選擇性地指定。 根據預設， https://login.microsoftonline.com/ 將會使用 實例。
aadTenant	擁有 所 aadAppId 指定已註冊應用程式的 AAD 租使用者。 必須針對 AAD 驗證類型指定。
authContext	選擇性地從 MSAL.js 程式庫提供現有的 PublicClientApplication 。 此驗證內容將用來取得 AAD 權杖。 僅適用于 AAD 驗證類型。 此驗證內容必須設定為使用與 相同的 AAD 應用程式識別碼 this.aadAppId 。 如果未提供，則所有對應實例都會共用自己的私人驗證內容。
authType	要使用的驗證機制。
clientId	Azure 地圖服務用戶端識別碼，這是用來識別地圖帳戶的唯一識別碼。 最好一律指定，但必須針對 AAD 和匿名驗證類型指定。
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

擁有 所 aadAppId 指定已註冊應用程式的 AAD 租使用者。 必須針對 AAD 驗證類型指定。

aadTenant?: string

屬性值

string

authContext

選擇性地從 MSAL.js 程式庫提供現有的 PublicClientApplication 。 此驗證內容將用來取得 AAD 權杖。 僅適用于 AAD 驗證類型。 此驗證內容必須設定為使用與 相同的 AAD 應用程式識別碼 this.aadAppId 。 如果未提供，則所有對應實例都會共用自己的私人驗證內容。

authContext?: PublicClientApplication

屬性值

PublicClientApplication

authType

要使用的驗證機制。

authType?: AuthenticationType

屬性值

AuthenticationType

clientId

Azure 地圖服務用戶端識別碼，這是用來識別地圖帳戶的唯一識別碼。 最好一律指定，但必須針對 AAD 和匿名驗證類型指定。

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 App 識別碼

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

負責解析為驗證權杖的回呼函式。