Dela via

X509AuthenticationProvider class

  • Referens
Paket:
azure-iot-device

Tillhandahåller ett AuthenticationProvider objekt som kan skapas helt enkelt med ett X509-certifikat och en nyckel och sedan används av enhetsklienten och transporteras för att autentisera med Azure IoT Hub-instansen.

Till skillnad från objekten SharedAccessSignatureAuthenticationProvider och SharedAccessKeyAuthenticationProvider genererar X509AuthenticationProvider inte en newTokenAvailable händelse eftersom det inte finns någon token som ingår i X509-autentiseringen. Transporterna hämtar autentiseringsuppgifterna med hjälp av metoden getDeviceCredentials.

Egenskaper

type

Metoder

fromX509Options(string, string, X509)

Skapar en ny X509AuthenticationProvider från ett X509 objekt som innehåller ett certifikat och en nyckel.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)

Den här metoden används av transporterna för att hämta de senaste enhetsautentiseringsuppgifterna i form av ett TransportConfig objekt.
setX509Options(X509)

Uppdaterar certifikatet och nyckeln som används av enheten för att ansluta och autentisera med en Azure IoT Hub-instans.

Egenskapsinformation

type 

type: AuthenticationType

Egenskapsvärde

AuthenticationType

Metodinformation

fromX509Options(string, string, X509)

Skapar en ny X509AuthenticationProvider från ett X509 objekt som innehåller ett certifikat och en nyckel.

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

Parametrar

deviceId

string

Enhetsidentifieraren.

iotHubHostname

string

Värdnamnet för den Azure IoT Hub-instans som enheten ska ansluta till.

x509info

X509

Ett X509 objekt som innehåller ett certifikat och en nyckel som enheten kan använda för att autentisera med Azure IoT Hub-instansen.

Returer

X509AuthenticationProvider

getDeviceCredentials() 

function getDeviceCredentials(): Promise<TransportConfig>

Returer

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Den här metoden används av transporterna för att hämta de senaste enhetsautentiseringsuppgifterna i form av ett TransportConfig objekt.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parametrar

callback

Callback<TransportConfig>

valfri funktion som anropas med antingen ett fel eller en uppsättning autentiseringsuppgifter för enheten som kan användas för att autentisera med IoT-hubben.

setX509Options(X509)

Uppdaterar certifikatet och nyckeln som används av enheten för att ansluta och autentisera med en Azure IoT Hub-instans.

function setX509Options(x509: X509)

Parametrar

x509

X509

Det X509 objekt som innehåller certifikatet och nyckeln.