Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BearerTokenAuthenticationPolicy

Package version

Provides a RequestPolicy that can request a token from a TokenCredential implementation and then apply it to the Authorization header of a request as a Bearer token.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new BearerTokenAuthenticationPolicy object.

    Parameters

    • nextPolicy: RequestPolicy

      The next RequestPolicy in the request pipeline.

    • options: RequestPolicyOptions

      Options for this RequestPolicy.

    • credential: TokenCredential

      The TokenCredential implementation that can supply the bearer token.

    • scopes: string | string[]

      The scopes for which the bearer token applies.

    • tokenCache: AccessTokenCache

      The cache for the most recent AccessToken returned from the TokenCredential.

    Returns BearerTokenAuthenticationPolicy

Properties

_nextPolicy

_nextPolicy: RequestPolicy

_options

Methods

log

  • 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

shouldLog

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

    Parameters

    Returns boolean

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

Generated using TypeDoc