Class StorageSharedKeyCredentialPolicy

Package version

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

export
class: StorageSharedKeyCredentialPolicy
extends: {CredentialPolicy}

Hierarchy

CredentialPolicy
- StorageSharedKeyCredentialPolicy

Implements

RequestPolicy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StorageSharedKeyCredentialPolicy(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential): StorageSharedKeyCredentialPolicy

Overrides BaseRequestPolicy.constructor
- Defined in storage/storage-file-share/src/policies/StorageSharedKeyCredentialPolicy.ts:24
Creates an instance of StorageSharedKeyCredentialPolicy.

memberof

StorageSharedKeyCredentialPolicy

Parameters
- nextPolicy: RequestPolicy
- options: RequestPolicyOptions
- factory: StorageSharedKeyCredential
Returns StorageSharedKeyCredentialPolicy

Properties

_nextPolicy

_nextPolicy: RequestPolicy

_options

_options: RequestPolicyOptions

Methods

log

log(logLevel: HttpPipelineLogLevel, message: string): void

Inherited from BaseRequestPolicy.log
- Defined in core/core-http/es/lib/policies/requestPolicy.d.ts:31
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.

Parameters
- logLevel: HttpPipelineLogLevel
  
  The log level of this log.
- message: string
  
  The message of this log.
Returns void

sendRequest

sendRequest(request: WebResource): Promise<HttpOperationResponse>

Implementation of RequestPolicy.sendRequest

Inherited from CredentialPolicy.sendRequest

Overrides BaseRequestPolicy.sendRequest
- Defined in storage/storage-file-share/src/policies/CredentialPolicy.ts:23
Sends out request.

memberof

CredentialPolicy

Parameters
- request: WebResource
Returns Promise<HttpOperationResponse>

shouldLog

shouldLog(logLevel: HttpPipelineLogLevel): boolean

Inherited from BaseRequestPolicy.shouldLog
- Defined in core/core-http/es/lib/policies/requestPolicy.d.ts:24
Get whether or not a log with the provided log level should be logged.

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.

Protected signRequest

signRequest(request: WebResource): WebResource

Overrides CredentialPolicy.signRequest
- Defined in storage/storage-file-share/src/policies/StorageSharedKeyCredentialPolicy.ts:50
Signs request.

memberof

StorageSharedKeyCredentialPolicy

Parameters
- request: WebResource
Returns WebResource

Generated using TypeDoc