MSIAppServiceTokenCredentials class

パッケージ:

@azure/ms-rest-nodeauth

App Service 環境でのマネージド サービス ID トークンの資格情報に関する情報を提供します。

Extends

MSITokenCredentials

コンストラクター

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

MSIAppServiceTokenCredentials のインスタンスを作成します。

プロパティ

clientId	トークンを使用するマネージド ID の clientId。 アプリ サービスにユーザー割り当てマネージド ID がある場合は必須です。
msiApiVersion	ローカル MSI エージェントの api バージョン。 デフォルト値は「2017-09-01」です。
msiEndpoint	アプリがトークンを要求できるローカル URL。 このプロパティが指定されていない限り、 IDENTITY_ENDPOINT または MSI_ENDPOINT の2つの環境変数のいずれかがデフォルト値として使用されます。
msiSecret	コードとローカル MSI エージェント間の通信に使用されるシークレット。 このプロパティが指定されていない限り、 IDENTITY_SECRET または MSI_SECRET の2つの環境変数のいずれかがデフォルト値として使用されます。

継承されたプロパティ

resource

Azure リソース エンドポイント。 既定では、環境から Azure Resource Manager:AzureCloud が使用されます。 「https://management.azure.com/" ServiceManagement (ASM) の場合: "https://management.core.windows.net/" Azure KeyVault の場合: "https://vault.azure.net" Azure Batch の場合: "https://batch.core.windows.net" Azure Active Directory Graph の場合: "https://graph.windows.net"

メソッド

getToken()

GET 要求を準備して、アクセス トークンで応答するアプリ サービス サービス エンドポイントに送信します。

継承されたメソッド

parseTokenResponse(string)	tokenResponse json 文字列をオブジェクトに解析し、最初のレベルのプロパティを camelCase に変換します。 このメソッドは tokenResponse の標準化を試みます
signRequest(WebResource)	Authentication ヘッダーを使用して要求に署名します。

コンストラクターの詳細

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

MSIAppServiceTokenCredentials のインスタンスを作成します。

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

パラメーター

options

MSIAppServiceOptions

プロパティの詳細

clientId

トークンを使用するマネージド ID の clientId。 アプリ サービスにユーザー割り当てマネージド ID がある場合は必須です。

clientId?: string

プロパティ値

string

msiApiVersion

ローカル MSI エージェントの api バージョン。 デフォルト値は「2017-09-01」です。

msiApiVersion?: string

プロパティ値

string

msiEndpoint

アプリがトークンを要求できるローカル URL。 このプロパティが指定されていない限り、 IDENTITY_ENDPOINT または MSI_ENDPOINT の2つの環境変数のいずれかがデフォルト値として使用されます。

msiEndpoint: string

プロパティ値

string

msiSecret

コードとローカル MSI エージェント間の通信に使用されるシークレット。 このプロパティが指定されていない限り、 IDENTITY_SECRET または MSI_SECRET の2つの環境変数のいずれかがデフォルト値として使用されます。

msiSecret: string

プロパティ値

string

継承されたプロパティの詳細

resource

Azure リソース エンドポイント。

• 既定では、環境から Azure Resource Manager:AzureCloud が使用されます。 「https://management.azure.com/"
• ServiceManagement (ASM) の場合: "https://management.core.windows.net/"
• Azure KeyVault の場合: "https://vault.azure.net"
• Azure Batch の場合: "https://batch.core.windows.net"
• Azure Active Directory Graph の場合: "https://graph.windows.net"

resource: string

プロパティ値

string

継承元:MSITokenCredentials.resource

メソッドの詳細

getToken()

GET 要求を準備して、アクセス トークンで応答するアプリ サービス サービス エンドポイントに送信します。

function getToken(): Promise<MSITokenResponse>

戻り値

Promise<MSITokenResponse>

tokenResponse(tokenTypeとaccessTokenは2つの重要なプロパティ)でPromiseします。

継承済みメソッドの詳細

parseTokenResponse(string)

tokenResponse json 文字列をオブジェクトに解析し、最初のレベルのプロパティを camelCase に変換します。 このメソッドは tokenResponse の標準化を試みます

function parseTokenResponse(body: string): TokenResponse

パラメーター

body

string

json 文字列

戻り値

TokenResponse

tokenResponse (tokenType と accessToken は 2 つの重要なプロパティです)。

MSITokenCredentials.parseTokenResponseから継承

signRequest(WebResource)

Authentication ヘッダーを使用して要求に署名します。

function signRequest(webResource: WebResource): Promise<WebResource>

パラメーター

webResource

WebResource

署名する WebResource。

戻り値

Promise<WebResource>

署名された WebResource を使用した Promise。

継承元:MSITokenCredentials.signRequest