Package version:

Class CredentialPolicy`Abstract`

Credential policy used to sign HTTP(S) requests before sending. This is an abstract class.

Hierarchy (view full)

BaseRequestPolicy
- CredentialPolicy
  - AnonymousCredentialPolicy
  - StorageSharedKeyCredentialPolicy

Index

Constructors

Properties

_nextPolicy _options

Methods

log sendRequest shouldLog signRequest

Constructors

`Protected`constructor

new CredentialPolicy(_nextPolicy, _options): CredentialPolicy
The main method to implement that manipulates a request/response.
Parameters
- _nextPolicy: RequestPolicy
  The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
- _options: RequestPolicyOptionsLike
  The options that can be passed to a given request policy.
Returns CredentialPolicy
Inherited from BaseRequestPolicy.constructor
- Defined in policies/RequestPolicy.ts:19

Properties

`Readonly`_nextPolicy

_nextPolicy: RequestPolicy

The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.

`Readonly`_options

_options: RequestPolicyOptionsLike

The options that can be passed to a given request policy.

Methods

log

log(logLevel, message): void
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
Inherited from BaseRequestPolicy.log
- Defined in policies/RequestPolicy.ts:51

sendRequest

sendRequest(request): Promise<HttpOperationResponse>
Sends out request.
Parameters
- request: WebResource
Returns Promise<HttpOperationResponse>
Overrides BaseRequestPolicy.sendRequest
- Defined in policies/CredentialPolicy.ts:20

shouldLog

shouldLog(logLevel): boolean
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.
Inherited from BaseRequestPolicy.shouldLog
- Defined in policies/RequestPolicy.ts:41

`Protected`signRequest

signRequest(request): WebResource
Child classes must implement this method with request signing. This method will be executed in sendRequest.
Parameters
- request: WebResource
Returns WebResource
- Defined in policies/CredentialPolicy.ts:30