Freigeben über


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 Transporten zur Authentifizierung bei der Azure IoT-Hubinstanz verwendet wird.

Im Gegensatz zu den objekten SharedAccessSignatureAuthenticationProvider und SharedAccessKeyAuthenticationProvider gibt die X509AuthenticationProvider kein newTokenAvailable Ereignis aus, 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)

Aktualisiert das Zertifikat und den Schlüssel, das vom Gerät zum Herstellen einer Verbindung und Authentifizierung mit einer Azure IoT-Hubinstanz 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-Hubinstanz, mit der das Gerät eine Verbindung herstellen soll.

x509info

X509

Ein X509-Objekt, das ein Zertifikat und einen Schlüssel enthält, mit dem das Gerät sich bei der Azure IoT-Hubinstanz authentifizieren 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 Reihe von Geräteanmeldeinformationen aufgerufen wird, die zum Authentifizieren beim IoT-Hub verwendet werden können.

setX509Options(X509)

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

function setX509Options(x509: X509)

Parameter

x509

X509

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