AuthenticationOptions interface

  • Referentie
Pakket:
azure-maps-control

Opties voor het opgeven van hoe het kaartbeheer moet worden geverifieerd met de Azure Maps-services.

Extends
Options

Eigenschappen

aadAppId

De Azure AD geregistreerde app-id. Dit is de app-id van een app die is geregistreerd in uw Azure AD-tenant. Moet worden opgegeven voor het AAD-verificatietype.
aadInstance

Het AAD-exemplaar dat moet worden gebruikt voor aanmelding. Kan optioneel worden opgegeven bij gebruik van het AAD-verificatietype. Standaard wordt het https://login.microsoftonline.com/ exemplaar gebruikt.
aadTenant

De AAD-tenant die eigenaar is van de geregistreerde app die is opgegeven door aadAppId. Moet worden opgegeven voor het AAD-verificatietype.
authContext

Geef eventueel een bestaande PublicClientApplication op uit de MSAL.js-bibliotheek. Deze verificatiecontext wordt gebruikt om het AAD-token te verkrijgen. Alleen gebruikt met het AAD-verificatietype. Deze verificatiecontext moet worden geconfigureerd om dezelfde AAD-app-id te gebruiken als this.aadAppId. Als dit niet is opgegeven, delen alle kaartexemplaren hun eigen persoonlijke verificatiecontext.
authType

Het verificatiemechanisme dat moet worden gebruikt.
clientId

De Azure Maps client-id. Dit is een unieke id die wordt gebruikt om het toewijzingsaccount te identificeren. De voorkeur is altijd opgegeven, maar moet worden opgegeven voor AAD- en anonieme verificatietypen.
getToken

Een callback voor gebruik met het mechanisme voor anonieme/SAS-verificatie. Deze callback is verantwoordelijk voor het omzetten naar een verificatietoken. Bijvoorbeeld het ophalen van een met CORS beveiligd token van een eindpunt.
sasToken

Geef eventueel een eerste token op voor SAS-verificatie.
subscriptionKey

Abonnementssleutel van uw Azure Maps-account. Moet worden opgegeven voor het verificatietype abonnementssleutel.

Methoden

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

Hiermee stelt u de vereiste verificatieopties in voor het configureren van het mechanisme voor impliciete toekenning van AAD.
setSasCallbackFunction(getAuthTokenCallback)

Hiermee stelt u de vereiste opties voor het configureren van de sas-verificatiemethode.
setSubscriptionKey(string)

Hiermee stelt u de vereiste opties in voor het configureren van het verificatiemechanisme voor de abonnementssleutel.
setTokenCallbackFunction(getAuthTokenCallback)

Hiermee stelt u de vereiste opties in voor het configureren van de anonieme verificatiemethode.

Eigenschapdetails

aadAppId

De Azure AD geregistreerde app-id. Dit is de app-id van een app die is geregistreerd in uw Azure AD-tenant. Moet worden opgegeven voor het AAD-verificatietype.

aadAppId?: string

Waarde van eigenschap

string

aadInstance

Het AAD-exemplaar dat moet worden gebruikt voor aanmelding. Kan optioneel worden opgegeven bij gebruik van het AAD-verificatietype. Standaard wordt het https://login.microsoftonline.com/ exemplaar gebruikt.

aadInstance?: string

Waarde van eigenschap

string

aadTenant

De AAD-tenant die eigenaar is van de geregistreerde app die is opgegeven door aadAppId. Moet worden opgegeven voor het AAD-verificatietype.

aadTenant?: string

Waarde van eigenschap

string

authContext

Geef eventueel een bestaande PublicClientApplication op uit de MSAL.js-bibliotheek. Deze verificatiecontext wordt gebruikt om het AAD-token te verkrijgen. Alleen gebruikt met het AAD-verificatietype. Deze verificatiecontext moet worden geconfigureerd om dezelfde AAD-app-id te gebruiken als this.aadAppId. Als dit niet is opgegeven, delen alle kaartexemplaren hun eigen persoonlijke verificatiecontext.

authContext?: PublicClientApplication

Waarde van eigenschap

PublicClientApplication

authType

Het verificatiemechanisme dat moet worden gebruikt.

authType?: AuthenticationType

Waarde van eigenschap

AuthenticationType

clientId

De Azure Maps client-id. Dit is een unieke id die wordt gebruikt om het toewijzingsaccount te identificeren. De voorkeur is altijd opgegeven, maar moet worden opgegeven voor AAD- en anonieme verificatietypen.

clientId?: string

Waarde van eigenschap

string

getToken

Een callback voor gebruik met het mechanisme voor anonieme/SAS-verificatie. Deze callback is verantwoordelijk voor het omzetten naar een verificatietoken. Bijvoorbeeld het ophalen van een met CORS beveiligd token van een eindpunt.

getToken?: getAuthTokenCallback

Waarde van eigenschap

getAuthTokenCallback

sasToken

Geef eventueel een eerste token op voor SAS-verificatie.

sasToken?: string

Waarde van eigenschap

string

subscriptionKey

Abonnementssleutel van uw Azure Maps-account. Moet worden opgegeven voor het verificatietype abonnementssleutel.

subscriptionKey?: string

Waarde van eigenschap

string

Methodedetails

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

Hiermee stelt u de vereiste verificatieopties in voor het configureren van het mechanisme voor impliciete toekenning van AAD.

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

Parameters

clientId

string

Client-id van uw Azure Maps-account

aadAppId

string

Azure AD app-id

aadTenant

string

tenantnaam Azure AD

aadInstance

string

Een optioneel Azure AD-exemplaar

authContext

PublicClientApplication

Een optioneel PublicClientApplication uit de MSAL.js-bibliotheek

setSasCallbackFunction(getAuthTokenCallback)

Hiermee stelt u de vereiste opties voor het configureren van de sas-verificatiemethode.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parameters

getTokenCallback
getAuthTokenCallback

Callback-functie die verantwoordelijk is voor het oplossen van een verificatietoken.

setSubscriptionKey(string)

Hiermee stelt u de vereiste opties in voor het configureren van het verificatiemechanisme voor de abonnementssleutel.

function setSubscriptionKey(key: string)

Parameters

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Hiermee stelt u de vereiste opties in voor het configureren van de anonieme verificatiemethode.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parameters

getTokenCallback
getAuthTokenCallback

Callback-functie die verantwoordelijk is voor het oplossen van een verificatietoken.