IoT Hub メッセージを作成し、読み取る

プロトコル間の相互運用性をサポートするために、Azure IoT Hub により、すべてのデバイスに接続するプロトコルで使用できる一般的なメッセージング機能のセットが定義されています。 これらの機能は、device-to-cloud メッセージと cloud-to-device メッセージの両方で使用できます。

IoT Hub は、ストリーミング メッセージング パターンを使用して、D2C メッセージングを実装しています。 IoT Hub の device-to-cloud メッセージは、複数のリーダーで読み取り可能なサービスを経由する大量のイベントが存在するという点で、Service Bus "メッセージ" よりも Event Hubs "イベント"に似ています。

IoT Hub メッセージは、次のような構成です。

• "システム プロパティ" の定義済みのセット。この記事で後述します。

• 一連の アプリケーション プロパティ。 メッセージ本文を逆シリアル化しなくてもアプリケーションが定義してアクセスできる、文字列プロパティのディクショナリです。 IoT Hub によってこれらのプロパティが変更されることはありません。

• 任意の型のデータを指定できるメッセージ本文。

各デバイス プロトコルは、さまざまな方法でプロパティの設定を実装します。 詳細については、MQTT プロトコルおよび AMQP プロトコルの開発者ガイドを参照してください。

HTTPS プロトコルを使用して device-to-cloud メッセージを送信するとき、または cloud-to-device メッセージを送信するときに、プロパティ名と値に含めることができるのは、ASCII 英数字と ! # $ % & ' * + - . ^ _ ` | ~ のみです。

IoT Hub を使用した device-to-cloud メッセージングには、次のような特徴があります。

• device-to-cloud メッセージには持続性があり、最長で 7 日間、IoT hub の既定の messages/events エンドポイントに保持されます。

• デバイスからクラウドへのメッセージは最大 256 KB で、送信を最適化するためにバッチでグループ化できます。 バッチは最大で 256 KB です。

• IoT Hub では、任意のパーティション分割は許可されていません。 D2C メッセージは、発信元の deviceIdに基づいてパーティション分割されます。

• 「IoT Hub へのアクセスの制御」で説明されているように、IoT Hub ではデバイスごとに認証とアクセス制御を行うことができます。

• アプリケーション プロパティに移動する情報をメッセージにスタンプできます。 詳細については、メッセージ エンリッチメントの概要に関するページを参照してください。

IoT Hub ルーティング クエリでメッセージ本文を使うには、メッセージに有効な JSON オブジェクトを指定し、メッセージのコンテンツ タイプ プロパティを application/json;charset=utf-8 に設定します。

有効でルーティング可能なメッセージ本文の例を次に示します。

{
    "timestamp": "2022-02-08T20:10:46Z",
    "tag_name": "spindle_speed",
    "tag_value": 100
}

device-to-cloud メッセージのシステム プロパティ

device-to-cloud メッセージのアプリケーション プロパティ

アプリケーション プロパティの一般的な用途として、デバイスからメッセージが送信された日時の記録があります。この場合、iothub-creation-time-utc プロパティを使用してデバイスからタイムスタンプを送信します。 このタイムスタンプの形式は、タイムゾーン情報を含まない UTC であることが必要です。 たとえば、2021-04-21T11:30:16Z は有効ですが、2021-04-21T11:30:16-07:00 は無効です。

{
  "applicationId":"00001111-aaaa-2222-bbbb-3333cccc4444",
  "messageSource":"telemetry",
  "deviceId":"sample-device-01",
  "schema":"default@v1",
  "templateId":"urn:modelDefinition:mkuyqxzgea:e14m1ukpn",
  "enqueuedTime":"2021-01-29T16:45:39.143Z",
  "telemetry":{
    "temperature":8.341033560421833
  },
  "messageProperties":{
    "iothub-creation-time-utc":"2021-01-29T16:45:39.021Z"
  },
  "enrichments":{}
}

cloud-to-device メッセージのシステム プロパティ

システム プロパティ名

システム プロパティ名は、メッセージがルーティングされるエンドポイントによって異なります。

メッセージ サイズ

IoT Hub では、メッセージのサイズは、プロトコルに関係なく実際のペイロードのみを考慮して測定されます。 サイズ (バイト単位) は次の値の和として計算されます。

• 本文のサイズ (バイト単位)
• メッセージ システム プロパティの全値のサイズ (バイト単位)。
• すべてのユーザー プロパティの名前と値のサイズ (バイト単位)

プロパティの名前と値は ASCII 文字に制限されているため、文字列の長さがバイト単位のサイズと等しくなります。

なりすまし対策のプロパティ

D2C メッセージでのデバイスのなりすましを回避するために、IoT Hub では、すべてのメッセージに次のプロパティを持つスタンプが使用されます。

• iothub-connection-device-id
• iothub-connection-auth-generation-id
• iothub-connection-auth-method

最初の 2 つには、「デバイス ID プロパティ」で説明されている発信元デバイスの deviceId と generationId が含まれています。

iothub-connection-auth-method プロパティには、次のプロパティを使用してシリアル化された JSON オブジェクトが含まれています。

{
  "scope": "{ hub | device | module }",
  "type": "{ symkey | sas | x509 }",
  "issuer": "iothub"
}

次のステップ

• IoT Hub でのメッセージ サイズの制限については、IoT Hub のクォータと調整に関するページをご覧ください。
• IoT Hub メッセージをさまざまなプログラミング言語で作成し、読み取る方法については、クイック スタートをご覧ください。
• IoT Hub によって生成される非テレメトリ イベントの構造については、IoT Hub の非テレメトリ イベント スキーマに関するページを参照してください。