AuthenticationOptions interface

  • Referens
Paket:
azure-maps-control

Alternativ för att ange hur kartkontrollen ska autentiseras med Azure Maps-tjänsterna.

Extends
Options

Egenskaper

aadAppId

Det Azure AD registrerade app-ID:t. Det här är app-ID:t för en app som är registrerad i din Azure AD klientorganisation. Måste anges för AAD-autentiseringstyp.
aadInstance

Den AAD-instans som ska användas för att logga in. Du kan också ange när du använder AAD-autentiseringstypen. Som standard används instansen https://login.microsoftonline.com/ .
aadTenant

AAD-klientorganisationen som äger den registrerade appen som anges av aadAppId. Måste anges för AAD-autentiseringstyp.
authContext

Du kan också ange en befintlig PublicClientApplication från MSAL.js-biblioteket. Den här autentiseringskontexten används för att hämta AAD-token. Används endast med AAD-autentiseringstypen. Den här autentiseringskontexten måste konfigureras för att använda samma AAD-app-ID som this.aadAppId. Om detta inte anges delar alla kartinstanser sin egen privata autentiseringskontext.
authType

Den autentiseringsmekanism som ska användas.
clientId

Det Azure Maps klient-ID: Detta är en unik identifierare som används för att identifiera maps-kontot. Rekommenderas att alltid anges, men måste anges för AAD och anonyma autentiseringstyper.
getToken

Ett återanrop som ska användas med mekanismen för anonym/sas-autentisering. Återanropet ansvarar för att matcha en autentiseringstoken. Hämtar t.ex. en CORS-skyddad token från en slutpunkt.
sasToken

Du kan också ange en första token för SAS-autentisering.
subscriptionKey

Prenumerationsnyckel från ditt Azure Maps-konto. Måste anges för prenumerationsnyckelautentiseringstyp.

Metoder

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

Anger de autentiseringsalternativ som krävs för att konfigurera AAD-mekanismen för implicit beviljande.
setSasCallbackFunction(getAuthTokenCallback)

Anger de alternativ som krävs för att konfigurera sas-autentiseringsmetoden.
setSubscriptionKey(string)

Anger de alternativ som krävs för att konfigurera autentiseringsmekanismen för prenumerationsnyckeln.
setTokenCallbackFunction(getAuthTokenCallback)

Anger de alternativ som krävs för att konfigurera den anonyma autentiseringsmetoden.

Egenskapsinformation

aadAppId

Det Azure AD registrerade app-ID:t. Det här är app-ID:t för en app som är registrerad i din Azure AD klientorganisation. Måste anges för AAD-autentiseringstyp.

aadAppId?: string

Egenskapsvärde

string

aadInstance

Den AAD-instans som ska användas för att logga in. Du kan också ange när du använder AAD-autentiseringstypen. Som standard används instansen https://login.microsoftonline.com/ .

aadInstance?: string

Egenskapsvärde

string

aadTenant

AAD-klientorganisationen som äger den registrerade appen som anges av aadAppId. Måste anges för AAD-autentiseringstyp.

aadTenant?: string

Egenskapsvärde

string

authContext

Du kan också ange en befintlig PublicClientApplication från MSAL.js-biblioteket. Den här autentiseringskontexten används för att hämta AAD-token. Används endast med AAD-autentiseringstypen. Den här autentiseringskontexten måste konfigureras för att använda samma AAD-app-ID som this.aadAppId. Om detta inte anges delar alla kartinstanser sin egen privata autentiseringskontext.

authContext?: PublicClientApplication

Egenskapsvärde

PublicClientApplication

authType

Den autentiseringsmekanism som ska användas.

authType?: AuthenticationType

Egenskapsvärde

AuthenticationType

clientId

Det Azure Maps klient-ID: Detta är en unik identifierare som används för att identifiera maps-kontot. Rekommenderas att alltid anges, men måste anges för AAD och anonyma autentiseringstyper.

clientId?: string

Egenskapsvärde

string

getToken

Ett återanrop som ska användas med mekanismen för anonym/sas-autentisering. Återanropet ansvarar för att matcha en autentiseringstoken. Hämtar t.ex. en CORS-skyddad token från en slutpunkt.

getToken?: getAuthTokenCallback

Egenskapsvärde

getAuthTokenCallback

sasToken

Du kan också ange en första token för SAS-autentisering.

sasToken?: string

Egenskapsvärde

string

subscriptionKey

Prenumerationsnyckel från ditt Azure Maps-konto. Måste anges för prenumerationsnyckelautentiseringstyp.

subscriptionKey?: string

Egenskapsvärde

string

Metodinformation

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

Anger de autentiseringsalternativ som krävs för att konfigurera AAD-mekanismen för implicit beviljande.

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

Parametrar

clientId

string

Klient-ID från ditt Azure Maps-konto

aadAppId

string

Azure AD app-ID

aadTenant

string

Azure AD klientorganisationsnamn

aadInstance

string

En valfri Azure AD-instans

authContext

PublicClientApplication

Ett valfritt PublicClientApplication från MSAL.js-biblioteket

setSasCallbackFunction(getAuthTokenCallback)

Anger de alternativ som krävs för att konfigurera sas-autentiseringsmetoden.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametrar

getTokenCallback
getAuthTokenCallback

Återanropsfunktion som ansvarar för att matcha till en autentiseringstoken.

setSubscriptionKey(string)

Anger de alternativ som krävs för att konfigurera autentiseringsmekanismen för prenumerationsnyckeln.

function setSubscriptionKey(key: string)

Parametrar

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Anger de alternativ som krävs för att konfigurera den anonyma autentiseringsmetoden.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametrar

getTokenCallback
getAuthTokenCallback

Återanropsfunktion som ansvarar för att matcha till en autentiseringstoken.