X509AuthenticationProvider class

Pakket:

azure-iot-device

Biedt een AuthenticationProvider object dat eenvoudig kan worden gemaakt met een X509-certificaat en -sleutel en dat vervolgens wordt gebruikt door de apparaatclient en transporteert voor verificatie met het Azure IoT Hub-exemplaar.

In tegenstelling tot de SharedAccessSignatureAuthenticationProvider objecten en SharedAccessKeyAuthenticationProvider verzendt newTokenAvailable de X509AuthenticationProvider geen gebeurtenis omdat er geen token is betrokken bij X509-verificatie. De transporten krijgen de referenties op met behulp van de getDeviceCredentials methode .

Eigenschappen

type

Methoden

fromX509Options(string, string, X509)	Hiermee maakt u een nieuw X509AuthenticationProviderX509 object met een certificaat en sleutel.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)	Deze methode wordt door de transporten gebruikt om de meest recente apparaatreferenties op te halen in de vorm van een TransportConfig -object.
setX509Options(X509)	Updates het certificaat en de sleutel die door het apparaat worden gebruikt om verbinding te maken en te verifiëren met een Azure IoT Hub-exemplaar.

Eigenschapdetails

type

type: AuthenticationType

Waarde van eigenschap

AuthenticationType

Methodedetails

fromX509Options(string, string, X509)

Hiermee maakt u een nieuw X509AuthenticationProviderX509 object met een certificaat en sleutel.

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

Parameters

deviceId

string

De apparaat-id.

iotHubHostname

string

De hostnaam van het Azure IoT Hub-exemplaar waarmee het apparaat verbinding moet maken.

x509info

X509

Een X509 object met een certificaat en sleutel die het apparaat kan gebruiken voor verificatie met het Azure IoT Hub-exemplaar.

Retouren

X509AuthenticationProvider

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

Retouren

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Deze methode wordt door de transporten gebruikt om de meest recente apparaatreferenties op te halen in de vorm van een TransportConfig -object.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parameters

callback

Callback<TransportConfig>

optionele functie die wordt aangeroepen met een fout of een set apparaatreferenties die kunnen worden gebruikt voor verificatie met de IoT-hub.

setX509Options(X509)

Updates het certificaat en de sleutel die door het apparaat worden gebruikt om verbinding te maken en te verifiëren met een Azure IoT Hub-exemplaar.

function setX509Options(x509: X509)

Parameters

x509

X509

Het X509 object dat het certificaat en de sleutel bevat.