azure-iot-device package

クラス

Message	Message オブジェクトは、デバイスと IoT Hub サービスの間のテレメトリ (device-to-cloud) およびコマンド (cloud-to-device) 非同期メッセージングに使用されます。 トランスポートに依存しないため、AMQP、MQTT、HTTP で同じように動作します。
Client	デバイスを Azure IoT Hub に接続するために使用される IoT Hub デバイス クライアント。 SDK のユーザーは、ファクトリ メソッドのいずれかを呼び出す必要があります。fromConnectionString または SharedAccessSignature から して IoT Hub デバイス クライアントを作成します。
DeviceMethodRequest	クラウドからデバイス メソッドが呼び出されたときにサービスからデバイスに渡されるデータを表します。 このクラスのインスタンスは、onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)経由で登録されたコールバックに渡されます。
DeviceMethodResponse	DeviceMethodResponse オブジェクトは、各 DeviceMethodRequest を持つユーザーに提供されます。これにより、ユーザーは適切な形式の応答を構築し、デバイス メソッド呼び出しごとにサービスに送信できます。 このクラスのインスタンスは、onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)によって登録されたコールバックに 2 番目のパラメーターとして渡されます。
IotEdgeAuthenticationProvider	トークンの生成を iotedged に委任する AuthenticationProvider 実装を提供します。 この実装は、Azure IoT Edge でモジュール クライアントを使用する場合に使用するためのものです。 この型は SharedAccessKeyAuthenticationProvider から継承され、_sign メソッドを実装してオーバーライドするトークン生成部分を除き、機能的にはその型と同じです。
ModuleClient	デバイスを Azure IoT Hub に接続するために使用される IoT Hub デバイス クライアント。 SDK のユーザーは、ファクトリ メソッドのいずれかを呼び出す必要があります。fromConnectionString または SharedAccessSignature から して IoT Hub デバイス クライアントを作成します。
SharedAccessKeyAuthenticationProvider	接続文字列を使用するだけで作成できる AuthenticationProvider オブジェクトを提供します。このオブジェクトは、デバイス クライアントとトランスポートが Azure IoT Hub インスタンスで認証するために使用します。 SharedAccessKeyAuthenticationProvider オブジェクトは、共有アクセス署名トークンを定期的に作成する処理を行い、トランスポートが Azure IoT Hub インスタンスで資格情報を更新して接続を維持するための newTokenAvailable イベントを生成します。
SharedAccessSignatureAuthenticationProvider	Shared Access Signature を使用するだけで作成できる AuthenticationProvider オブジェクトを提供し、デバイス クライアントとトランスポートが Azure IoT Hub インスタンスで認証するために使用します。 SharedAccessSignatureAuthenticationProvider オブジェクトは共有アクセス署名トークンを自動的に更新しないため、ユーザーは updateSharedAccessSignature メソッドを使用して期限切れでない共有アクセス署名トークンをそのトークンにフィードする必要があります。 このメソッドの呼び出しごとに、SharedAccessSignatureAuthenticationProvider は、トランスポートが Azure IoT Hub インスタンスでの認証に使用する newTokenAvailable イベントを生成します。
Twin	Device Twin は、Azure IoT ハブによって格納され、デバイスがオフラインの場合でも使用できるデバイスの状態を説明するドキュメントです。 次の 3 つのセクションを中心に構築されています。 タグ: サービス側からのみアクセスできるキーと値のペア 必要なプロパティ: サービスによって更新され、デバイスによって受信されます 報告されるプロパティ: デバイスによって更新され、サービスによって受信されます。 可能性はありますが、必要なプロパティと報告されるプロパティは一致する必要はありません。また、必要に応じて、これら 2 つのコレクションを同期するロジックが SDK のユーザーに委ねられます。 詳細については、「デバイス ツインについて」を参照してください。
X509AuthenticationProvider	X509 証明書とキーを使用して簡単に作成できる AuthenticationProvider オブジェクトを提供し、デバイス クライアントとトランスポートが Azure IoT Hub インスタンスで認証するために使用します。 SharedAccessSignatureAuthenticationProvider オブジェクトと SharedAccessKeyAuthenticationProvider オブジェクトとは異なり、X509 認証に関係するトークンがないため、X509AuthenticationProvider は newTokenAvailable イベントを生成しません。 トランスポートは、getDeviceCredentials メソッドを使用して資格情報を取得します。

インターフェイス

AmqpTransportOptions	AMQP トランスポートに固有のオプション。 これは、DeviceClientOptions オブジェクト内の http という名前のプロパティとして、setOptions に渡されます。 見る
DeviceClientOptions	クライアント オブジェクトのオプション。 setOptions 関数に渡されます。 例 var options = { cert: myX509Certificate, key: myX509Key, http: { receivePolicy: { interval: 10 } } } client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions	HTTP 受信側がメッセージをポーリングする頻度を構成するために使用される Options 構造体。 これらの各オプションは、drain ブール値を除き、相互に排他的です。 オプション構造には、interval、at、cron、または manualPolling が 1 つだけ存在します。 これを構成するには、DeviceClientOptions オブジェクト内にある HttpTransportOptions オブジェクト内の receivePolicy という名前のプロパティとして、setOptions を呼 び出します。 見る
HttpTransportOptions	オプションの構成パラメーターを Http トランスポートに渡すための Options 構造体。 これは、DeviceClientOptions オブジェクト内の http という名前のプロパティとして、setOptions に渡されます。 見る
MqttTransportOptions	MQTT トランスポートに固有のオプション これは、DeviceClientOptions オブジェクト内の mqtt という名前のプロパティとして、setOptions に渡されます。
TwinProperties	Twin の必要なプロパティと報告されるプロパティが含まれます。

型エイリアス

BufferConvertible

関数

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

関数の詳細

getUserAgentString(NoErrorCallback<string>)

function getUserAgentString(done: NoErrorCallback<string>)

パラメーター

done

NoErrorCallback<string>

getUserAgentString()

function getUserAgentString(): Promise<string>

戻り値

Promise<string>

getUserAgentString(string, NoErrorCallback<string>)

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

パラメーター

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string)

function getUserAgentString(productInfo: string): Promise<string>

パラメーター

productInfo

string

戻り値

Promise<string>