Compartilhar via

X509AuthenticationProvider class

Pacote:
azure-iot-device

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

Ao contrário dos objetos SharedAccessSignatureAuthenticationProvider e SharedAccessKeyAuthenticationProvider, o X509AuthenticationProvider não emite um evento newTokenAvailable, pois não há nenhum token envolvido na autenticação X509. Os transportes obterão as credenciais usando o método getDeviceCredentials.

Propriedades

type

Métodos

fromX509Options(string, string, X509)

Cria um novo X509AuthenticationProvider de um objeto X509 que contém um certificado e uma chave.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)

Esse método é usado pelos transportes para obter as credenciais de dispositivo mais atuais na forma de um objeto TransportConfig.
setX509Options(X509)

Atualiza o certificado e a chave usados pelo dispositivo para se conectar e autenticar com uma instância do Hub IoT do Azure.

Detalhes da propriedade

type 

type: AuthenticationType

Valor da propriedade

AuthenticationType

Detalhes do método

fromX509Options(string, string, X509)

Cria um novo X509AuthenticationProvider de um objeto X509 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 host da instância do hub IoT do Azure à qual o dispositivo deve se conectar.

x509info

X509

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

Retornos

X509AuthenticationProvider

getDeviceCredentials() 

function getDeviceCredentials(): Promise<TransportConfig>

Retornos

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Esse método é usado pelos transportes para obter as credenciais de dispositivo mais atuais na forma de um objeto TransportConfig.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parâmetros

callback

Callback<TransportConfig>

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

setX509Options(X509)

Atualiza o certificado e a chave usados pelo dispositivo para se conectar e autenticar com uma instância do Hub IoT do Azure.

function setX509Options(x509: X509)

Parâmetros

x509

X509

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