X509AuthenticationProvider class

Paquete:

azure-iot-device

Proporciona un AuthenticationProvider objeto que se puede crear simplemente con un certificado y una clave X509 y, a continuación, lo usa el cliente del dispositivo y los transportes para autenticarse con la instancia de Azure IoT Hub.

A diferencia de los SharedAccessSignatureAuthenticationProvider objetos y SharedAccessKeyAuthenticationProvider , no X509AuthenticationProvider emite un newTokenAvailable evento, ya que no hay ningún token implicado en la autenticación X509. Los transportes obtendrán las credenciales mediante el getDeviceCredentials método .

Propiedades

type

Métodos

fromX509Options(string, string, X509)	Crea un objeto a X509AuthenticationProvider partir de un X509 objeto que contiene un certificado y una clave.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)	El transporte usa este método para obtener las credenciales de dispositivo más actuales en forma de objeto TransportConfig .
setX509Options(X509)	Novedades el certificado y la clave que usa el dispositivo para conectarse y autenticarse con una instancia de Azure IoT Hub.

Detalles de las propiedades

type

type: AuthenticationType

Valor de propiedad

AuthenticationType

Detalles del método

fromX509Options(string, string, X509)

Crea un objeto a X509AuthenticationProvider partir de un X509 objeto que contiene un certificado y una clave.

static function fromX509Options(deviceId: string, iotHubHostname: string, x509info: X509): X509AuthenticationProvider

Parámetros

deviceId

string

Identificador del dispositivo.

iotHubHostname

string

El nombre de host de la instancia de Azure IoT Hub al que debe conectarse el dispositivo.

x509info

X509

Objeto X509 que contiene un certificado y una clave que el dispositivo puede usar para autenticarse con la instancia de Azure IoT Hub.

Devoluciones

X509AuthenticationProvider

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

Devoluciones

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

El transporte usa este método para obtener las credenciales de dispositivo más actuales en forma de objeto TransportConfig .

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parámetros

callback

Callback<TransportConfig>

función opcional a la que se llamará con un error o un conjunto de credenciales de dispositivo que se pueden usar para autenticarse con el centro de IoT.

setX509Options(X509)

Novedades el certificado y la clave que usa el dispositivo para conectarse y autenticarse con una instancia de Azure IoT Hub.

function setX509Options(x509: X509)

Parámetros

x509

X509

Objeto X509 que contiene el certificado y la clave.