azure-iothub package

クラス

Client

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

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

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

Device

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

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

JobClient

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

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

Registry

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

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

Amqp

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

AmqpWs

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

DigitalTwinClient
IoTHubTokenCredentials

コンストラクターに渡される接続文字列に基づいて、共有アクセス署名を作成します。 このクラスは、SDK のプロトコル 層によって使用され、各要求に認証ヘッダーを追加します。

Twin

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

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

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

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

特定のデバイスの を取得 Twin する推奨される方法は、 メソッドを getTwin(string, HttpResponseCallback<Twin>) 使用することです。

インターフェイス

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

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

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

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

Module

型エイリアス

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback