Event Hubs に IoT データをエクスポートする

[アーティクル]
03/05/2024

この記事では、Event Hubs にデータを送信するようにデータエクスポートを構成する方法について説明します。

この機能を使用して、フィルター処理およびエンリッチ化された IoT データを IoT Central アプリケーションから連続エクスポートします。データエクスポートを使用すると、ウォームパスの分析情報、分析、およびストレージ用に、クラウドソリューションの他の部分にほぼリアルタイムで変更がプッシュされます。

たとえば、次のように操作できます。

テレメトリ、プロパティ変更、デバイスの接続性、デバイスのライフサイクル、デバイスのテンプレートのライフサイクル、および監査ログデータを、JSON 形式で、ほぼリアルタイムで継続的にエクスポートする
データストリームをフィルター処理して、カスタム条件に一致するデータをエクスポートする
デバイスからのカスタム値とプロパティ値を使用してデータストリームをエンリッチ化する
データストリームを変換して、形態とコンテンツを変更します。

ヒント

データエクスポートを有効にすると、その時点以降のデータのみが取得されます。より多くの履歴データを保持するには、データエクスポートを早い段階で有効にしてください。データエクスポートが無効になっていたときからのデータを手動でエクスポートするには、「IoT Central REST API を使ってデバイスのクエリを実行する方法」を参照してください。

Note

状況によっては、メッセージがエクスポートされるまでに最大 60 秒かかる場合があります。これは、IoT Central が基になる IoT ハブからメッセージを受信した時点から、メッセージが宛先エンドポイントに配信されるまでの時間です。

前提条件

データエクスポート機能を使用するには、データエクスポートのアクセス許可が必要です。

Event Hubs エクスポート先を設定する

データは、IoT Central からほぼリアルタイムでエクスポートされます。データはメッセージ本文に含まれ、UTF-8 としてエンコードされた JSON 形式です。

メッセージの注釈またはシステムプロパティバッグ内には、メッセージ本文の対応するフィールドと同じ値を持つ iotcentral-device-id、iotcentral-application-id、iotcentral-message-source、および iotcentral-message-type フィールドがあります。

接続オプション

エクスポート先が Event Hubs の場合、"接続文字列" またはマネージド ID を使用して接続を構成することができます。

セキュリティは、マネージド ID の方が優れています。その理由は次のとおりです。

IoT Central アプリケーションの接続文字列にリソースの資格情報が格納されません。
資格情報は、IoT Central アプリケーションの有効期間に自動的に関連付けられます。
マネージド ID では、セキュリティキーの定期的なローテーションが自動的に行われます。

現在、IoT Central では、システム割り当てマネージド ID が使用されます。

マネージド ID を構成する場合、構成には スコープ" と ロール が含まれます:

スコープでは、マネージド ID を使用できる場所を定義します。たとえば、スコープとして Azure リソースグループを使用できます。この場合、IoT Central アプリケーションとエクスポート先の両方が同じリソースグループに含まれている必要があります。
ロールでは、エクスポート先のサービスで IoT Central アプリケーションに付与されるアクセス許可を定義します。たとえば、IoT Central アプリケーションがイベントハブにデータを送信するには、マネージド ID に Azure Event Hubs のデータ送信者ロールの割り当てが必要です。

次のビデオでは、システム割り当てマネージド ID の詳細について説明します。

注意

BLOB ストレージにエクスポートするには、ビデオに示すように、ストレージアカウント共同作成者を使用しないでください。代わりにストレージ BLOB データ共同作成者ロールを使用してください。

この記事では、Azure CLI でマネージド ID を作成する方法について説明します。また、Azure portal を使用して、マネージド ID を作成することもできます。

エクスポート先とする既存の Event Hubs 名前空間がない場合は、Azure Cloud Shell bash 環境で次のスクリプトを実行します。このスクリプトにより、リソースグループ、Event Hubs 名前空間、イベントハブが作成されます。その後、このスクリプトによって IoT Central アプリケーションのマネージド ID が有効になり、イベントハブにアクセスするために必要なロールが割り当てられます。

# Replace the Event Hubs namespace name with your own unique value
EHNS=your-event-hubs-namespace-$RANDOM

# Replace the IoT Central app name with the name of your
# IoT Central application.
CA=your-iot-central-app

EH=exportdata
RG=centralexportresources
LOCATION=eastus

RGID=$(az group create -n $RG --location $LOCATION --query "id" --output tsv)
az eventhubs namespace create --name $EHNS --resource-group $RG -l $LOCATION
az eventhubs eventhub create --name $EH --resource-group $RG --namespace-name $EHNS

# This assumes your IoT Central application is in the 
# default `IOTC` resource group.
az iot central app identity assign --name $CA --resource-group IOTC --system-assigned
PI=$(az iot central app identity show --name $CA --resource-group IOTC --query "principalId" --output tsv)

az role assignment create --assignee $PI --role "Azure Event Hubs Data Sender" --scope $RGID

az role assignment list --assignee $PI --all -o table

echo "Host name: $EHNS.servicebus.windows.net"
echo "Event Hub: $EH"

イベントハブをさらにセキュリティで保護し、マネージド ID を使用する信頼されたサービスからのアクセスのみを許可するには、「Azure Virtual Network 上のセキュリティで保護された宛先にデータをエクスポートする」を参照してください。

IoT Central の [データエクスポート] ページで Event Hubs をエクスポート先として作成するには:

[+ New destination](+ 新しい宛先) を選択します。
宛先の種類として [Azure Event Hubs] を選択します。
認可の種類として [システム割り当てマネージド ID] を選択します。
Event Hubs リソースのホスト名を入力します。次に、大文字と小文字を区別してイベントハブ名を入力します。ホスト名は、contoso-waste.servicebus.windows.net のようになります。
[保存] を選択します。

宛先サービスにデータが到着しない場合は、「Azure IoT Central アプリケーションからのデータエクスポートに関する問題のトラブルシューティング」を参照してください。

エクスポート先とする既存の Event Hubs 名前空間がない場合は、Azure Cloud Shell bash 環境で次のスクリプトを実行します。このスクリプトにより、リソースグループ、Event Hubs 名前空間、イベントハブが作成されます。その後、IoT Central でデータエクスポートを構成するときに使用する接続文字列が出力されます。

# Replace the Event Hubs namespace name with your own unique value
EHNS=your-event-hubs-namespace-$RANDOM
EH=exportdata
RG=centralexportresources
LOCATION=eastus

az group create -n $RG --location $LOCATION
az eventhubs namespace create --name $EHNS --resource-group $RG -l $LOCATION
az eventhubs eventhub create --name $EH --resource-group $RG --namespace-name $EHNS
az eventhubs eventhub authorization-rule create --eventhub-name $EH --resource-group $RG --namespace-name $EHNS --name SendRule --rights Send

CS=$(az eventhubs eventhub authorization-rule keys list --eventhub-name $EH --resource-group $RG --namespace-name $EHNS --name SendRule --query "primaryConnectionString" -o tsv)

echo "Event hub connection string: $CS"

IoT Central の [データエクスポート] ページで Event Hubs をエクスポート先として作成するには:

[+ New destination](+ 新しい宛先) を選択します。
宛先の種類として [Azure Event Hubs] を選択します。
認可の種類として [接続文字列] を選択します。
Event Hubs リソースの接続文字列を貼り付け、必要に応じてイベントハブ名 (大文字と小文字が区別されます) を入力します。
[保存] を選択します。

データエクスポートの設定

データのエクスポート先を準備したので、IoT Central アプリケーションでデータのエクスポートを設定します。

ご使用の IoT Central アプリケーションにサインインします。
左側のペインで、[データのエクスポート] を選択します。

ヒント

左側のペインに [データのエクスポート] が表示されない場合は、アプリでデータエクスポートを構成するアクセス許可がありません。データエクスポートの設定について、管理者に問い合わせてください。
[+ 新しいエクスポート] を選択します。
新しいエクスポートの表示名を入力し、データエクスポートが [有効] になっていることを確認します。

エクスポートするデータの種類を選択します。次の表は、サポートされるデータエクスポートの型の一覧を示します。

データの種類	説明	データ形式
テレメトリ	デバイスからのテレメトリメッセージがほぼリアルタイムでエクスポートされます。エクスポートされた各メッセージには、元のデバイスメッセージの完全な内容が正規化されて含まれます。	テレメトリメッセージの形式
プロパティ変更	デバイスとクラウドのプロパティに対する変更がほぼリアルタイムでエクスポートされます。読み取り専用のデバイスプロパティでは、報告された値に対する変更がエクスポートされます。読み取り/書き込みプロパティの場合、報告された値と必要な値の両方がエクスポートされます。	プロパティ変更メッセージの形式
デバイスの接続性	デバイスの接続イベントと非接続イベントをエクスポートします。	デバイス接続メッセージの形式
デバイスのライフサイクル	デバイスの登録、削除、プロビジョニング、有効化、無効化、displayNameChanged、および deviceTemplateChanged のイベントをエクスポートします。	デバイスのライフサイクル変更メッセージの形式
デバイステンプレートのライフサイクル	created、updated、および deleted など、発行されたデバイステンプレートの変更をエクスポートします。	デバイステンプレートのライフサイクル変更メッセージの形式
監査ログ	アプリケーション内のエンティティに対してユーザーが開始した更新のログ。詳細については、「監査ログを使用して IoT Central アプリケーションのアクティビティを追跡する」を参照してください	監査ログメッセージの形式

必要に応じて、フィルターを追加して、エクスポートするデータの量を減らします。使用できるフィルターの種類は、データエクスポートの種類ごとに異なります。

データの種類	使用可能なフィルター
テレメトリ	デバイス名、デバイス ID、デバイステンプレート、デバイスがシミュレートされているかどうかでフィルター処理しますフィルター条件を満たすテレメトリのみが含まれるようにストリームをフィルター処理しますフィルター条件に一致するプロパティを持つデバイスのテレメトリのみが含まれるようにストリームをフィルター処理しますフィルター条件を満たし、"メッセージプロパティ" を含むテレメトリのみが含まれるようにストリームをフィルター処理します。 "メッセージプロパティ" ("アプリケーションプロパティ" とも呼ばれます) は、各テレメトリメッセージのキーと値のペアのバッグとして送信されます。メッセージプロパティフィルターを作成するには、検索するメッセージプロパティキーを入力し、条件を指定します。指定したフィルター条件に一致するプロパティを持つテレメトリメッセージのみがエクスポートされます。アプリケーションプロパティの詳細については、IoT Hub のドキュメントを参照してください
プロパティ変更	デバイス名、デバイス ID、デバイステンプレート、デバイスがシミュレートされているかどうかでフィルター処理しますフィルター条件を満たすプロパティ変更のみが含まれるようにストリームをフィルター処理します
デバイスの接続性	デバイス名、デバイス ID、デバイステンプレート、組織、デバイスがシミュレートされているかどうかでフィルター処理しますフィルター条件に一致するプロパティを持つデバイスの変更のみが含まれるようにストリームをフィルター処理します
デバイスのライフサイクル	デバイス名、デバイス ID、デバイステンプレート、デバイスがプロビジョニング、有効化、またはシミュレートされているかどうかでフィルター処理しますフィルター条件に一致するプロパティを持つデバイスの変更のみが含まれるようにストリームをフィルター処理します
デバイステンプレートのライフサイクル	デバイステンプレートでフィルター処理します
監査ログ	該当なし

必要に応じて、余分なキーと値のペアのメタデータを使用して、エクスポートされたメッセージを強化します。次のエンリッチメントは、テレメトリ、プロパティ変更、デバイスの接続性、デバイスのライフサイクルの各データエクスポートの種類で使用できます。
- カスタム文字列: 各メッセージにカスタムの静的文字列を追加します。任意のキーを入力し、任意の文字列値を入力します。
- プロパティ: 各メッセージに追加されます。
  - デバイス名、デバイステンプレート名、有効、組織、プロビジョニング済み、シミュレート済みなどのデバイスメタデータ。
  - 各メッセージに対してデバイスから報告された現在のプロパティまたはクラウドプロパティの値。エクスポートされたメッセージが、指定したプロパティを持たないデバイスからのものである場合、エクスポートされたメッセージにはそのエンリッチメントがありません。

エクスポート先を構成します。

[+ Destination]\(+ エクスポート先\) を選択し、既に作成してあるエクスポート先を追加するか [新規作成する] を選択します。
エクスポート前にデータを変換するには、[+ 変換] を選択します。詳しくは、「IoT Central アプリケーション内のデータをエクスポート用に変換する」を参照してください。
[+ Destination]\(+ エクスポート先\) を選択して、1 回のエクスポートに最大 5 つのエクスポート先を追加します。
エクスポートの設定が完了したら、[保存] を選択します。数分後に、エクスポート先にデータが表示されます。

エクスポートの監視

エクスポートの状態は、IoT Central の [Data export]\(データのエクスポート\) ページで確認できます。 Azure Monitor を使用して、エクスポートするデータの量とエクスポートエラーを確認することもできます。エクスポートとデバイスの正常性のメトリックには、Azure portal 内のグラフ、REST API、または PowerShell や Azure CLI のクエリを使ってアクセスできます。現時点では、Azure Monitor で次のデータエクスポートメトリックを監視できます。

フィルター適用前のエクスポート対象受信メッセージの数。
フィルターを通過したメッセージの数。
宛先に正常にエクスポートされたメッセージの数。
見つかったエラーの数。

詳細については、「アプリケーションの正常性を監視する」を参照してください。

データ形式

以降のセクションでは、エクスポートデータの形式について説明します。

テレメトリ形式

エクスポートされた各メッセージには、メッセージ本文でデバイスから送信された、完全なメッセージが正規化された形式で含まれます。メッセージは JSON 形式で、UTF-8 としてエンコードされます。各メッセージに含まれる情報は次のとおりです。

applicationId: IoT Central アプリケーションの ID。
messageSource: メッセージのソース - telemetry。
deviceId: テレメトリメッセージを送信したデバイスの ID。
schema: ペイロードスキーマの名前とバージョン。
templateId: デバイスに割り当てられているデバイステンプレートの ID。
enqueuedTime: IoT Central がこのメッセージを受信した時刻。
enrichments: エクスポートに設定されたエンリッチメント。
module: このメッセージを送信した IoT Edge モジュール。このフィールドは、メッセージが IoT Edge モジュールから送信された場合にのみ表示されます。
component: このメッセージを送信したコンポーネント。このフィールドは、メッセージで送信された機能がデバイステンプレートでコンポーネントとしてモデル化されている場合にのみ表示されます。
messageProperties: デバイスによってメッセージと共に送信されるその他のプロパティ。これらのプロパティはアプリケーションプロパティと呼ばれることもあります。詳細については IoT Hub のドキュメントを参照してください。

メッセージプロパティ

テレメトリメッセージには、テレメトリペイロードに加え、メタデータのプロパティが含まれています。前のスニペットは、deviceId や enqueuedTime など、システムメッセージの例を示しています。システムメッセージプロパティの詳細については、「D2C IoT Hub メッセージのシステムプロパティ」を参照してください。

テレメトリメッセージにカスタムメタデータを追加する必要がある場合、テレメトリメッセージにプロパティを追加できます。たとえば、デバイスでメッセージが作成されるとき、タイムスタンプを追加する必要があります。

次のコードスニペットは、デバイス上でメッセージを作成するとき、それに iothub-creation-time-utc プロパティを追加する方法を示しています。

重要

このタイムスタンプの形式は、タイムゾーン情報を含まない UTC であることが必要です。たとえば、2021-04-21T11:30:16Z は有効で、2021-04-21T11:30:16-07:00 は無効です。

async function sendTelemetry(deviceClient, index) {
  console.log('Sending telemetry message %d...', index);
  const msg = new Message(
    JSON.stringify(
      deviceTemperatureSensor.updateSensor().getCurrentTemperatureObject()
    )
  );
  msg.properties.add("iothub-creation-time-utc", new Date().toISOString());
  msg.contentType = 'application/json';
  msg.contentEncoding = 'utf-8';
  await deviceClient.sendEvent(msg);
}

private static void sendTemperatureTelemetry() {
  String telemetryName = "temperature";
  String telemetryPayload = String.format("{\"%s\": %f}", telemetryName, temperature);

  Message message = new Message(telemetryPayload);
  message.setContentEncoding(StandardCharsets.UTF_8.name());
  message.setContentTypeFinal("application/json");
  message.setProperty("iothub-creation-time-utc", Instant.now().toString());

  deviceClient.sendEventAsync(message, new MessageIotHubEventCallback(), message);
  log.debug("My Telemetry: Sent - {\"{}\": {}°C} with message Id {}.", telemetryName, temperature, message.getMessageId());
  temperatureReadings.put(new Date(), temperature);
}

private async Task SendTemperatureTelemetryAsync()
{
  const string telemetryName = "temperature";

  string telemetryPayload = $"{{ \"{telemetryName}\": {_temperature} }}";
  using var message = new Message(Encoding.UTF8.GetBytes(telemetryPayload))
  {
      ContentEncoding = "utf-8",
      ContentType = "application/json",
  };
  message.Properties.Add("iothub-creation-time-utc", DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ"));
  await _deviceClient.SendEventAsync(message);
  _logger.LogDebug($"Telemetry: Sent - {{ \"{telemetryName}\": {_temperature}°C }}.");
}

async def send_telemetry_from_thermostat(device_client, telemetry_msg):
    msg = Message(json.dumps(telemetry_msg))
    msg.custom_properties["iothub-creation-time-utc"] = datetime.now(timezone.utc).isoformat()
    msg.content_encoding = "utf-8"
    msg.content_type = "application/json"
    print("Sent message")
    await device_client.send_message(msg)

プロパティ変更の形式

各メッセージまたはレコードは、デバイスとクラウドのプロパティの変更を表します。エクスポートされたメッセージに含まれる情報は次のとおりです。

applicationId: IoT Central アプリケーションの ID。
messageSource: メッセージのソース - properties。
messageType: cloudPropertyChange、devicePropertyDesiredChange、または devicePropertyReportedChange のいずれか。
deviceId: テレメトリメッセージを送信したデバイスの ID。
schema: ペイロードスキーマの名前とバージョン。
enqueuedTime: IoT Central がこの変更を検出した時刻。
templateId: デバイスに割り当てられているデバイステンプレートの ID。
properties: 変更されたプロパティの名前と値を含む、変更されたプロパティの配列。プロパティがコンポーネントまたは IoT Edge モジュール内でモデル化されている場合、コンポーネントとモジュールの情報が含まれます。
enrichments: エクスポートに設定されたエンリッチメント。

デバイス接続性の変更形式

各メッセージまたはレコードは、1 台のデバイスからの接続イベントを表します。エクスポートされたメッセージに含まれる情報は次のとおりです。

applicationId: IoT Central アプリケーションの ID。
messageSource: メッセージのソース - deviceConnectivity。
messageType: connected または disconnected のいずれか。
deviceId: 変更されたデバイスの ID。
schema: ペイロードスキーマの名前とバージョン。
templateId: デバイスに割り当てられているデバイステンプレートの ID。
enqueuedTime: IoT Central でこの変更が発生した時刻。
enrichments: エクスポートに設定されたエンリッチメント。

デバイスのライフサイクル変更の形式

各メッセージまたはレコードは、1 つのデバイスに対する 1 つの変更を表します。エクスポートされたメッセージに含まれる情報は次のとおりです。

applicationId: IoT Central アプリケーションの ID。
messageSource: メッセージのソース - deviceLifecycle。
messageType: 発生したエラーの種類。 registered、deleted、provisioned、enabled、disabled、displayNameChanged および deviceTemplateChanged のいずれか。
deviceId: 変更されたデバイスの ID。
schema: ペイロードスキーマの名前とバージョン。
templateId: デバイスに割り当てられているデバイステンプレートの ID。
enqueuedTime: IoT Central でこの変更が発生した時刻。
enrichments: エクスポートに設定されたエンリッチメント。

デバイステンプレートのライフサイクル変更の形式

各メッセージまたはレコードは、1 つの発行されたデバイステンプレートに対する 1 つの変更を表します。エクスポートされたメッセージに含まれる情報は次のとおりです。

applicationId: IoT Central アプリケーションの ID。
messageSource: メッセージのソース - deviceTemplateLifecycle。
messageType: created、updated、または deleted のいずれか。
schema: ペイロードスキーマの名前とバージョン。
templateId: デバイスに割り当てられているデバイステンプレートの ID。
enqueuedTime: IoT Central でこの変更が発生した時刻。
enrichments: エクスポートに設定されたエンリッチメント。

監査ログの形式

各監査ログメッセージでは、IoT Central アプリケーション内の監査可能なエンティティに対してユーザーが開始した変更を表します。エクスポートされたメッセージに含まれる情報は次のとおりです。

actor: エンティティを変更したユーザーに関する情報。
applicationId: IoT Central アプリケーションの ID。
messageSource: メッセージのソース - audit。
messageType: 発生したエラーの種類。 updated、created、deleted のいずれかです。
updated: messageType が updated の場合にのみ存在します。更新の詳細情報を提供します。
resource: 変更されたエンティティの詳細。
schema: ペイロードスキーマの名前とバージョン。
deviceId: 変更されたデバイスの ID。
enqueuedTime: IoT Central でこの変更が発生した時刻。
enrichments: エクスポートに設定されたエンリッチメント。

Event Hubs の場合、IoT Central から新しいメッセージデータが、ほぼリアルタイムでイベントハブに送信されます。各メッセージのユーザープロパティ (アプリケーションプロパティとも呼ばれます) では、iotcentral-device-id、iotcentral-application-id、iotcentral-message-source および iotcentral-message-type が自動的に含まれます。

次のステップ

Event Hubs にエクスポートする方法を理解したので、次のステップとして「Azure Data Explorer へのエクスポート」を学習することをお勧めします。