AuthenticationOptions interface

  • Referência
Pacote:
azure-maps-control

Opções para especificar como o controlo de mapa deve ser autenticado com os serviços Azure Maps.

Extends
Options

Propriedades

aadAppId

O Azure AD ID da aplicação registada. Este é o ID da aplicação de uma aplicação registada no seu inquilino Azure AD. Tem de ser especificado para o tipo de autenticação do AAD.
aadInstance

A instância do AAD a utilizar para iniciar sessão. Opcionalmente, pode ser especificado ao utilizar o tipo de autenticação do AAD. Por predefinição, https://login.microsoftonline.com/ a instância será utilizada.
aadTenant

O inquilino do AAD que detém a aplicação registada especificada por aadAppId. Tem de ser especificado para o tipo de autenticação do AAD.
authContext

Opcionalmente, forneça um existente PublicClientApplication a partir da biblioteca de MSAL.js. Este contexto de autenticação será utilizado para adquirir o token do AAD. Utilizado apenas com o tipo de autenticação do AAD. Este contexto de autenticação tem de ser configurado para utilizar o mesmo ID de aplicação do AAD que this.aadAppId. Se não for fornecido, todas as instâncias de mapa partilharão o seu próprio contexto de autenticação privada.
authType

O mecanismo de autenticação a utilizar.
clientId

O ID de cliente Azure Maps, Este é um identificador exclusivo utilizado para identificar a conta de mapas. Preferível a ser sempre especificado, mas tem de ser especificado para o AAD e tipos de autenticação anónimos.
getToken

Uma chamada de retorno para utilizar com o mecanismo de autenticação anónimo/sas. Esta chamada de retorno será responsável por resolver um token de autenticação. Por exemplo, obter um token protegido por CORS a partir de um ponto final.
sasToken

Opcionalmente, forneça um token inicial para autenticação sas.
subscriptionKey

Chave de subscrição da sua conta Azure Maps. Tem de ser especificado para o tipo de autenticação da chave de subscrição.

Métodos

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

Define as opções de autenticação necessárias para configurar o mecanismo de concessão implícita do AAD.
setSasCallbackFunction(getAuthTokenCallback)

Define as opções necessárias para configurar o método de autenticação sas.
setSubscriptionKey(string)

Define as opções necessárias para configurar o mecanismo de autenticação da chave de subscrição.
setTokenCallbackFunction(getAuthTokenCallback)

Define as opções necessárias para configurar o método de autenticação anónimo.

Detalhes de Propriedade

aadAppId

O Azure AD ID da aplicação registada. Este é o ID da aplicação de uma aplicação registada no seu inquilino Azure AD. Tem de ser especificado para o tipo de autenticação do AAD.

aadAppId?: string

Valor de Propriedade

string

aadInstance

A instância do AAD a utilizar para iniciar sessão. Opcionalmente, pode ser especificado ao utilizar o tipo de autenticação do AAD. Por predefinição, https://login.microsoftonline.com/ a instância será utilizada.

aadInstance?: string

Valor de Propriedade

string

aadTenant

O inquilino do AAD que detém a aplicação registada especificada por aadAppId. Tem de ser especificado para o tipo de autenticação do AAD.

aadTenant?: string

Valor de Propriedade

string

authContext

Opcionalmente, forneça um existente PublicClientApplication a partir da biblioteca de MSAL.js. Este contexto de autenticação será utilizado para adquirir o token do AAD. Utilizado apenas com o tipo de autenticação do AAD. Este contexto de autenticação tem de ser configurado para utilizar o mesmo ID de aplicação do AAD que this.aadAppId. Se não for fornecido, todas as instâncias de mapa partilharão o seu próprio contexto de autenticação privada.

authContext?: PublicClientApplication

Valor de Propriedade

PublicClientApplication

authType

O mecanismo de autenticação a utilizar.

authType?: AuthenticationType

Valor de Propriedade

AuthenticationType

clientId

O ID de cliente Azure Maps, Este é um identificador exclusivo utilizado para identificar a conta de mapas. Preferível a ser sempre especificado, mas tem de ser especificado para o AAD e tipos de autenticação anónimos.

clientId?: string

Valor de Propriedade

string

getToken

Uma chamada de retorno para utilizar com o mecanismo de autenticação anónimo/sas. Esta chamada de retorno será responsável por resolver um token de autenticação. Por exemplo, obter um token protegido por CORS a partir de um ponto final.

getToken?: getAuthTokenCallback

Valor de Propriedade

getAuthTokenCallback

sasToken

Opcionalmente, forneça um token inicial para autenticação sas.

sasToken?: string

Valor de Propriedade

string

subscriptionKey

Chave de subscrição da sua conta Azure Maps. Tem de ser especificado para o tipo de autenticação da chave de subscrição.

subscriptionKey?: string

Valor de Propriedade

string

Detalhes de Método

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

Define as opções de autenticação necessárias para configurar o mecanismo de concessão implícita do AAD.

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

Parâmetros

clientId

string

ID de cliente da sua conta do Azure Maps

aadAppId

string

ID da Aplicação Azure AD

aadTenant

string

Nome do Inquilino do Azure AD

aadInstance

string

Uma Instância de Azure AD opcional

authContext

PublicClientApplication

PublicClientApplication Opcional a partir da biblioteca de MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

Define as opções necessárias para configurar o método de autenticação sas.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parâmetros

getTokenCallback
getAuthTokenCallback

Função de chamada de retorno responsável pela resolução para um token de autenticação.

setSubscriptionKey(string)

Define as opções necessárias para configurar o mecanismo de autenticação da chave de subscrição.

function setSubscriptionKey(key: string)

Parâmetros

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Define as opções necessárias para configurar o método de autenticação anónimo.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parâmetros

getTokenCallback
getAuthTokenCallback

Função de chamada de retorno responsável pela resolução para um token de autenticação.