AuthenticationOptions interface

Paket:

azure-maps-control

Optionen zum Angeben, wie sich das Kartensteuerelement bei den Azure Maps-Diensten authentifizieren soll.

Extends

Options

Eigenschaften

aadAppId	Die in Azure AD registrierte App-ID. Dies ist die App-ID einer App, die in Ihrem Azure AD-Mandanten registriert ist. Muss für den AAD-Authentifizierungstyp angegeben werden.
aadInstance	Der AAD-instance, der für die Anmeldung verwendet werden soll. Kann optional angegeben werden, wenn der AAD-Authentifizierungstyp verwendet wird. Standardmäßig wird die https://login.microsoftonline.com/ instance verwendet.
aadTenant	Der AAD-Mandant, dem die von aadAppIdangegebene registrierte App gehört. Muss für den AAD-Authentifizierungstyp angegeben werden.
authContext	Stellen Sie optional eine vorhandene PublicClientApplication aus der MSAL.js-Bibliothek bereit. Dieser Authentifizierungskontext wird verwendet, um das AAD-Token abzurufen. Wird nur mit dem AAD-Authentifizierungstyp verwendet. Dieser Authentifizierungskontext muss so konfiguriert sein, dass dieselbe AAD-App-ID wie this.aadAppIdverwendet wird. Wenn dies nicht angegeben ist, teilen alle Karteninstanzen ihren eigenen privaten Authentifizierungskontext.
authType	Der zu verwendende Authentifizierungsmechanismus.
clientId	Die Azure Maps Client-ID. Dies ist ein eindeutiger Bezeichner, der zum Identifizieren des Kartenkontos verwendet wird. Bevorzugt, um immer angegeben zu werden, muss aber für AAD- und anonyme Authentifizierungstypen angegeben werden.
getToken	Ein Rückruf, der mit dem anonymen/sas-Authentifizierungsmechanismus verwendet werden soll. Dieser Rückruf ist für die Auflösung in ein Authentifizierungstoken verantwortlich. Beispiel: Abrufen eines CORS-geschützten Tokens von einem Endpunkt.
sasToken	Stellen Sie optional ein Initialtoken für die sas-Authentifizierung bereit.
subscriptionKey	Abonnementschlüssel aus Ihrem Azure Maps-Konto. Muss für den Authentifizierungstyp des Abonnementschlüssels angegeben werden.

Methoden

setAadProperties(string, string, string, string, PublicClientApplication)	Legt die erforderlichen Authentifizierungsoptionen fest, um den impliziten AAD-Gewährungsmechanismus zu konfigurieren.
setSasCallbackFunction(getAuthTokenCallback)	Legt die erforderlichen Optionen zum Konfigurieren der sas-Authentifizierungsmethode fest.
setSubscriptionKey(string)	Legt die erforderlichen Optionen zum Konfigurieren des Authentifizierungsmechanismus für den Abonnementschlüssel fest.
setTokenCallbackFunction(getAuthTokenCallback)	Legt die erforderlichen Optionen zum Konfigurieren der anonymen Authentifizierungsmethode fest.

Details zur Eigenschaft

aadAppId

Die in Azure AD registrierte App-ID. Dies ist die App-ID einer App, die in Ihrem Azure AD-Mandanten registriert ist. Muss für den AAD-Authentifizierungstyp angegeben werden.

aadAppId?: string

Eigenschaftswert

string

aadInstance

Der AAD-instance, der für die Anmeldung verwendet werden soll. Kann optional angegeben werden, wenn der AAD-Authentifizierungstyp verwendet wird. Standardmäßig wird die https://login.microsoftonline.com/ instance verwendet.

aadInstance?: string

Eigenschaftswert

string

aadTenant

Der AAD-Mandant, dem die von aadAppIdangegebene registrierte App gehört. Muss für den AAD-Authentifizierungstyp angegeben werden.

aadTenant?: string

Eigenschaftswert

string

authContext

Stellen Sie optional eine vorhandene PublicClientApplication aus der MSAL.js-Bibliothek bereit. Dieser Authentifizierungskontext wird verwendet, um das AAD-Token abzurufen. Wird nur mit dem AAD-Authentifizierungstyp verwendet. Dieser Authentifizierungskontext muss so konfiguriert sein, dass dieselbe AAD-App-ID wie this.aadAppIdverwendet wird. Wenn dies nicht angegeben ist, teilen alle Karteninstanzen ihren eigenen privaten Authentifizierungskontext.

authContext?: PublicClientApplication

Eigenschaftswert

PublicClientApplication

authType

Der zu verwendende Authentifizierungsmechanismus.

authType?: AuthenticationType

Eigenschaftswert

AuthenticationType

clientId

Die Azure Maps Client-ID. Dies ist ein eindeutiger Bezeichner, der zum Identifizieren des Kartenkontos verwendet wird. Bevorzugt, um immer angegeben zu werden, muss aber für AAD- und anonyme Authentifizierungstypen angegeben werden.

clientId?: string

Eigenschaftswert

string

getToken

Ein Rückruf, der mit dem anonymen/sas-Authentifizierungsmechanismus verwendet werden soll. Dieser Rückruf ist für die Auflösung in ein Authentifizierungstoken verantwortlich. Beispiel: Abrufen eines CORS-geschützten Tokens von einem Endpunkt.

getToken?: getAuthTokenCallback

Eigenschaftswert

getAuthTokenCallback

sasToken

Stellen Sie optional ein Initialtoken für die sas-Authentifizierung bereit.

sasToken?: string

Eigenschaftswert

string

subscriptionKey

Abonnementschlüssel aus Ihrem Azure Maps-Konto. Muss für den Authentifizierungstyp des Abonnementschlüssels angegeben werden.

subscriptionKey?: string

Eigenschaftswert

string

Details zur Methode

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

Legt die erforderlichen Authentifizierungsoptionen fest, um den impliziten AAD-Gewährungsmechanismus zu konfigurieren.

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

Parameter

clientId

string

Client-ID aus Ihrem Azure Maps-Konto

aadAppId

string

Azure AD-App-ID

aadTenant

string

Name des Azure AD-Mandanten

aadInstance

string

Eine optionale Azure AD-Instanz

authContext

PublicClientApplication

PublicClientApplication Optional aus der MSAL.js-Bibliothek

setSasCallbackFunction(getAuthTokenCallback)

Legt die erforderlichen Optionen zum Konfigurieren der sas-Authentifizierungsmethode fest.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parameter

getTokenCallback

getAuthTokenCallback

Rückruffunktion, die für die Auflösung in ein Authentifizierungstoken verantwortlich ist.

setSubscriptionKey(string)

Legt die erforderlichen Optionen zum Konfigurieren des Authentifizierungsmechanismus für den Abonnementschlüssel fest.

function setSubscriptionKey(key: string)

Parameter

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Legt die erforderlichen Optionen zum Konfigurieren der anonymen Authentifizierungsmethode fest.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parameter

getTokenCallback

getAuthTokenCallback

Rückruffunktion, die für die Auflösung in ein Authentifizierungstoken verantwortlich ist.