Share via

AuthenticationProvider interface

  • Reference
Package:
azure-iot-common

Interface that must be implemented by objects that are used to provide credentials to the transports used by the device client to authenticate with an Azure IoT hub instance.

Properties

type

Methods

getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)
setTokenRenewalValues(number, number)

Property Details

type 

type: AuthenticationType

Property Value

AuthenticationType

Method Details

getDeviceCredentials() 

function getDeviceCredentials(): Promise<TransportConfig>

Returns

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>) 

function getDeviceCredentials(callback: Callback<TransportConfig>)

Parameters

callback

Callback<TransportConfig>

setTokenRenewalValues(number, number) 

function setTokenRenewalValues(tokenValidTimeInSeconds: number, tokenRenewalMarginInSeconds: number)

Parameters

tokenValidTimeInSeconds

number

tokenRenewalMarginInSeconds

number