Share via

X509AuthenticationProvider class

  • Référence
Paquet:
azure-iot-device

Fournit un AuthenticationProvider objet qui peut être créé simplement avec un certificat et une clé X509, puis qui est utilisé par le client d’appareil et transporte pour s’authentifier auprès de l’instance Azure IoT Hub.

SharedAccessSignatureAuthenticationProvider Contrairement aux objets etSharedAccessKeyAuthenticationProvider, n’émet X509AuthenticationProvider pas d’événementnewTokenAvailable, car aucun jeton n’est impliqué dans l’authentification X509. Les transports obtiennent les informations d’identification à l’aide de la getDeviceCredentials méthode .

Propriétés

type

Méthodes

fromX509Options(string, string, X509)

Crée un nouveau X509AuthenticationProvider à partir d’un X509 objet contenant un certificat et une clé.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)

Cette méthode est utilisée par les transports pour obtenir les informations d’identification d’appareil les plus actuelles sous la forme d’un TransportConfig objet.
setX509Options(X509)

Mises à jour le certificat et la clé utilisés par l’appareil pour se connecter et s’authentifier auprès d’une instance Azure IoT Hub.

Détails de la propriété

type 

type: AuthenticationType

Valeur de propriété

AuthenticationType

Détails de la méthode

fromX509Options(string, string, X509)

Crée un nouveau X509AuthenticationProvider à partir d’un X509 objet contenant un certificat et une clé.

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

Paramètres

deviceId

string

Identificateur de l’appareil.

iotHubHostname

string

Nom d’hôte de l’instance Azure IoT Hub à laquelle l’appareil doit se connecter.

x509info

X509

Objet X509 contenant un certificat et une clé que l’appareil peut utiliser pour s’authentifier auprès de l’instance Azure IoT Hub.

Retours

X509AuthenticationProvider

getDeviceCredentials() 

function getDeviceCredentials(): Promise<TransportConfig>

Retours

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Cette méthode est utilisée par les transports pour obtenir les informations d’identification d’appareil les plus actuelles sous la forme d’un TransportConfig objet.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Paramètres

callback

Callback<TransportConfig>

fonction facultative qui sera appelée avec une erreur ou un ensemble d’informations d’identification d’appareil qui peuvent être utilisées pour l’authentification auprès du hub IoT.

setX509Options(X509)

Mises à jour le certificat et la clé utilisés par l’appareil pour se connecter et s’authentifier auprès d’une instance Azure IoT Hub.

function setX509Options(x509: X509)

Paramètres

x509

X509

Objet X509 contenant le certificat et la clé.