AuthenticationOptions interface

  • Reference
Balíček:
azure-maps-control

Možnosti pro určení způsobu ověřování ovládacího prvku mapy u služeb Azure Maps

Extends
Options

Vlastnosti

aadAppId

ID zaregistrované aplikace Azure AD. Toto je ID aplikace zaregistrované ve vašem tenantovi Azure AD. Musí být zadán pro typ ověřování AAD.
aadInstance

Instance AAD, která se má použít pro přihlášení. Volitelně je možné zadat při použití typu ověřování AAD. Ve výchozím nastavení se https://login.microsoftonline.com/ použije instance.
aadTenant

Tenant AAD, který vlastní zaregistrovanou aplikaci určenou pomocí aadAppId. Musí být zadán pro typ ověřování AAD.
authContext

Volitelně můžete zadat existující PublicClientApplication z knihovny MSAL.js. Tento kontext ověřování se použije k získání tokenu AAD. Používá se pouze s typem ověřování AAD. Tento kontext ověřování musí být nakonfigurovaný tak, aby používal stejné ID aplikace AAD jako this.aadAppId. Pokud tato možnost není k dispozici, všechny instance map budou sdílet svůj vlastní kontext privátního ověřování.
authType

Mechanismus ověřování, který se má použít.
clientId

ID klienta Azure Maps: Jedná se o jedinečný identifikátor, který se používá k identifikaci účtu maps. Upřednostňované vždy, ale musí být zadány pro typy AAD a anonymního ověřování.
getToken

Zpětné volání, které se má použít s mechanismem ověřování anonym/SAS. Toto zpětné volání bude zodpovědné za překlad na ověřovací token. Například načtení tokenu chráněného cors z koncového bodu.
sasToken

Volitelně můžete zadat počáteční token pro ověřování SAS.
subscriptionKey

Klíč předplatného z účtu Azure Maps. Je nutné zadat typ ověřování klíče předplatného.

Metody

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

Nastaví požadované možnosti ověřování pro konfiguraci mechanismu implicitního udělení AAD.
setSasCallbackFunction(getAuthTokenCallback)

Nastaví požadované možnosti pro konfiguraci metody ověřování SAS.
setSubscriptionKey(string)

Nastaví požadované možnosti pro konfiguraci mechanismu ověřování klíče předplatného.
setTokenCallbackFunction(getAuthTokenCallback)

Nastaví požadované možnosti pro konfiguraci metody anonymního ověřování.

Podrobnosti vlastnosti

aadAppId

ID zaregistrované aplikace Azure AD. Toto je ID aplikace zaregistrované ve vašem tenantovi Azure AD. Musí být zadán pro typ ověřování AAD.

aadAppId?: string

Hodnota vlastnosti

string

aadInstance

Instance AAD, která se má použít pro přihlášení. Volitelně je možné zadat při použití typu ověřování AAD. Ve výchozím nastavení se https://login.microsoftonline.com/ použije instance.

aadInstance?: string

Hodnota vlastnosti

string

aadTenant

Tenant AAD, který vlastní zaregistrovanou aplikaci určenou pomocí aadAppId. Musí být zadán pro typ ověřování AAD.

aadTenant?: string

Hodnota vlastnosti

string

authContext

Volitelně můžete zadat existující PublicClientApplication z knihovny MSAL.js. Tento kontext ověřování se použije k získání tokenu AAD. Používá se pouze s typem ověřování AAD. Tento kontext ověřování musí být nakonfigurovaný tak, aby používal stejné ID aplikace AAD jako this.aadAppId. Pokud tato možnost není k dispozici, všechny instance map budou sdílet svůj vlastní kontext privátního ověřování.

authContext?: PublicClientApplication

Hodnota vlastnosti

PublicClientApplication

authType

Mechanismus ověřování, který se má použít.

authType?: AuthenticationType

Hodnota vlastnosti

AuthenticationType

clientId

ID klienta Azure Maps: Jedná se o jedinečný identifikátor, který se používá k identifikaci účtu maps. Upřednostňované vždy, ale musí být zadány pro typy AAD a anonymního ověřování.

clientId?: string

Hodnota vlastnosti

string

getToken

Zpětné volání, které se má použít s mechanismem ověřování anonym/SAS. Toto zpětné volání bude zodpovědné za překlad na ověřovací token. Například načtení tokenu chráněného cors z koncového bodu.

getToken?: getAuthTokenCallback

Hodnota vlastnosti

getAuthTokenCallback

sasToken

Volitelně můžete zadat počáteční token pro ověřování SAS.

sasToken?: string

Hodnota vlastnosti

string

subscriptionKey

Klíč předplatného z účtu Azure Maps. Je nutné zadat typ ověřování klíče předplatného.

subscriptionKey?: string

Hodnota vlastnosti

string

Podrobnosti metody

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

Nastaví požadované možnosti ověřování pro konfiguraci mechanismu implicitního udělení AAD.

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

Parametry

clientId

string

ID klienta z účtu Azure Maps

aadAppId

string

ID aplikace Azure AD

aadTenant

string

název tenanta Azure AD

aadInstance

string

Volitelná instance Azure AD

authContext

PublicClientApplication

Volitelné PublicClientApplication z knihovny MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

Nastaví požadované možnosti pro konfiguraci metody ověřování SAS.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametry

getTokenCallback
getAuthTokenCallback

Funkce zpětného volání zodpovědná za překlad na ověřovací token.

setSubscriptionKey(string)

Nastaví požadované možnosti pro konfiguraci mechanismu ověřování klíče předplatného.

function setSubscriptionKey(key: string)

Parametry

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Nastaví požadované možnosti pro konfiguraci metody anonymního ověřování.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametry

getTokenCallback
getAuthTokenCallback

Funkce zpětného volání zodpovědná za překlad na ověřovací token.