Share via

RequestPolicyOptions class

  • Reference
Package:
@azure/ms-rest-js

Optional properties that can be used when creating a RequestPolicy.

Constructors

RequestPolicyOptions(HttpPipelineLogger)

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.
shouldLog(HttpPipelineLogLevel)

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

Constructor Details

RequestPolicyOptions(HttpPipelineLogger) 

new RequestPolicyOptions(_logger?: HttpPipelineLogger)

Parameters

_logger
HttpPipelineLogger

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.

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.