ルールを構成する

[アーティクル]
04/16/2024

IoT Central のルールは、接続されているデバイスからアクティブに監視されているイベントでトリガーする、カスタマイズ可能な応答ツールとして機能します。以下のセクションで、ルールの評価方法について説明します。ルールがトリガーされたときに発生する 1 つ以上のアクションを定義できます。この記事では、メール、Webhook、Azure Monitor のアクショングループについて説明します。その他のアクションの種類の詳細については、「ワークフローを使用して Azure IoT Central アプリケーションを他のクラウドサービスと統合する」を参照してください。

ターゲットデバイスの選択

このルールが適用されるデバイスの種類を選択するには、ターゲットデバイスセクションを使用します。フィルターを使用すると、対象デバイスをさらに絞り込むことができます。フィルターは、デバイステンプレートのプロパティを使用して、デバイスのセットを絞り込みます。フィルター自体はアクションをトリガーしません。次のスクリーンショットでは、ルールは Refrigerator デバイスを対象としています。フィルターで、[Manufactured State]$製造された州$ プロパティが [ワシントン] と等しい [冷蔵庫] のみをルールの対象とするように指定しています。

複数の条件を使用する

条件によって、ルールがトリガーされるデバイスが決まります。ルールに複数の条件を追加し、すべての条件が true の場合と、いずれかの条件が true の場合のどちらでルールをトリガーするかを指定できます。

次のスクリーンショットでは、温度が 70 F より高く、かつ湿度が 10% 未満になるタイミングを条件で確認しています。これらのステートメントのいずれかが true である場合、ルールの評価結果は true になり、アクションがトリガーされます。

Note

現時点では、テレメトリの条件のみがサポートされています。

値フィールドでクラウドプロパティを使用する

クラウドプロパティは、条件の値フィールドにあるデバイステンプレートから参照できます。クラウドプロパティとテレメトリ値は、類似した型である必要があります。たとえば、温度が double の場合、[値] ドロップダウンには、double 型のクラウドプロパティのみがオプションとして表示されます。

イベントの種類のテレメトリ値を選択する場合、[値] ドロップダウンには、[任意] オプションが表示されます。 [任意] オプションは、ペイロードの内容にかかわらず、アプリケーションがその種類のイベントを受信するときに規則が適用されることを意味します。

集計ウィンドウを使用する

時間枠に基づいてルールをトリガーするための、集計時間を指定できます。ルール条件は、集計時間枠の利用統計情報を、タンブリングウィンドウとして評価します。ルールにプロパティフィルターがある場合は、時間枠の最後に適用されます。次のスクリーンショットでは、時間枠は 5 分です。このルールでは、5 分ごとに、最後の 5 分間の利用統計情報が評価されます。データは、対応するウィンドウ内で 1 回だけ評価されます。

タンブリングウィンドウがどのように定義されているかを示す図。

メールアクションを作成する

メールアクションを作成する場合は、メールアドレスがアプリケーションのユーザー ID であり、そのユーザーがアプリケーションに少なくとも一度はサインインしている必要があります。メールに含めるメモを指定することもできます。 IoT Central に、ルールがトリガーされた場合のメールがどのようなものになるかの例が表示されます。

Webhook アクションを作成する

Webhook を使用すると、IoT Central アプリを他のアプリケーションやサービスに接続して、リモート監視や通知を行うことができます。 IoT Central アプリ内でルールがトリガーされるたびに、Webhook は、接続されている他のアプリケーションやサービスに対して自動的に通知を行います。ルールがトリガーされるたびに、IoT Central アプリから他のアプリケーションの HTTP エンドポイントに POST 要求が送信されます。ペイロードには、デバイスの詳細とルールのトリガーの詳細が含まれます。

この例では、RequestBin に接続して通知をテストします。

RequestBin に移動します。
[Create a RequestBin] (RequestBin の作成) を選びます。
使用可能ないずれかの方法でサインインします。
RequestBin エンドポイントの URL をコピーします。
ルールにアクションを追加します。
Webhook アクションを選択し、表示名を入力して、RequestBin URL を [コールバック URL] として貼り付けます。
規則を保存します。

ルールがトリガーされると、新しい要求が RequestBin に表示されます。

Payload

ルールがトリガーされると、コールバック URL に対して HTTP POST 要求が行われます。要求には、テレメトリ、デバイス、ルール、およびアプリケーションの詳細を含む JSON ペイロードが含まれています。ペイロードは次の JSON スニペットのようになります。

{
    "timestamp": "2020-04-06T00:20:15.06Z",
    "action": {
        "id": "<id>",
        "type": "WebhookAction",
        "rules": [
            "<rule_id>"
        ],
        "displayName": "Webhook 1",
        "url": "<callback_url>"
    },
    "application": {
        "id": "<application_id>",
        "displayName": "Contoso",
        "subdomain": "contoso",
        "host": "contoso.azureiotcentral.com"
    },
    "device": {
        "id": "<device_id>",
        "etag": "<etag>",
        "displayName": "Refrigerator Monitor - 1yl6vvhax6c",
        "instanceOf": "<device_template_id>",
        "simulated": true,
        "provisioned": true,
        "approved": true,
        "cloudProperties": {
            "City": {
                "value": "Seattle"
            }
        },
        "properties": {
            "deviceinfo": {
                "firmwareVersion": {
                    "value": "1.0.0"
                }
            }
        },
        "telemetry": {
            "<interface_instance_name>": {
                "humidity": {
                    "value": 47.33228889360127
                }
            }
        }
    },
    "rule": {
        "id": "<rule_id>",
        "displayName": "Humidity monitor"
    }
}

ルールによって一定期間にわたって集計テレメトリが監視されている場合、ペイロードには次のようなテレメトリセクションが含まれます。

{
    "telemetry": {
        "<interface_instance_name>": {
            "Humidity": {
                "avg": 39.5
            }
        }
    }
}

データ形式の変更に関する通知

2020 年 4 月 3 日より前に作成および保存された Webhook が 1 つ以上ある場合は、その Webhook を削除して新しい Webhook を作成します。古い Webhook では、非推奨のペイロード形式が使用されています。

{
    "id": "<id>",
    "displayName": "Webhook 1",
    "timestamp": "2019-10-24T18:27:13.538Z",
    "rule": {
        "id": "<id>",
        "displayName": "High temp alert",
        "enabled": true
    },
    "device": {
        "id": "rm1",
        "displayName": "Refrigerator Monitor - rm1",
        "instanceOf": "<device-template-id>",
        "simulated": true,
        "provisioned": true,
        "approved": true
    },
    "data": [{
        "@id": "<id>",
        "@type": ["Telemetry"],
        "name": "temperature",
        "displayName": "Temperature",
        "value": 66.27310467496761,
        "interfaceInstanceName": "sensors"
    }],
    "application": {
        "id": "<id>",
        "displayName": "x - Store Analytics Checkout",
        "subdomain": "<subdomain>",
        "host": "<host>"
    }
}

Azure Monitor グループアクションを作成する

このセクションでは、Azure Monitor "アクショングループ" を使用して、複数のアクションを IoT Central ルールに関連付ける方法について説明します。複数のルールにアクショングループを関連付けることができます。アクショングループは、Azure サブスクリプションの "所有者" によって定義された通知設定を集めたものです。

Azure portal でアクショングループを作成して管理できます。あるいは、Azure Resource Manager テンプレートを利用してアクショングループを作成し、管理できます。

アクショングループでできること:

メール、SMS、音声通話で通知を送信します。
Webhook を呼び出すなど、操作を実行します。

次のスクリーンショットでは、メールや SMS の通知を送信し、Webhook を呼び出すアクショングループを確認できます。

IoT Central ルールでアクショングループを使用するには、IoT Central アプリケーションと同じ Azure サブスクリプションにアクショングループを置く必要があります。

IoT Central のルールにアクションを追加するときに、[Azure Monitor アクショングループ] を選択します。

Azure サブスクリプションからアクショングループを選択します。

[保存] を選択します。これでこのアクショングループはアクションの一覧に表示され、ルールがトリガーされたときに実行されます。

次の表は、サポートされているアクションの種類に送信される情報をまとめたものです。

アクションの種類	出力書式
メール	標準 IoT Central メールテンプレート
sms	Azure IoT Central アラート: `${applicationName} - "${ruleName}" triggered on "${deviceName}" at ${triggerDate} ${triggerTime}`
音声	Azure I.O.T Central アラート: ルール `"${ruleName}" triggered on device "${deviceName}" at ${triggerDate} ${triggerTime}, in application ${applicationName}`
Webhook	`{ "schemaId" : "AzureIoTCentralRuleWebhook", "data": {"regular webhook payload"}}`

次のテキストは、アクショングループからの SMS メッセージの例です。

iotcentral: Azure IoT Central alert: Contoso - "Low pressure alert" triggered on "Motion sensor 2" at March 20, 2019 10:12 UTC

IoT Edge モジュールでのルールの使用

IoT Edge モジュールに適用されるルールには制限が適用されます。モジュールが異なるテレメトリに基づくルールは、有効なルールとして評価されません。次に例を示します。ルールの最初の条件はモジュール A の温度テレメトリに基づくもので、ルールの 2 番目の条件はモジュール B の湿度テレメトリに基づくものであるとします。この場合、2 つの条件はモジュールが異なっているため、無効な条件のセットになります。このルールは有効ではないため、ルールを保存しようとするとエラーがスローされます。

次のステップ

これで、Azure IoT Central アプリケーションでルールを構成する方法を習得したことになるため、Power Automate または Azure Logic Apps を使用して、高度なルールを構成する方法を参照してください。

次の方法で共有

ルールを構成する

ターゲットデバイスの選択

複数の条件を使用する

値フィールドでクラウドプロパティを使用する

集計ウィンドウを使用する

メールアクションを作成する

Webhook アクションを作成する

Payload

データ形式の変更に関する通知

Azure Monitor グループアクションを作成する

IoT Edge モジュールでのルールの使用

次のステップ

フィードバック

その他のリソース

次の方法で共有

ルールを構成する

ターゲット デバイスの選択

複数の条件を使用する

値フィールドでクラウド プロパティを使用する

集計ウィンドウを使用する

メール アクションを作成する

Webhook アクションを作成する

Payload

データ形式の変更に関する通知

Azure Monitor グループ アクションを作成する

IoT Edge モジュールでのルールの使用

次のステップ

フィードバック

その他のリソース

ターゲットデバイスの選択

値フィールドでクラウドプロパティを使用する

メールアクションを作成する

Azure Monitor グループアクションを作成する