X509AuthenticationProvider class

パッケージ:

azure-iot-device

AuthenticationProvider X509 証明書とキーを使用するだけで作成できるオブジェクトを提供し、デバイス クライアントとトランスポートが Azure IoT ハブ インスタンスで認証するために使用します。

SharedAccessSignatureAuthenticationProviderオブジェクトと SharedAccessKeyAuthenticationProvider オブジェクトとは異なり、 X509AuthenticationProvider は X509 認証にnewTokenAvailable関係するトークンがないため、イベントを生成しません。 トランスポートは、 メソッドを使用して資格情報を getDeviceCredentials 取得します。

プロパティ

type

メソッド

fromX509Options(string, string, X509)	証明書とキーをX509含むオブジェクトから新しい X509AuthenticationProvider を作成します。
getDeviceCredentials()
getDeviceCredentials(Callback<TransportConfig>)	このメソッドは、オブジェクトの形式 TransportConfig で最新のデバイス資格情報を取得するためにトランスポートによって使用されます。
setX509Options(X509)	デバイスが Azure IoT ハブ インスタンスに接続して認証するために使用する証明書とキーを更新します。

プロパティの詳細

type

type: AuthenticationType

プロパティ値

AuthenticationType

メソッドの詳細

fromX509Options(string, string, X509)

証明書とキーをX509含むオブジェクトから新しい X509AuthenticationProvider を作成します。

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

パラメーター

deviceId

string

デバイス識別子。

iotHubHostname

string

デバイスが接続する必要がある Azure IoT ハブ インスタンスのホスト名。

x509info

X509

X509デバイスが Azure IoT ハブ インスタンスで認証するために使用できる証明書とキーを含むオブジェクト。

戻り値

X509AuthenticationProvider

getDeviceCredentials()

function getDeviceCredentials(): Promise<TransportConfig>

戻り値

Promise<TransportConfig>

getDeviceCredentials(Callback<TransportConfig>)

このメソッドは、オブジェクトの形式 TransportConfig で最新のデバイス資格情報を取得するためにトランスポートによって使用されます。

function getDeviceCredentials(callback?: Callback<TransportConfig>)

パラメーター

callback

Callback<TransportConfig>

IoT ハブでの認証に使用できる一連のデバイス資格情報またはエラーで呼び出される省略可能な関数。

setX509Options(X509)

デバイスが Azure IoT ハブ インスタンスに接続して認証するために使用する証明書とキーを更新します。

function setX509Options(x509: X509)

パラメーター

x509

X509

X509証明書とキーを含む オブジェクト。