TokenCredentialPolicy class
TokenCredentialPolicy は、トークンを使用して HTTP 要求に署名するために使用されるポリシーです。 OAuth ベアラー トークンなど。
- Extends
コンストラクター
Token |
TokenCredentialPolicy のインスタンスを作成します。 |
プロパティ
authorization |
トークン承認スキーム。既定のヘッダーは "Bearer" です。 |
token |
トークンの値。 |
継承されたメソッド
log(Http |
指定されたメッセージを指定されたロガーにログに記録しようとします。 ロガーが指定されていない場合、またはログ レベルがロガーのしきい値を超えていない場合は、何もログに記録されません。 |
send |
要求を送信します。 |
should |
指定されたログ レベルのログをログに記録するかどうかを取得します。 |
コンストラクターの詳細
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
継承済みメソッドの詳細
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>
shouldLog(HttpPipelineLogLevel)
指定されたログ レベルのログをログに記録するかどうかを取得します。
function shouldLog(logLevel: HttpPipelineLogLevel): boolean
パラメーター
- logLevel
-
HttpPipelineLogLevel
ログに記録されるログのログ レベル。
戻り値
boolean
指定されたログ レベルのログをログに記録するかどうか。
継承元 BaseRequestPolicy.shouldLog