X509AuthenticationProvider class

Pakiet:

azure-iot-device

Udostępnia obiekt AuthenticationProvider, który można utworzyć po prostu przy użyciu certyfikatu i klucza X509, a następnie jest używany przez klienta urządzenia i transportuje do uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.

W przeciwieństwie do obiektów SharedAccessSignatureAuthenticationProvider i SharedAccessKeyAuthenticationProviderX509AuthenticationProvider nie emituje zdarzenia newTokenAvailable, ponieważ nie ma tokenu związanego z uwierzytelnianiem X509. Transporty otrzymają poświadczenia przy użyciu metody getDeviceCredentials.

Właściwości

type

Metody

fromX509Options(string, string, X509)	Tworzy nowy X509AuthenticationProvider z obiektu X509 zawierającego certyfikat i klucz.
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)	Ta metoda jest używana przez transporty w celu uzyskania najbardziej aktualnych poświadczeń urządzenia w postaci obiektu TransportConfig.
setX509Options(X509)	Aktualizuje certyfikat i klucz używany przez urządzenie do nawiązywania połączenia i uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.

Szczegóły właściwości

type

type: AuthenticationType

Wartość właściwości

AuthenticationType

Szczegóły metody

fromX509Options(string, string, X509)

Tworzy nowy X509AuthenticationProvider z obiektu X509 zawierającego certyfikat i klucz.

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

Parametry

deviceId

string

Identyfikator urządzenia.

iotHubHostname

string

Nazwa hosta wystąpienia usługi Azure IoT Hub, z którymi urządzenie powinno się połączyć.

x509info

X509

Obiekt X509 zawierający certyfikat i klucz, którego urządzenie może użyć do uwierzytelniania w wystąpieniu usługi Azure IoT Hub.

Zwraca

X509AuthenticationProvider

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

Zwraca

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

Ta metoda jest używana przez transporty w celu uzyskania najbardziej aktualnych poświadczeń urządzenia w postaci obiektu TransportConfig.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parametry

callback

Callback<TransportConfig>

opcjonalna funkcja, która będzie wywoływana z błędem lub zestawem poświadczeń urządzenia, których można użyć do uwierzytelniania w centrum IoT.

setX509Options(X509)

Aktualizuje certyfikat i klucz używany przez urządzenie do nawiązywania połączenia i uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.

function setX509Options(x509: X509)

Parametry

x509

X509

Obiekt X509 zawierający certyfikat i klucz.