Udostępnij za pośrednictwem

AuthenticationOptions interface

  • Odwołanie
Pakiet:
azure-maps-control

Opcje określania sposobu uwierzytelniania kontrolki mapy za pomocą usług Azure Maps.

Extends
Options

Właściwości

aadAppId

Identyfikator zarejestrowanej aplikacji Azure AD. Jest to identyfikator aplikacji zarejestrowanej w dzierżawie Azure AD. Musi być określony dla typu uwierzytelniania usługi AAD.
aadInstance

Wystąpienie usługi AAD do użycia do logowania. Opcjonalnie można określić przy użyciu typu uwierzytelniania usługi AAD. Domyślnie https://login.microsoftonline.com/ będzie używane wystąpienie.
aadTenant

Dzierżawa usługi AAD, która jest właścicielem zarejestrowanej aplikacji określonej przez aadAppIdusługę . Musi być określony dla typu uwierzytelniania usługi AAD.
authContext

Opcjonalnie podaj istniejący PublicClientApplication element z biblioteki MSAL.js. Ten kontekst uwierzytelniania będzie używany do uzyskiwania tokenu usługi AAD. Używane tylko z typem uwierzytelniania usługi AAD. Ten kontekst uwierzytelniania należy skonfigurować tak, aby używał tego samego identyfikatora aplikacji usługi AAD co this.aadAppId. Jeśli nie zostanie to podane, wszystkie wystąpienia mapy będą współużytkować własny prywatny kontekst uwierzytelniania.
authType

Mechanizm uwierzytelniania do użycia.
clientId

Identyfikator klienta Azure Maps jest unikatowym identyfikatorem używanym do identyfikowania konta map. Preferowane jest zawsze określenie, ale należy określić dla typów uwierzytelniania anonimowego i usługi AAD.
getToken

Wywołanie zwrotne do użycia z mechanizmem uwierzytelniania anonimowego/sas. To wywołanie zwrotne będzie odpowiedzialne za rozpoznawanie tokenu uwierzytelniania. Np. pobieranie tokenu chronionego przez mechanizm CORS z punktu końcowego.
sasToken

Opcjonalnie podaj początkowy token na potrzeby uwierzytelniania sas.
subscriptionKey

Klucz subskrypcji z konta Azure Maps. Należy określić typ uwierzytelniania klucza subskrypcji.

Metody

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

Ustawia wymagane opcje uwierzytelniania, aby skonfigurować niejawny mechanizm udzielania usługi AAD.
setSasCallbackFunction(getAuthTokenCallback)

Ustawia wymagane opcje konfigurowania metody uwierzytelniania sas.
setSubscriptionKey(string)

Ustawia wymagane opcje konfigurowania mechanizmu uwierzytelniania klucza subskrypcji.
setTokenCallbackFunction(getAuthTokenCallback)

Ustawia wymagane opcje konfigurowania metody uwierzytelniania anonimowego.

Szczegóły właściwości

aadAppId

Identyfikator zarejestrowanej aplikacji Azure AD. Jest to identyfikator aplikacji zarejestrowanej w dzierżawie Azure AD. Musi być określony dla typu uwierzytelniania usługi AAD.

aadAppId?: string

Wartość właściwości

string

aadInstance

Wystąpienie usługi AAD do użycia do logowania. Opcjonalnie można określić przy użyciu typu uwierzytelniania usługi AAD. Domyślnie https://login.microsoftonline.com/ będzie używane wystąpienie.

aadInstance?: string

Wartość właściwości

string

aadTenant

Dzierżawa usługi AAD, która jest właścicielem zarejestrowanej aplikacji określonej przez aadAppIdusługę . Musi być określony dla typu uwierzytelniania usługi AAD.

aadTenant?: string

Wartość właściwości

string

authContext

Opcjonalnie podaj istniejący PublicClientApplication element z biblioteki MSAL.js. Ten kontekst uwierzytelniania będzie używany do uzyskiwania tokenu usługi AAD. Używane tylko z typem uwierzytelniania usługi AAD. Ten kontekst uwierzytelniania należy skonfigurować tak, aby używał tego samego identyfikatora aplikacji usługi AAD co this.aadAppId. Jeśli nie zostanie to podane, wszystkie wystąpienia mapy będą współużytkować własny prywatny kontekst uwierzytelniania.

authContext?: PublicClientApplication

Wartość właściwości

PublicClientApplication

authType

Mechanizm uwierzytelniania do użycia.

authType?: AuthenticationType

Wartość właściwości

AuthenticationType

clientId

Identyfikator klienta Azure Maps jest unikatowym identyfikatorem używanym do identyfikowania konta map. Preferowane jest zawsze określenie, ale należy określić dla typów uwierzytelniania anonimowego i usługi AAD.

clientId?: string

Wartość właściwości

string

getToken

Wywołanie zwrotne do użycia z mechanizmem uwierzytelniania anonimowego/sas. To wywołanie zwrotne będzie odpowiedzialne za rozpoznawanie tokenu uwierzytelniania. Np. pobieranie tokenu chronionego przez mechanizm CORS z punktu końcowego.

getToken?: getAuthTokenCallback

Wartość właściwości

getAuthTokenCallback

sasToken

Opcjonalnie podaj początkowy token na potrzeby uwierzytelniania sas.

sasToken?: string

Wartość właściwości

string

subscriptionKey

Klucz subskrypcji z konta Azure Maps. Należy określić typ uwierzytelniania klucza subskrypcji.

subscriptionKey?: string

Wartość właściwości

string

Szczegóły metody

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

Ustawia wymagane opcje uwierzytelniania, aby skonfigurować niejawny mechanizm udzielania usługi AAD.

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

Parametry

clientId

string

Identyfikator klienta z konta usługi Azure Maps

aadAppId

string

identyfikator aplikacji Azure AD

aadTenant

string

nazwa dzierżawy Azure AD

aadInstance

string

Opcjonalne wystąpienie Azure AD

authContext

PublicClientApplication

Opcjonalne PublicClientApplication z biblioteki MSAL.js

setSasCallbackFunction(getAuthTokenCallback)

Ustawia wymagane opcje konfigurowania metody uwierzytelniania sas.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametry

getTokenCallback
getAuthTokenCallback

Funkcja wywołania zwrotnego odpowiedzialna za rozpoznawanie tokenu uwierzytelniania.

setSubscriptionKey(string)

Ustawia wymagane opcje konfigurowania mechanizmu uwierzytelniania klucza subskrypcji.

function setSubscriptionKey(key: string)

Parametry

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Ustawia wymagane opcje konfigurowania metody uwierzytelniania anonimowego.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametry

getTokenCallback
getAuthTokenCallback

Funkcja wywołania zwrotnego odpowiedzialna za rozpoznawanie tokenu uwierzytelniania.