Compartir a través de

AuthenticationOptions interface

  • Referencia
Paquete:
azure-maps-control

Opciones para especificar cómo se debe autenticar el control de mapa con los servicios de Azure Maps.

Extends
Options

Propiedades

aadAppId

Identificador de aplicación registrado de Azure AD. Este es el identificador de aplicación de una aplicación registrada en el inquilino de Azure AD. Debe especificarse para el tipo de autenticación de AAD.
aadInstance

Instancia de AAD que se va a usar para iniciar sesión. Opcionalmente, se puede especificar al usar el tipo de autenticación de AAD. De forma predeterminada, se usará la https://login.microsoftonline.com/ instancia.
aadTenant

El inquilino de AAD que posee la aplicación registrada especificada por aadAppId. Debe especificarse para el tipo de autenticación de AAD.
authContext

Opcionalmente, proporcione un existente PublicClientApplication desde la biblioteca de MSAL.js. Este contexto de autenticación se usará para adquirir el token de AAD. Solo se usa con el tipo de autenticación de AAD. Este contexto de autenticación debe configurarse para usar el mismo identificador de aplicación de AAD que this.aadAppId. Si no se proporciona, todas las instancias de asignación compartirán su propio contexto de autenticación privada.
authType

Mecanismo de autenticación que se va a usar.
clientId

El identificador de cliente de Azure Maps, se trata de un identificador único que se usa para identificar la cuenta de mapas. Se prefiere especificar siempre, pero debe especificarse para los tipos de autenticación AAD y anónimos.
getToken

Devolución de llamada que se va a usar con el mecanismo de autenticación anónimo/sas. Esta devolución de llamada será responsable de resolver en un token de autenticación. Por ejemplo, capturar un token protegido por CORS desde un punto de conexión.
sasToken

Opcionalmente, proporcione un token inicial para la autenticación sas.
subscriptionKey

Clave de suscripción de la cuenta de Azure Maps. Debe especificarse para el tipo de autenticación de clave de suscripción.

Métodos

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

Establece las opciones de autenticación necesarias para configurar el mecanismo de concesión implícita de AAD.
setSasCallbackFunction(getAuthTokenCallback)

Establece las opciones necesarias para configurar el método de autenticación sas.
setSubscriptionKey(string)

Establece las opciones necesarias para configurar el mecanismo de autenticación de clave de suscripción.
setTokenCallbackFunction(getAuthTokenCallback)

Establece las opciones necesarias para configurar el método de autenticación anónima.

Detalles de las propiedades

aadAppId

Identificador de aplicación registrado de Azure AD. Este es el identificador de aplicación de una aplicación registrada en el inquilino de Azure AD. Debe especificarse para el tipo de autenticación de AAD.

aadAppId?: string

Valor de propiedad

string

aadInstance

Instancia de AAD que se va a usar para iniciar sesión. Opcionalmente, se puede especificar al usar el tipo de autenticación de AAD. De forma predeterminada, se usará la https://login.microsoftonline.com/ instancia.

aadInstance?: string

Valor de propiedad

string

aadTenant

El inquilino de AAD que posee la aplicación registrada especificada por aadAppId. Debe especificarse para el tipo de autenticación de AAD.

aadTenant?: string

Valor de propiedad

string

authContext

Opcionalmente, proporcione un existente PublicClientApplication desde la biblioteca de MSAL.js. Este contexto de autenticación se usará para adquirir el token de AAD. Solo se usa con el tipo de autenticación de AAD. Este contexto de autenticación debe configurarse para usar el mismo identificador de aplicación de AAD que this.aadAppId. Si no se proporciona, todas las instancias de asignación compartirán su propio contexto de autenticación privada.

authContext?: PublicClientApplication

Valor de propiedad

PublicClientApplication

authType

Mecanismo de autenticación que se va a usar.

authType?: AuthenticationType

Valor de propiedad

AuthenticationType

clientId

El identificador de cliente de Azure Maps, se trata de un identificador único que se usa para identificar la cuenta de mapas. Se prefiere especificar siempre, pero debe especificarse para los tipos de autenticación AAD y anónimos.

clientId?: string

Valor de propiedad

string

getToken

Devolución de llamada que se va a usar con el mecanismo de autenticación anónimo/sas. Esta devolución de llamada será responsable de resolver en un token de autenticación. Por ejemplo, capturar un token protegido por CORS desde un punto de conexión.

getToken?: getAuthTokenCallback

Valor de propiedad

getAuthTokenCallback

sasToken

Opcionalmente, proporcione un token inicial para la autenticación sas.

sasToken?: string

Valor de propiedad

string

subscriptionKey

Clave de suscripción de la cuenta de Azure Maps. Debe especificarse para el tipo de autenticación de clave de suscripción.

subscriptionKey?: string

Valor de propiedad

string

Detalles del método

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

Establece las opciones de autenticación necesarias para configurar el mecanismo de concesión implícita de AAD.

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

Parámetros

clientId

string

Id. de cliente de la cuenta de Azure Maps

aadAppId

string

Identificador de aplicación de Azure AD

aadTenant

string

Nombre del inquilino de Azure AD

aadInstance

string

Una instancia opcional de Azure AD

authContext

PublicClientApplication

Un opcional PublicClientApplication de la biblioteca de MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

Establece las opciones necesarias para configurar el método de autenticación sas.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parámetros

getTokenCallback
getAuthTokenCallback

Función de devolución de llamada responsable de resolver en un token de autenticación.

setSubscriptionKey(string)

Establece las opciones necesarias para configurar el mecanismo de autenticación de clave de suscripción.

function setSubscriptionKey(key: string)

Parámetros

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Establece las opciones necesarias para configurar el método de autenticación anónima.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parámetros

getTokenCallback
getAuthTokenCallback

Función de devolución de llamada responsable de resolver en un token de autenticación.