AuthenticationOptions interface

  • Referência
Pacote:
azure-maps-control

Opções para especificar como o controle de mapa deve se autenticar com os serviços Azure Mapas.

Extends
Options

Propriedades

aadAppId

O Azure AD ID do aplicativo registrado. Essa é a ID do aplicativo de um aplicativo registrado em seu locatário Azure AD. Deve ser especificado para o tipo de autenticação do AAD.
aadInstance

A instância do AAD a ser usada para fazer logon. Opcionalmente, pode ser especificado ao usar o tipo de autenticação do AAD. Por padrão, a https://login.microsoftonline.com/ instância será usada.
aadTenant

O locatário do AAD que possui o aplicativo registrado especificado por aadAppId. Deve ser especificado para o tipo de autenticação do AAD.
authContext

Opcionalmente, forneça um existente PublicClientApplication da biblioteca de MSAL.js. Esse contexto de autenticação será usado para adquirir o token do AAD. Usado somente com o tipo de autenticação do AAD. Esse contexto de autenticação deve ser configurado para usar a mesma ID de aplicativo do AAD que this.aadAppId. Se isso não for fornecido, todas as instâncias de mapa compartilharão seu próprio contexto de autenticação privada.
authType

O mecanismo de autenticação a ser usado.
clientId

A ID do cliente Azure Mapas, Este é um identificador exclusivo usado para identificar a conta de mapas. Preferimos sempre ser especificados, mas devem ser especificados para tipos de autenticação anônimos e do AAD.
getToken

Um retorno de chamada a ser usado com o mecanismo de autenticação anônimo/sas. Esse retorno de chamada será responsável por resolver um token de autenticação. Por exemplo, buscar um token protegido por CORS de um ponto de extremidade.
sasToken

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

Chave de assinatura da sua conta Azure Mapas. Deve ser especificado para o tipo de autenticação de chave de assinatura.

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 de chave de assinatura.
setTokenCallbackFunction(getAuthTokenCallback)

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

Detalhes da propriedade

aadAppId

O Azure AD ID do aplicativo registrado. Essa é a ID do aplicativo de um aplicativo registrado em seu locatário Azure AD. Deve ser especificado para o tipo de autenticação do AAD.

aadAppId?: string

Valor da propriedade

string

aadInstance

A instância do AAD a ser usada para fazer logon. Opcionalmente, pode ser especificado ao usar o tipo de autenticação do AAD. Por padrão, a https://login.microsoftonline.com/ instância será usada.

aadInstance?: string

Valor da propriedade

string

aadTenant

O locatário do AAD que possui o aplicativo registrado especificado por aadAppId. Deve ser especificado para o tipo de autenticação do AAD.

aadTenant?: string

Valor da propriedade

string

authContext

Opcionalmente, forneça um existente PublicClientApplication da biblioteca de MSAL.js. Esse contexto de autenticação será usado para adquirir o token do AAD. Usado somente com o tipo de autenticação do AAD. Esse contexto de autenticação deve ser configurado para usar a mesma ID de aplicativo do AAD que this.aadAppId. Se isso não for fornecido, todas as instâncias de mapa compartilharão seu próprio contexto de autenticação privada.

authContext?: PublicClientApplication

Valor da propriedade

PublicClientApplication

authType

O mecanismo de autenticação a ser usado.

authType?: AuthenticationType

Valor da propriedade

AuthenticationType

clientId

A ID do cliente Azure Mapas, Este é um identificador exclusivo usado para identificar a conta de mapas. Preferimos sempre ser especificados, mas devem ser especificados para tipos de autenticação anônimos e do AAD.

clientId?: string

Valor da propriedade

string

getToken

Um retorno de chamada a ser usado com o mecanismo de autenticação anônimo/sas. Esse retorno de chamada será responsável por resolver um token de autenticação. Por exemplo, buscar um token protegido por CORS de um ponto de extremidade.

getToken?: getAuthTokenCallback

Valor da propriedade

getAuthTokenCallback

sasToken

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

sasToken?: string

Valor da propriedade

string

subscriptionKey

Chave de assinatura da sua conta Azure Mapas. Deve ser especificado para o tipo de autenticação de chave de assinatura.

subscriptionKey?: string

Valor da propriedade

string

Detalhes do 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 do cliente da sua conta do Azure Mapas

aadAppId

string

ID do Aplicativo do Azure AD

aadTenant

string

Nome de Locatário do Azure AD

aadInstance

string

Uma instância de Azure AD opcional

authContext

PublicClientApplication

Um opcional PublicClientApplication 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 retorno de chamada responsável por resolver para um token de autenticação.

setSubscriptionKey(string)

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

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ônima.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parâmetros

getTokenCallback
getAuthTokenCallback

Função de retorno de chamada responsável por resolver para um token de autenticação.