Share via


X509AuthenticationProvider class

Stellt ein AuthenticationProvider Objekt bereit, das einfach mit einem X509-Zertifikat und -Schlüssel erstellt werden kann und dann vom Geräteclient und den Transporten zur Authentifizierung bei der Azure IoT Hub-Instanz verwendet wird.

Im Gegensatz zu den SharedAccessSignatureAuthenticationProvider - und SharedAccessKeyAuthenticationProvider -Objekten gibt kein X509AuthenticationProvider Ereignis aus newTokenAvailable , da kein Token an der X509-Authentifizierung beteiligt ist. Die Transporte rufen die Anmeldeinformationen mithilfe der getDeviceCredentials -Methode ab.

Eigenschaften

type

Methoden

fromX509Options(string, string, X509)

Erstellt eine neue X509AuthenticationProvider aus einem X509 -Objekt, das ein Zertifikat und einen Schlüssel enthält.

getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)

Diese Methode wird von den Transporten verwendet, um die aktuellsten Geräteanmeldeinformationen in Form eines TransportConfig -Objekts zu erhalten.

setX509Options(X509)

Aktualisierungen das Zertifikat und den Schlüssel, das vom Gerät zum Herstellen einer Verbindung und Authentifizierung mit einer Azure IoT Hub-Instanz verwendet wird.

Details zur Eigenschaft

type

type: AuthenticationType

Eigenschaftswert

AuthenticationType

Details zur Methode

fromX509Options(string, string, X509)

Erstellt eine neue X509AuthenticationProvider aus einem X509 -Objekt, das ein Zertifikat und einen Schlüssel enthält.

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

Parameter

deviceId

string

Der Gerätebezeichner.

iotHubHostname

string

Der Hostname der Azure IoT Hub-Instanz, mit der das Gerät eine Verbindung herstellen soll.

x509info

X509

Ein X509 Objekt, das ein Zertifikat und einen Schlüssel enthält, die das Gerät für die Authentifizierung bei der Azure IoT Hub-Instanz verwenden kann.

Gibt zurück

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

Gibt zurück

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Diese Methode wird von den Transporten verwendet, um die aktuellsten Geräteanmeldeinformationen in Form eines TransportConfig -Objekts zu erhalten.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parameter

callback

Callback<TransportConfig>

optionale Funktion, die entweder mit einem Fehler oder einer Gruppe von Geräteanmeldeinformationen aufgerufen wird, die zur Authentifizierung beim IoT Hub verwendet werden können.

setX509Options(X509)

Aktualisierungen das Zertifikat und den Schlüssel, das vom Gerät zum Herstellen einer Verbindung und Authentifizierung mit einer Azure IoT Hub-Instanz verwendet wird.

function setX509Options(x509: X509)

Parameter

x509

X509

Das X509 -Objekt, das das Zertifikat und den Schlüssel enthält.