AuthenticationOptions interface

  • Référence
Paquet:
azure-maps-control

Options permettant de spécifier la façon dont le contrôle de carte doit s’authentifier auprès des services Azure Maps.

Extends
Options

Propriétés

aadAppId

ID d’application inscrite dans Azure AD. Il s’agit de l’ID d’application d’une application inscrite dans votre locataire Azure AD. Doit être spécifié pour le type d’authentification AAD.
aadInstance

Le instance AAD à utiliser pour la connexion. Peut être spécifié éventuellement lors de l’utilisation du type d’authentification AAD. Par défaut, le https://login.microsoftonline.com/ instance sera utilisé.
aadTenant

Locataire AAD qui possède l’application inscrite spécifiée par aadAppId. Doit être spécifié pour le type d’authentification AAD.
authContext

Fournissez éventuellement un existant PublicClientApplication à partir de la bibliothèque MSAL.js. Ce contexte d’authentification sera utilisé pour acquérir le jeton AAD. Utilisé uniquement avec le type d’authentification AAD. Ce contexte d’authentification doit être configuré pour utiliser le même ID d’application AAD que this.aadAppId. Si ce n’est pas fourni, toutes les instances de carte partagent leur propre contexte d’authentification privé.
authType

Mécanisme d’authentification à utiliser.
clientId

ID client Azure Maps, il s’agit d’un identificateur unique utilisé pour identifier le compte de mappages. Préféré pour toujours être spécifié, mais doit être spécifié pour les types d’authentification AAD et anonyme.
getToken

Rappel à utiliser avec le mécanisme d’authentification anonyme/sas. Ce rappel sera responsable de la résolution en jeton d’authentification. Par exemple, extraction d’un jeton protégé CORS à partir d’un point de terminaison.
sasToken

Fournissez éventuellement un jeton initial pour l’authentification sas.
subscriptionKey

Clé d’abonnement à partir de votre compte Azure Maps. Doit être spécifié pour le type d’authentification par clé d’abonnement.

Méthodes

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

Définit les options d’authentification requises pour configurer le mécanisme d’octroi implicite AAD.
setSasCallbackFunction(getAuthTokenCallback)

Définit les options requises pour configurer la méthode d’authentification sas.
setSubscriptionKey(string)

Définit les options requises pour configurer le mécanisme d’authentification par clé d’abonnement.
setTokenCallbackFunction(getAuthTokenCallback)

Définit les options requises pour configurer la méthode d’authentification anonyme.

Détails de la propriété

aadAppId

ID d’application inscrite dans Azure AD. Il s’agit de l’ID d’application d’une application inscrite dans votre locataire Azure AD. Doit être spécifié pour le type d’authentification AAD.

aadAppId?: string

Valeur de propriété

string

aadInstance

Le instance AAD à utiliser pour la connexion. Peut être spécifié éventuellement lors de l’utilisation du type d’authentification AAD. Par défaut, le https://login.microsoftonline.com/ instance sera utilisé.

aadInstance?: string

Valeur de propriété

string

aadTenant

Locataire AAD qui possède l’application inscrite spécifiée par aadAppId. Doit être spécifié pour le type d’authentification AAD.

aadTenant?: string

Valeur de propriété

string

authContext

Fournissez éventuellement un existant PublicClientApplication à partir de la bibliothèque MSAL.js. Ce contexte d’authentification sera utilisé pour acquérir le jeton AAD. Utilisé uniquement avec le type d’authentification AAD. Ce contexte d’authentification doit être configuré pour utiliser le même ID d’application AAD que this.aadAppId. Si ce n’est pas fourni, toutes les instances de carte partagent leur propre contexte d’authentification privé.

authContext?: PublicClientApplication

Valeur de propriété

PublicClientApplication

authType

Mécanisme d’authentification à utiliser.

authType?: AuthenticationType

Valeur de propriété

AuthenticationType

clientId

ID client Azure Maps, il s’agit d’un identificateur unique utilisé pour identifier le compte de mappages. Préféré pour toujours être spécifié, mais doit être spécifié pour les types d’authentification AAD et anonyme.

clientId?: string

Valeur de propriété

string

getToken

Rappel à utiliser avec le mécanisme d’authentification anonyme/sas. Ce rappel sera responsable de la résolution en jeton d’authentification. Par exemple, extraction d’un jeton protégé CORS à partir d’un point de terminaison.

getToken?: getAuthTokenCallback

Valeur de propriété

getAuthTokenCallback

sasToken

Fournissez éventuellement un jeton initial pour l’authentification sas.

sasToken?: string

Valeur de propriété

string

subscriptionKey

Clé d’abonnement à partir de votre compte Azure Maps. Doit être spécifié pour le type d’authentification par clé d’abonnement.

subscriptionKey?: string

Valeur de propriété

string

Détails de la méthode

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

Définit les options d’authentification requises pour configurer le mécanisme d’octroi implicite AAD.

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

Paramètres

clientId

string

ID client de votre compte Azure Maps

aadAppId

string

ID de l’application Azure AD

aadTenant

string

Nom du locataire Azure AD

aadInstance

string

Une instance Azure AD facultative

authContext

PublicClientApplication

Facultatif PublicClientApplication à partir de la bibliothèque MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

Définit les options requises pour configurer la méthode d’authentification sas.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Paramètres

getTokenCallback
getAuthTokenCallback

Fonction de rappel chargée de la résolution en jeton d’authentification.

setSubscriptionKey(string)

Définit les options requises pour configurer le mécanisme d’authentification par clé d’abonnement.

function setSubscriptionKey(key: string)

Paramètres

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Définit les options requises pour configurer la méthode d’authentification anonyme.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Paramètres

getTokenCallback
getAuthTokenCallback

Fonction de rappel chargée de la résolution en jeton d’authentification.