X509AuthenticationProvider class

Pacote:

azure-iot-device

Fornece um AuthenticationProvider objeto que pode ser criado simplesmente com um certificado X509 e uma chave e, em seguida, é utilizado pelo cliente do dispositivo e transporta para autenticar com a instância do hub IoT do Azure.

Ao contrário dos SharedAccessSignatureAuthenticationProvider objetos e SharedAccessKeyAuthenticationProvider , o X509AuthenticationProvider não emite um evento, uma newTokenAvailable vez que não existe nenhum token envolvido na autenticação X509. Os transportes irão obter as credenciais com o getDeviceCredentials método .

Propriedades

type

Métodos

fromX509Options(string, string, X509)	Cria um novo a X509AuthenticationProvider partir de um X509 objeto que contém um certificado e uma chave.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)	Este método é utilizado pelos transportes para obter as credenciais de dispositivo mais atuais sob a forma de um TransportConfig objeto.
setX509Options(X509)	Atualizações o certificado e a chave utilizados pelo dispositivo para ligar e autenticar com uma instância do hub IoT do Azure.

Detalhes de Propriedade

type

type: AuthenticationType

Valor de Propriedade

AuthenticationType

Detalhes de Método

fromX509Options(string, string, X509)

Cria um novo a X509AuthenticationProvider partir de um X509 objeto que contém um certificado e uma chave.

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

Parâmetros

deviceId

string

O identificador do dispositivo.

iotHubHostname

string

O nome do anfitrião da instância do hub IoT do Azure a que o dispositivo deve ligar.

x509info

X509

Um X509 objeto que contém um certificado e uma chave que o dispositivo pode utilizar para autenticar com a instância do hub IoT do Azure.

Devoluções

X509AuthenticationProvider

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

Devoluções

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Este método é utilizado pelos transportes para obter as credenciais de dispositivo mais atuais sob a forma de um TransportConfig objeto.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parâmetros

callback

Callback<TransportConfig>

função opcional que será chamada com um erro ou um conjunto de credenciais do dispositivo que podem ser utilizadas para autenticar com o hub IoT.

setX509Options(X509)

Atualizações o certificado e a chave utilizados pelo dispositivo para ligar e autenticar com uma instância do hub IoT do Azure.

function setX509Options(x509: X509)

Parâmetros

x509

X509

O X509 objeto que contém o certificado e a chave.