X509AuthenticationProvider class

Balíček:

azure-iot-device

Poskytuje AuthenticationProvider objekt, který lze vytvořit jednoduše pomocí certifikátu a klíče X509 a pak ho použije klient zařízení a přenáší k ověření v instanci azure IoT Hubu.

Na rozdíl od objektů SharedAccessSignatureAuthenticationProvider a SharedAccessKeyAuthenticationProviderX509AuthenticationProvider nevysílají newTokenAvailable událost, protože ověřování X509 neobsahuje žádný token. Přenosy získají přihlašovací údaje pomocí metody getDeviceCredentials.

Vlastnosti

type

Metody

fromX509Options(string, string, X509)	Vytvoří nový X509AuthenticationProvider z objektu X509 obsahujícího certifikát a klíč.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)	Tato metoda je používána přenosy k získání nejaktuálnějších přihlašovacích údajů zařízení ve formě TransportConfig objektu.
setX509Options(X509)	Aktualizuje certifikát a klíč používaný zařízením pro připojení a ověření pomocí instance azure IoT Hubu.

Podrobnosti vlastnosti

type

type: AuthenticationType

Hodnota vlastnosti

AuthenticationType

Podrobnosti metody

fromX509Options(string, string, X509)

Vytvoří nový X509AuthenticationProvider z objektu X509 obsahujícího certifikát a klíč.

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

Parametry

deviceId

string

Identifikátor zařízení.

iotHubHostname

string

Název hostitele instance azure IoT Hubu, ke které se má zařízení připojit.

x509info

X509

Objekt X509 obsahující certifikát a klíč, který může zařízení použít k ověření v instanci azure IoT Hubu.

Návraty

X509AuthenticationProvider

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

Návraty

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Tato metoda je používána přenosy k získání nejaktuálnějších přihlašovacích údajů zařízení ve formě TransportConfig objektu.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parametry

callback

Callback<TransportConfig>

volitelná funkce, která se bude volat s chybou nebo sadou přihlašovacích údajů zařízení, které se dají použít k ověření ve službě IoT Hub.

setX509Options(X509)

Aktualizuje certifikát a klíč používaný zařízením pro připojení a ověření pomocí instance azure IoT Hubu.

function setX509Options(x509: X509)

Parametry

x509

X509

Objekt X509 obsahující certifikát a klíč.