SubscriptionKeyCredentialPolicy class
SubscriptionKeyCredentialPolicy is a policy used to sign HTTP requests with a subscription key.
- Extends
Constructors
| Subscription |
Creates an instance of SubscriptionKeyCredentialPolicy. |
Inherited Methods
| log(Http |
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. |
| send |
Sends out request. |
| should |
Get whether or not a log with the provided log level should be logged. |
Constructor Details
SubscriptionKeyCredentialPolicy(RequestPolicy, RequestPolicyOptions, string)
Creates an instance of SubscriptionKeyCredentialPolicy.
new SubscriptionKeyCredentialPolicy(nextPolicy: RequestPolicy, options: RequestPolicyOptions, subscriptionKey: string)Parameters
- nextPolicy
-
RequestPolicy
- options
-
RequestPolicyOptions
- subscriptionKey
-
string
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 BaseRequestPolicy.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): booleanParameters
- 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