AuthenticationOptions interface

Csomag:

azure-maps-control

A térképvezérlőnek a Azure Maps-szolgáltatásokkal való hitelesítésének módjának megadására szolgáló beállítások.

Extends

Options

Tulajdonságok

aadAppId	A Azure AD regisztrált alkalmazásazonosító. Ez a Azure AD-bérlőben regisztrált alkalmazás alkalmazásazonosítója. Meg kell adni az AAD-hitelesítés típusát.
aadInstance	A bejelentkezéshez használni kívánt AAD-példány. Az AAD-hitelesítési típus használatakor opcionálisan megadható. Alapértelmezés szerint a rendszer a https://login.microsoftonline.com/ példányt használja.
aadTenant	Az AAD-bérlő, amely a által aadAppIdmegadott regisztrált alkalmazás tulajdonosa. Meg kell adni az AAD-hitelesítés típusát.
authContext	Ha szeretné, adjon meg egy meglévőt PublicClientApplication a MSAL.js könyvtárból. Ezzel a hitelesítési környezettel szerezhető be az AAD-jogkivonat. Csak az AAD-hitelesítési típussal használható. Ezt a hitelesítési környezetet úgy kell konfigurálni, hogy ugyanazt az AAD-alkalmazásazonosítót használja, mint a this.aadAppId. Ha ez nem történik meg, az összes térképpéldány saját privát hitelesítési környezettel fog rendelkezni.
authType	A használni kívánt hitelesítési mechanizmus.
clientId	A Azure Maps ügyfél-azonosító, Ez egy egyedi azonosító, amely a maps-fiók azonosítására szolgál. Előnyben részesítendő, hogy mindig meg legyen adva, de meg kell adni az AAD és a névtelen hitelesítési típusok esetében.
getToken	A névtelen/sas hitelesítési mechanizmussal használható visszahívás. Ez a visszahívás lesz a felelős a hitelesítési jogkivonatra való feloldásért. Például egy CORS által védett jogkivonat lekérése egy végpontról.
sasToken	Igény szerint megadhat egy kezdeti jogkivonatot az SAS-hitelesítéshez.
subscriptionKey	Előfizetési kulcs a Azure Maps-fiókjából. Az előfizetési kulcs hitelesítési típusához meg kell adni.

Metódusok

setAadProperties(string, string, string, string, PublicClientApplication)	Megadja az AAD implicit engedélyezési mechanizmus konfigurálásához szükséges hitelesítési beállításokat.
setSasCallbackFunction(getAuthTokenCallback)	Megadja az SAS-hitelesítési módszer konfigurálásához szükséges beállításokat.
setSubscriptionKey(string)	Megadja az előfizetési kulcs hitelesítési mechanizmusának konfigurálásához szükséges beállításokat.
setTokenCallbackFunction(getAuthTokenCallback)	Megadja a névtelen hitelesítési módszer konfigurálásához szükséges beállításokat.

Tulajdonság adatai

aadAppId

A Azure AD regisztrált alkalmazásazonosító. Ez a Azure AD-bérlőben regisztrált alkalmazás alkalmazásazonosítója. Meg kell adni az AAD-hitelesítés típusát.

aadAppId?: string

Tulajdonság értéke

string

aadInstance

A bejelentkezéshez használni kívánt AAD-példány. Az AAD-hitelesítési típus használatakor opcionálisan megadható. Alapértelmezés szerint a rendszer a https://login.microsoftonline.com/ példányt használja.

aadInstance?: string

Tulajdonság értéke

string

aadTenant

Az AAD-bérlő, amely a által aadAppIdmegadott regisztrált alkalmazás tulajdonosa. Meg kell adni az AAD-hitelesítés típusát.

aadTenant?: string

Tulajdonság értéke

string

authContext

Ha szeretné, adjon meg egy meglévőt PublicClientApplication a MSAL.js könyvtárból. Ezzel a hitelesítési környezettel szerezhető be az AAD-jogkivonat. Csak az AAD-hitelesítési típussal használható. Ezt a hitelesítési környezetet úgy kell konfigurálni, hogy ugyanazt az AAD-alkalmazásazonosítót használja, mint a this.aadAppId. Ha ez nem történik meg, az összes térképpéldány saját privát hitelesítési környezettel fog rendelkezni.

authContext?: PublicClientApplication

Tulajdonság értéke

PublicClientApplication

authType

A használni kívánt hitelesítési mechanizmus.

authType?: AuthenticationType

Tulajdonság értéke

AuthenticationType

clientId

A Azure Maps ügyfél-azonosító, Ez egy egyedi azonosító, amely a maps-fiók azonosítására szolgál. Előnyben részesítendő, hogy mindig meg legyen adva, de meg kell adni az AAD és a névtelen hitelesítési típusok esetében.

clientId?: string

Tulajdonság értéke

string

getToken

A névtelen/sas hitelesítési mechanizmussal használható visszahívás. Ez a visszahívás lesz a felelős a hitelesítési jogkivonatra való feloldásért. Például egy CORS által védett jogkivonat lekérése egy végpontról.

getToken?: getAuthTokenCallback

Tulajdonság értéke

getAuthTokenCallback

sasToken

Igény szerint megadhat egy kezdeti jogkivonatot az SAS-hitelesítéshez.

sasToken?: string

Tulajdonság értéke

string

subscriptionKey

Előfizetési kulcs a Azure Maps-fiókjából. Az előfizetési kulcs hitelesítési típusához meg kell adni.

subscriptionKey?: string

Tulajdonság értéke

string

Metódus adatai

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

Megadja az AAD implicit engedélyezési mechanizmus konfigurálásához szükséges hitelesítési beállításokat.

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

Paraméterek

clientId

string

Ügyfél-azonosító az Azure Maps-fiókból

aadAppId

string

Azure AD alkalmazásazonosító

aadTenant

string

Azure AD bérlő neve

aadInstance

string

Nem kötelező Azure AD példány

authContext

PublicClientApplication

Nem kötelező PublicClientApplication a MSAL.js könyvtárból

setSasCallbackFunction(getAuthTokenCallback)

Megadja az SAS-hitelesítési módszer konfigurálásához szükséges beállításokat.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Paraméterek

getTokenCallback

getAuthTokenCallback

A hitelesítési jogkivonatra való feloldásért felelős visszahívási függvény.

setSubscriptionKey(string)

Megadja az előfizetési kulcs hitelesítési mechanizmusának konfigurálásához szükséges beállításokat.

function setSubscriptionKey(key: string)

Paraméterek

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Megadja a névtelen hitelesítési módszer konfigurálásához szükséges beállításokat.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Paraméterek

getTokenCallback

getAuthTokenCallback

A hitelesítési jogkivonatra való feloldásért felelős visszahívási függvény.