Condividi tramite

AuthenticationOptions interface

  • Riferimento
Pacchetto:
azure-maps-control

Opzioni per specificare il modo in cui il controllo mappa deve eseguire l'autenticazione con i servizi di Mappe di Azure.

Extends
Options

Proprietà

aadAppId

ID dell'app registrata in Azure AD. Si tratta dell'ID app di un'app registrata nel tenant di Azure AD. Deve essere specificato per il tipo di autenticazione AAD.
aadInstance

Istanza di AAD da usare per l'accesso. Può essere specificato facoltativamente quando si usa il tipo di autenticazione AAD. Per impostazione predefinita, verrà usata l'istanza https://login.microsoftonline.com/ .
aadTenant

Tenant AAD proprietario dell'app registrata specificata da aadAppId. Deve essere specificato per il tipo di autenticazione AAD.
authContext

Facoltativamente, specificare un oggetto esistente PublicClientApplication dalla libreria di MSAL.js. Questo contesto di autenticazione verrà usato per acquisire il token AAD. Usato solo con il tipo di autenticazione AAD. Questo contesto di autenticazione deve essere configurato per usare lo stesso ID app AAD di this.aadAppId. Se non viene fornito, tutte le istanze della mappa condivideranno il proprio contesto di autenticazione privata.
authType

Meccanismo di autenticazione da usare.
clientId

L'ID client Mappe di Azure, questo è un identificatore univoco usato per identificare l'account mappe. È preferibile specificare sempre, ma deve essere specificato per i tipi di autenticazione AAD e anonimi.
getToken

Callback da usare con il meccanismo di autenticazione anonimo/sas. Questo callback sarà responsabile della risoluzione di un token di autenticazione. Ad esempio, recuperare un token protetto CORS da un endpoint.
sasToken

Facoltativamente, specificare un token iniziale per l'autenticazione sas.
subscriptionKey

Chiave di sottoscrizione dall'account Mappe di Azure. Deve essere specificato per il tipo di autenticazione della chiave di sottoscrizione.

Metodi

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

Imposta le opzioni di autenticazione necessarie per configurare il meccanismo di concessione implicito AAD.
setSasCallbackFunction(getAuthTokenCallback)

Imposta le opzioni necessarie per configurare il metodo di autenticazione sas.
setSubscriptionKey(string)

Imposta le opzioni necessarie per configurare il meccanismo di autenticazione della chiave di sottoscrizione.
setTokenCallbackFunction(getAuthTokenCallback)

Imposta le opzioni necessarie per configurare il metodo di autenticazione anonimo.

Dettagli proprietà

aadAppId

ID dell'app registrata in Azure AD. Si tratta dell'ID app di un'app registrata nel tenant di Azure AD. Deve essere specificato per il tipo di autenticazione AAD.

aadAppId?: string

Valore della proprietà

string

aadInstance

Istanza di AAD da usare per l'accesso. Può essere specificato facoltativamente quando si usa il tipo di autenticazione AAD. Per impostazione predefinita, verrà usata l'istanza https://login.microsoftonline.com/ .

aadInstance?: string

Valore della proprietà

string

aadTenant

Tenant AAD proprietario dell'app registrata specificata da aadAppId. Deve essere specificato per il tipo di autenticazione AAD.

aadTenant?: string

Valore della proprietà

string

authContext

Facoltativamente, specificare un oggetto esistente PublicClientApplication dalla libreria di MSAL.js. Questo contesto di autenticazione verrà usato per acquisire il token AAD. Usato solo con il tipo di autenticazione AAD. Questo contesto di autenticazione deve essere configurato per usare lo stesso ID app AAD di this.aadAppId. Se non viene fornito, tutte le istanze della mappa condivideranno il proprio contesto di autenticazione privata.

authContext?: PublicClientApplication

Valore della proprietà

PublicClientApplication

authType

Meccanismo di autenticazione da usare.

authType?: AuthenticationType

Valore della proprietà

AuthenticationType

clientId

L'ID client Mappe di Azure, questo è un identificatore univoco usato per identificare l'account mappe. È preferibile specificare sempre, ma deve essere specificato per i tipi di autenticazione AAD e anonimi.

clientId?: string

Valore della proprietà

string

getToken

Callback da usare con il meccanismo di autenticazione anonimo/sas. Questo callback sarà responsabile della risoluzione di un token di autenticazione. Ad esempio, recuperare un token protetto CORS da un endpoint.

getToken?: getAuthTokenCallback

Valore della proprietà

getAuthTokenCallback

sasToken

Facoltativamente, specificare un token iniziale per l'autenticazione sas.

sasToken?: string

Valore della proprietà

string

subscriptionKey

Chiave di sottoscrizione dall'account Mappe di Azure. Deve essere specificato per il tipo di autenticazione della chiave di sottoscrizione.

subscriptionKey?: string

Valore della proprietà

string

Dettagli metodo

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

Imposta le opzioni di autenticazione necessarie per configurare il meccanismo di concessione implicito AAD.

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

Parametri

clientId

string

ID client dall'account mappe di Azure

aadAppId

string

Azure AD App ID (ID App Azure AD)

aadTenant

string

Azure AD Tenant Name (Nome del tenant di Azure AD)

aadInstance

string

Istanza facoltativa di Azure AD

authContext

PublicClientApplication

Facoltativo PublicClientApplication dalla libreria di MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

Imposta le opzioni necessarie per configurare il metodo di autenticazione sas.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametri

getTokenCallback
getAuthTokenCallback

Funzione di callback responsabile della risoluzione di un token di autenticazione.

setSubscriptionKey(string)

Imposta le opzioni necessarie per configurare il meccanismo di autenticazione della chiave di sottoscrizione.

function setSubscriptionKey(key: string)

Parametri

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Imposta le opzioni necessarie per configurare il metodo di autenticazione anonimo.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametri

getTokenCallback
getAuthTokenCallback

Funzione di callback responsabile della risoluzione di un token di autenticazione.