Azure Digital Twins でイベント ルートとフィルターを作成する

イベント ルートを作成するには、Azure portal で Azure Digital Twins インスタンスの詳細ページに移動します (インスタンスを見つけるには、ポータルの検索バーにその名前を入力します)。

インスタンスのメニューから、[イベント ルート] を選択します。 次に、[イベント ルート] ページで、[+ イベント ルートの作成] を選択します。

開いた [イベント ルートの作成] ページで、少なくとも次を選択します。

• [名前] フィールドでルートの名前
• ルートの作成に使用する [エンドポイント]

有効にするルートについて、少なくとも true のイベントルート フィルターを追加する必要もあります。 (false の既定値のままにするとルートが作成されますが、イベントがそれに送信されません)。これを行うには、[詳細エディター] のスイッチを切り替えて有効にし、[フィルター] ボックスに true と書き込みます。

完了したら、[保存] ボタンを選択して、イベント ルートを作成します。

ルートは Azure Digital Twins CLI の az dt route コマンドを使用して管理できます。

CLI の使用方法および使用できるコマンドの詳細は、「Azure Digital Twins CLI コマンド セット」を参照してください。

このセクションでは、.NET (C#) SDK を使用してイベント ルートを作成する方法について説明します。

CreateOrReplaceEventRouteAsync は、イベント ルートを追加するために使用される SDK 呼び出しです。 次に、その使用例を示します。

string eventFilter = "$eventType = 'DigitalTwinTelemetryMessages' or $eventType = 'DigitalTwinLifecycleNotification'";
var er = new DigitalTwinsEventRoute("endpointName", eventFilter);
await client.CreateOrReplaceEventRouteAsync("routeId", er);

イベント ルートのサンプル SDK コード

次のサンプル メソッドでは、C# SDK を使用してイベント ルートを作成、一覧表示、削除する方法を示します。

public static async Task CreateEventRouteAsync(DigitalTwinsClient client, string routeId, DigitalTwinsEventRoute er)
{
    try
    {
        Console.WriteLine("Create a route: testRoute1");

        // Make a filter that passes everything
        er.Filter = "true";
        await client.CreateOrReplaceEventRouteAsync(routeId, er);
        Console.WriteLine("Create route succeeded.");

        // List routes
        AsyncPageable<DigitalTwinsEventRoute> results = client.GetEventRoutesAsync();
        await foreach (DigitalTwinsEventRoute route in results)
        {
            Console.WriteLine($"Route {route.Id} to endpoint {route.EndpointName} with filter {route.Filter} ");
        }

        // Delete route created earlier
        Console.WriteLine($"Deleting route {routeId}:");
        await client.DeleteEventRouteAsync(routeId);
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine($"*** Error in event route processing ({e.ErrorCode}):\n${e.Message}");
    }
}

イベント ルートの作成中にイベント フィルターを追加するには、[イベント ルートを作成する] ページの [イベント ルート フィルターの追加] セクションを使用します。

いくつかの基本的な共通フィルター オプションから選択することも、高度なフィルター オプションを使用して独自のカスタム フィルターを作成することもできます。

基本的なフィルターを使用する

基本的なフィルターを使用するには、[イベントの種類] オプションを展開し、エンドポイントに送信する必要があるイベントに対応するチェックボックスをオンにします。

そうすると、フィルター テキスト ボックスには、選択したフィルターのテキストが自動的に格納されます。

高度なフィルターを使用する

[高度なフィルター] オプションを使用して、独自のカスタム フィルターを作成することもできます。

高度なフィルター オプションを使用してイベント ルートを作成するには、 [詳細エディター] のスイッチを切り替えて、有効にします。 それにより、 [フィルター] ボックスに独自のイベント フィルターを記述できます。

Event Routes データ プレーン API を使用してカスタム フィルターを作成できます。 フィルターを追加するには、次の本文を含む PUT 要求を https://<Your-Azure-Digital-Twins-host-name>/eventRoutes/<event-route-name>?api-version=2020-10-31 に使用します。

{
    "endpointName": "<endpoint-name>",
    "filter": "<filter-text>"
}