azure-iothub package

IoT Hub サービス クライアントは、Azure IoT ハブを介してデバイスと通信するために使用されます。 これにより、SDK ユーザーは次のことが可能になります。

• cloud-to-device (コマンドとも呼ばれます) をデバイスに送信する: コマンドは IoT Hub でキューに登録され、デバイスが接続されている場合にのみ非同期的に配信されます。 デバイスごとにキューに登録できるコマンドは 50 個のみです。
• デバイスでダイレクト メソッドを呼び出す (デバイスが現在接続されている場合にのみ機能します。これは、デバイスとの同期通信方法です)
• 前のコマンドについてデバイスから送信されたフィードバック メッセージをリッスンします。
• デバイスからのファイル アップロード通知をリッスンします。

ユーザーは、IoT Hub サービス クライアントを作成するために、ファクトリ メソッド (fromConnectionString または sharedAccessSignature Client) のいずれかを呼び出して、新しい インスタンスを作成する必要があります。

デバイス ID レジストリ API で使用するデバイスの表現を作成します。

このクラスは、デバイス ID レジストリ が、デバイスの部分的な説明を含む JSON オブジェクトを直接操作できるため、 非推奨となりました。これは、必ずしも完全なオブジェクトであるとは限りません。 その上に、このクラスは最初に symmetricKey プロパティ名の入力ミスで出荷されました(キャメルケースではなくパスカルケースでした)。 SDK では、既存のコードを中断しないようにこのクラスを保持していますが、これは将来のメジャー バージョンの更新で削除される予定であり、お客様は代わりにプレーン JSON オブジェクトを使用する必要があります。

IoT Hub インスタンスで実行時間の長いジョブを作成、更新、監視、取り消す方法と、既存のジョブのクエリを実行するメソッドを提供します。 Azure IoT Hub の Jobs API を使用すると、複数のデバイスでダイレクト メソッド呼び出しとツイン更新をスケジュールできます。

SDK ユーザーは、JobClient および fromConnectionString(string)ファクトリ メソッドを使用して、fromSharedAccessSignature(string) インスタンスを作成する必要があります。

Registry クラスは、IoT Hub デバイス ID サービスへのアクセスを提供します。 SDK のユーザーは、次のいずれかのファクトリ メソッドを使用してこのクラスをインスタンス化する必要があります。fromConnectionString またはsharedAccessSignature から します。

デバイス ID レジストリ操作に使用されるプロトコルは HTTPS です。

サービス クライアントによって使用されるトランスポート クラスは、セキュリティで保護された (TLS) ソケット経由で AMQP プロトコルを使用して Azure IoT ハブに接続。 このクラスは直接使用しないでください。代わりに、Client ファクトリ メソッドのいずれかに渡す必要があります。fromConnectionString またはsharedAccessSignature から します。

サービス クライアントによって使用されるトランスポート クラス、セキュリティで保護された Websocket 経由で AMQP プロトコルを使用して Azure IoT ハブに接続します。 このクラスは直接使用しないでください。代わりに、Client ファクトリ メソッドのいずれかに渡す必要があります。fromConnectionString またはsharedAccessSignature から します。

コンストラクターに渡される接続文字列に基づいて、Shared Access Signature を作成します。 このクラスは、各要求に認証ヘッダーを追加するために、SDK のプロトコル レイヤーによって使用されます。

Device Twin は、Azure IoT ハブによって格納され、デバイスがオフラインの場合でも使用できるデバイスの状態を説明するドキュメントです。 次の 3 つのセクションを中心に構築されています。

• タグ: サービス側からのみアクセスできるキーと値のペア
• 必要なプロパティ: サービスによって更新され、デバイスによって受信されます
• 報告されるプロパティ: デバイスによって更新され、サービスによって受信されます。

可能性はありますが、必要なプロパティと報告されるプロパティは一致する必要はありません。また、必要に応じて、これら 2 つのコレクションを同期するロジックが SDK のユーザーに委ねられます。

詳細については、「デバイス ツインについて」を参照してください。

特定のデバイスの Twin を取得するには、getTwin(string, HttpResponseCallback<Twin>) メソッドを使用することをお勧めします。

Configuration オブジェクトは、1 つのデバイスの構成を表すか、targetCondition に基づいてデバイスに構成として適用できる展開を表すことができます。

ダイレクト メソッド (デバイス メソッドとも呼ばれます) で使用できるパラメーターについて説明します。