TokenProvider interface

Package:

@azure/amqp-common

Describes the base token provider.

Properties

tokenRenewalMarginInSeconds	The number of seconds within which it is good to renew the token. Default = 900 seconds (15 minutes).
tokenValidTimeInSeconds	The number of seconds for which the token is valid. Default = 3600 seconds (1 hour).

Methods

getToken(string)

Gets the token for the desired audience.

Property Details

tokenRenewalMarginInSeconds

The number of seconds within which it is good to renew the token. Default = 900 seconds (15 minutes).

tokenRenewalMarginInSeconds: number

Property Value

number

tokenValidTimeInSeconds

The number of seconds for which the token is valid. Default = 3600 seconds (1 hour).

tokenValidTimeInSeconds: number

Property Value

number

Method Details

getToken(string)

Gets the token for the desired audience.

function getToken(audience?: string): Promise<TokenInfo>

Parameters

audience

string

The audience for which the token is desired.

Returns

Promise<TokenInfo>