AuthenticationOptions interface
Azure Maps サービスでマップ コントロールを認証する方法を指定するためのオプション。
- Extends
プロパティ
| aad |
Azure AD 登録済みアプリ ID。 これは、Azure AD テナントに登録されているアプリのアプリ ID です。 AAD 認証の種類に指定する必要があります。 |
| aad |
ログインに使用する AAD インスタンス。
AAD 認証の種類を使用する場合は、必要に応じて指定できます。
既定では、 |
| aad |
で |
| auth |
必要に応じて、MSAL.js ライブラリから既存 |
| auth |
使用する認証メカニズム。 |
| client |
Azure Mapsクライアント ID。これは、マップ アカウントを識別するために使用される一意の識別子です。 常に指定することをお勧めしますが、AAD 認証の種類と匿名認証の種類に指定する必要があります。 |
| get |
匿名/sas 認証メカニズムで使用するコールバック。 このコールバックは、認証トークンへの解決を担当します。 たとえば、エンドポイントから CORS で保護されたトークンをフェッチします。 |
| sas |
必要に応じて、sas 認証用の初期トークンを指定します。 |
| subscription |
Azure Maps アカウントのサブスクリプション キー。 サブスクリプション キーの認証の種類に指定する必要があります。 |
メソッド
| set |
AAD 暗黙的な許可メカニズムを構成するために必要な認証オプションを設定します。 |
| set |
sas 認証方法を構成するために必要なオプションを設定します。 |
| set |
サブスクリプション キー認証メカニズムを構成するために必要なオプションを設定します。 |
| set |
匿名認証方法を構成するために必要なオプションを設定します。 |
プロパティの詳細
aadAppId
Azure AD 登録済みアプリ ID。 これは、Azure AD テナントに登録されているアプリのアプリ ID です。 AAD 認証の種類に指定する必要があります。
aadAppId?: stringプロパティ値
string
aadInstance
ログインに使用する AAD インスタンス。
AAD 認証の種類を使用する場合は、必要に応じて指定できます。
既定では、 https://login.microsoftonline.com/ インスタンスが使用されます。
aadInstance?: stringプロパティ値
string
aadTenant
で aadAppId指定された登録済みアプリを所有する AAD テナント。
AAD 認証の種類に指定する必要があります。
aadTenant?: stringプロパティ値
string
authContext
必要に応じて、MSAL.js ライブラリから既存 PublicClientApplication のものを指定します。
この認証コンテキストは、AAD トークンを取得するために使用されます。
AAD 認証の種類でのみ使用されます。
この認証コンテキストは、 と同じ AAD アプリ ID を this.aadAppId使用するように構成する必要があります。
これが指定されていない場合、すべてのマップ インスタンスは独自のプライベート認証コンテキストを共有します。
authContext?: PublicClientApplicationプロパティ値
PublicClientApplication
authType
clientId
Azure Mapsクライアント ID。これは、マップ アカウントを識別するために使用される一意の識別子です。 常に指定することをお勧めしますが、AAD 認証の種類と匿名認証の種類に指定する必要があります。
clientId?: stringプロパティ値
string
getToken
匿名/sas 認証メカニズムで使用するコールバック。 このコールバックは、認証トークンへの解決を担当します。 たとえば、エンドポイントから CORS で保護されたトークンをフェッチします。
getToken?: getAuthTokenCallbackプロパティ値
sasToken
必要に応じて、sas 認証用の初期トークンを指定します。
sasToken?: stringプロパティ値
string
subscriptionKey
Azure Maps アカウントのサブスクリプション キー。 サブスクリプション キーの認証の種類に指定する必要があります。
subscriptionKey?: stringプロパティ値
string
メソッドの詳細
setAadProperties(string, string, string, string, PublicClientApplication)
AAD 暗黙的な許可メカニズムを構成するために必要な認証オプションを設定します。
function setAadProperties(clientId: string, aadAppId: string, aadTenant: string, aadInstance?: string, authContext?: PublicClientApplication)パラメーター
- clientId
-
string
Azure Maps アカウントからのクライアント ID
- aadAppId
-
string
Azure AD App ID (Azure AD アプリ ID)
- aadTenant
-
string
Azure AD Tenant Name (Azure AD テナント名)
- aadInstance
-
string
オプションの Azure AD インスタンス
- authContext
-
PublicClientApplication
MSAL.js ライブラリからの省略可能なPublicClientApplication
setSasCallbackFunction(getAuthTokenCallback)
sas 認証方法を構成するために必要なオプションを設定します。
function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)パラメーター
- getTokenCallback
- getAuthTokenCallback
認証トークンへの解決を担当するコールバック関数。
setSubscriptionKey(string)
サブスクリプション キー認証メカニズムを構成するために必要なオプションを設定します。
function setSubscriptionKey(key: string)パラメーター
- key
-
string
setTokenCallbackFunction(getAuthTokenCallback)
匿名認証方法を構成するために必要なオプションを設定します。
function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)パラメーター
- getTokenCallback
- getAuthTokenCallback
認証トークンへの解決を担当するコールバック関数。