AuthenticationOptions interface

Paket:

azure-maps-control

Harita denetiminin Azure Haritalar hizmetlerinde nasıl kimlik doğrulaması yapması gerektiğini belirtme seçenekleri.

Extends

Options

Özellikler

aadAppId	Kayıtlı Azure AD uygulama kimliği. Bu, Azure AD kiracınızda kayıtlı bir uygulamanın uygulama kimliğidir. AAD kimlik doğrulama türü için belirtilmelidir.
aadInstance	Oturum açmak için kullanılacak AAD örneği. AAD kimlik doğrulama türü kullanılırken isteğe bağlı olarak belirtilebilir. Varsayılan olarak https://login.microsoftonline.com/ örnek kullanılır.
aadTenant	tarafından aadAppIdbelirtilen kayıtlı uygulamaya sahip olan AAD kiracısı. AAD kimlik doğrulama türü için belirtilmelidir.
authContext	İsteğe bağlı olarak, MSAL.js kitaplığından var olan PublicClientApplication birini sağlayın. Bu kimlik doğrulama bağlamı AAD belirtecini almak için kullanılır. Yalnızca AAD kimlik doğrulama türüyle kullanılır. Bu kimlik doğrulama bağlamı ile aynı AAD uygulama kimliğini this.aadAppIdkullanacak şekilde yapılandırılmalıdır. Bu sağlanmazsa tüm harita örnekleri kendi özel kimlik doğrulama bağlamlarını paylaşır.
authType	Kullanılacak kimlik doğrulama mekanizması.
clientId	Azure Haritalar istemci kimliği olan Bu, haritalar hesabını tanımlamak için kullanılan benzersiz bir tanımlayıcıdır. Her zaman belirtilmesi tercih edilir, ancak AAD ve anonim kimlik doğrulama türleri için belirtilmelidir.
getToken	Anonim/sas kimlik doğrulama mekanizmasıyla kullanılacak bir geri çağırma. Bu geri çağırma, kimlik doğrulama belirtecini çözümlemek için sorumludur. Örneğin, bir uç noktadan CORS korumalı belirteç getirme.
sasToken	İsteğe bağlı olarak sas kimlik doğrulaması için bir başlangıç belirteci sağlayın.
subscriptionKey	Azure Haritalar hesabınızdaki abonelik anahtarı. Abonelik anahtarı kimlik doğrulama türü için belirtilmelidir.

Yöntemler

setAadProperties(string, string, string, string, PublicClientApplication)	AAD örtük verme mekanizmasını yapılandırmak için gerekli kimlik doğrulama seçeneklerini ayarlar.
setSasCallbackFunction(getAuthTokenCallback)	Sas kimlik doğrulama yöntemini yapılandırmak için gerekli seçenekleri ayarlar.
setSubscriptionKey(string)	Abonelik anahtarı kimlik doğrulama mekanizmasını yapılandırmak için gerekli seçenekleri ayarlar.
setTokenCallbackFunction(getAuthTokenCallback)	Anonim kimlik doğrulama yöntemini yapılandırmak için gerekli seçenekleri ayarlar.

Özellik Ayrıntıları

aadAppId

Kayıtlı Azure AD uygulama kimliği. Bu, Azure AD kiracınızda kayıtlı bir uygulamanın uygulama kimliğidir. AAD kimlik doğrulama türü için belirtilmelidir.

aadAppId?: string

Özellik Değeri

string

aadInstance

Oturum açmak için kullanılacak AAD örneği. AAD kimlik doğrulama türü kullanılırken isteğe bağlı olarak belirtilebilir. Varsayılan olarak https://login.microsoftonline.com/ örnek kullanılır.

aadInstance?: string

Özellik Değeri

string

aadTenant

tarafından aadAppIdbelirtilen kayıtlı uygulamaya sahip olan AAD kiracısı. AAD kimlik doğrulama türü için belirtilmelidir.

aadTenant?: string

Özellik Değeri

string

authContext

İsteğe bağlı olarak, MSAL.js kitaplığından var olan PublicClientApplication birini sağlayın. Bu kimlik doğrulama bağlamı AAD belirtecini almak için kullanılır. Yalnızca AAD kimlik doğrulama türüyle kullanılır. Bu kimlik doğrulama bağlamı ile aynı AAD uygulama kimliğini this.aadAppIdkullanacak şekilde yapılandırılmalıdır. Bu sağlanmazsa tüm harita örnekleri kendi özel kimlik doğrulama bağlamlarını paylaşır.

authContext?: PublicClientApplication

Özellik Değeri

PublicClientApplication

authType

Kullanılacak kimlik doğrulama mekanizması.

authType?: AuthenticationType

Özellik Değeri

AuthenticationType

clientId

Azure Haritalar istemci kimliği olan Bu, haritalar hesabını tanımlamak için kullanılan benzersiz bir tanımlayıcıdır. Her zaman belirtilmesi tercih edilir, ancak AAD ve anonim kimlik doğrulama türleri için belirtilmelidir.

clientId?: string

Özellik Değeri

string

getToken

Anonim/sas kimlik doğrulama mekanizmasıyla kullanılacak bir geri çağırma. Bu geri çağırma, kimlik doğrulama belirtecini çözümlemek için sorumludur. Örneğin, bir uç noktadan CORS korumalı belirteç getirme.

getToken?: getAuthTokenCallback

Özellik Değeri

getAuthTokenCallback

sasToken

İsteğe bağlı olarak sas kimlik doğrulaması için bir başlangıç belirteci sağlayın.

sasToken?: string

Özellik Değeri

string

subscriptionKey

Azure Haritalar hesabınızdaki abonelik anahtarı. Abonelik anahtarı kimlik doğrulama türü için belirtilmelidir.

subscriptionKey?: string

Özellik Değeri

string

Yöntem Ayrıntıları

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

AAD örtük verme mekanizmasını yapılandırmak için gerekli kimlik doğrulama seçeneklerini ayarlar.

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

Parametreler

clientId

string

Azure haritalar hesabınızdaki istemci kimliği

aadAppId

string

uygulama kimliğini Azure AD

aadTenant

string

Azure AD Kiracı Adı

aadInstance

string

İsteğe bağlı bir Azure AD Örneği

authContext

PublicClientApplication

MSAL.js kitaplığından isteğe bağlı PublicClientApplication

setSasCallbackFunction(getAuthTokenCallback)

Sas kimlik doğrulama yöntemini yapılandırmak için gerekli seçenekleri ayarlar.

function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametreler

getTokenCallback

getAuthTokenCallback

Kimlik doğrulama belirtecini çözümlemeden sorumlu geri çağırma işlevi.

setSubscriptionKey(string)

Abonelik anahtarı kimlik doğrulama mekanizmasını yapılandırmak için gerekli seçenekleri ayarlar.

function setSubscriptionKey(key: string)

Parametreler

key

string

setTokenCallbackFunction(getAuthTokenCallback)

Anonim kimlik doğrulama yöntemini yapılandırmak için gerekli seçenekleri ayarlar.

function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)

Parametreler

getTokenCallback

getAuthTokenCallback

Kimlik doğrulama belirtecini çözümlemeden sorumlu geri çağırma işlevi.