SharedKeyCredentialPolicy class

Package:

@azure/storage-file

SharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.

Extends

CredentialPolicy

Constructors

SharedKeyCredentialPolicy(RequestPolicy, RequestPolicyOptions, SharedKeyCredential)

Creates an instance of SharedKeyCredentialPolicy.

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

SharedKeyCredentialPolicy(RequestPolicy, RequestPolicyOptions, SharedKeyCredential)

Creates an instance of SharedKeyCredentialPolicy.

new SharedKeyCredentialPolicy(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: SharedKeyCredential)

Parameters

nextPolicy

RequestPolicy

options

RequestPolicyOptions

factory

SharedKeyCredential

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.

sendRequest(WebResource)

Sends out request.

function sendRequest(request: WebResource)

Parameters

request

WebResource

Returns

Promise<HttpOperationResponse>

shouldLog(HttpPipelineLogLevel)

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

function shouldLog(logLevel: HttpPipelineLogLevel)

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.