TokenCredentialPolicy class

Package:

@azure/storage-queue

TokenCredentialPolicy is a policy used to sign HTTP request with a token. Such as an OAuth bearer token.

Extends

CredentialPolicy

Constructors

TokenCredentialPolicy(RequestPolicy, RequestPolicyOptions, TokenCredential)

Creates an instance of TokenCredentialPolicy.

Properties

authorizationScheme	Token authorization scheme, default header is "Bearer".
tokenCredential	The value of token.

Inherited Methods

log(HttpPipelineLogLevel, string)	Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.
sendRequest(WebResource)	Sends out request.
shouldLog(HttpPipelineLogLevel)	Get whether or not a log with the provided log level should be logged.

Constructor Details

TokenCredentialPolicy(RequestPolicy, RequestPolicyOptions, TokenCredential)

Creates an instance of TokenCredentialPolicy.

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

Parameters

nextPolicy

RequestPolicy

options

RequestPolicyOptions

tokenCredential

TokenCredential

Property Details

authorizationScheme

Token authorization scheme, default header is "Bearer".

authorizationScheme: string

Property Value

string

tokenCredential

The value of token.

tokenCredential: TokenCredential

Property Value

TokenCredential

Inherited Method Details

log(HttpPipelineLogLevel, string)

Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.

function log(logLevel: HttpPipelineLogLevel, message: string)

Parameters

logLevel

HttpPipelineLogLevel

The log level of this log.

message

string

The message of this log.

Inherited From CredentialPolicy.log

sendRequest(WebResource)

Sends out request.

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

Parameters

request

WebResource

Returns

Promise<HttpOperationResponse>

Inherited From CredentialPolicy.sendRequest

shouldLog(HttpPipelineLogLevel)

Get whether or not a log with the provided log level should be logged.

function shouldLog(logLevel: HttpPipelineLogLevel): boolean

Parameters

logLevel

HttpPipelineLogLevel

The log level of the log that will be logged.

Returns

boolean

Whether or not a log with the provided log level should be logged.

Inherited From CredentialPolicy.shouldLog