TokenCredentialPolicy class

パッケージ:

azure-maps-rest

TokenCredentialPolicy は、トークンを使用して HTTP 要求に署名するために使用されるポリシーです。 OAuth ベアラー トークンなど。

Extends

CredentialPolicy

コンストラクター

TokenCredentialPolicy(RequestPolicy, RequestPolicyOptions, TokenCredential)

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

プロパティ

authorizationScheme	トークン承認スキーム。既定のヘッダーは "Bearer" です。
tokenCredential	トークンの値。

継承されたメソッド

log(HttpPipelineLogLevel, string)	指定されたメッセージを指定されたロガーにログに記録しようとします。 ロガーが指定されていない場合、またはログ レベルがロガーのしきい値を超えていない場合は、何もログに記録されません。
sendRequest(WebResource)	要求を送信します。
shouldLog(HttpPipelineLogLevel)	指定されたログ レベルのログをログに記録するかどうかを取得します。

コンストラクターの詳細

TokenCredentialPolicy(RequestPolicy, RequestPolicyOptions, TokenCredential)

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

new TokenCredentialPolicy(nextPolicy: RequestPolicy, options: RequestPolicyOptions, tokenCredential: TokenCredential)

パラメーター

nextPolicy

RequestPolicy

options

RequestPolicyOptions

tokenCredential

TokenCredential

プロパティの詳細

authorizationScheme

トークン承認スキーム。既定のヘッダーは "Bearer" です。

authorizationScheme: string

プロパティ値

string

tokenCredential

トークンの値。

tokenCredential: TokenCredential

プロパティ値

TokenCredential

継承済みメソッドの詳細

log(HttpPipelineLogLevel, string)

指定されたメッセージを指定されたロガーにログに記録しようとします。 ロガーが指定されていない場合、またはログ レベルがロガーのしきい値を超えていない場合は、何もログに記録されません。

function log(logLevel: HttpPipelineLogLevel, message: string)

パラメーター

logLevel

HttpPipelineLogLevel

このログのログ レベル。

message

string

このログのメッセージ。

継承元 BaseRequestPolicy.log

sendRequest(WebResource)

要求を送信します。

function sendRequest(request: WebResource): Promise<HttpOperationResponse>

パラメーター

request

WebResource

戻り値

Promise<HttpOperationResponse>

CredentialPolicy.sendRequestから継承

shouldLog(HttpPipelineLogLevel)

指定されたログ レベルのログをログに記録するかどうかを取得します。

function shouldLog(logLevel: HttpPipelineLogLevel): boolean

パラメーター

logLevel

HttpPipelineLogLevel

ログに記録されるログのログ レベル。

戻り値

boolean

指定されたログ レベルのログをログに記録するかどうか。

継承元 BaseRequestPolicy.shouldLog