ジョブのスケジュールとブロードキャスト (.NET)

[アーティクル]
10/01/2024

Azure IoT Hub を使用して、数百万のデバイスを更新するジョブのスケジュールと追跡を行います。ジョブを使用して、次の操作を行います。

必要なプロパティを更新する
タグを更新する
ダイレクトメソッドを呼び出す

ジョブはこれらのアクションの 1 つをラップし、デバイスツインクエリで定義されるデバイスのセットに対して実行状況を追跡します。たとえば、バックエンドアプリは、ジョブを使用して 10,000 台のデバイスでダイレクトメソッドを呼び出し、デバイスを再起動できます。デバイスツインクエリでデバイスのセットを指定し、ジョブが将来実行されるようにスケジュールを設定します。各デバイスが reboot ダイレクトメソッドを受信し、実行するたびに、ジョブは進行状況を追跡します。

これらの各機能の詳細については、次の記事をご覧ください。

デバイスツインとプロパティ: デバイスツインの概要および IoT Hub のデバイスツインの理解と使用
ダイレクトメソッド: IoT Hub 開発者ガイド - ダイレクトメソッド

Note

この記事で説明されている機能は、Standard レベルの IoT Hub でのみ使用できます。 Basic および Standard または Free レベルの IoT Hub の詳細については、ソリューションに適した IoT Hub のレベルの選択に関するページを参照してください。

この記事では、次の 2 つの .NET (C#) コンソールアプリを作成する方法について説明します。

バックエンドアプリから呼び出すことができる LockDoor というダイレクトメソッドを実装するデバイスアプリ SimulateDeviceMethods。
2 つのジョブを作成するバックエンドアプリ ScheduleJob。 1 つのジョブが lockDoor ダイレクトメソッドを呼び出し、別のジョブが必要なプロパティの更新を複数のデバイスに送信します。

注意

デバイスとバックエンドアプリの両方の構築に使用できる SDK ツールに関する詳細については、「Azure IoT Hub SDK」を参照してください。

前提条件

見ることができます。
Azure サブスクリプション内の IoT ハブ。ハブがまだない場合は、「IoT ハブの作成」の手順に従うことができます。
お使いの IoT ハブに登録されているデバイス。 IoT ハブにデバイスがない場合は、「デバイスを登録する」の手順に従います。
ポート 8883 がファイアウォールで開放されていることを確認してください。この記事のデバイスサンプルでは、ポート 8883 を介して通信する MQTT プロトコルを使用しています。このポートは、企業や教育用のネットワーク環境によってはブロックされている場合があります。この問題の詳細と対処方法については、「IoT Hub への接続 (MQTT)」を参照してください。

シミュレート対象デバイスアプリの作成

このセクションでは、ソリューションバックエンドによって呼び出されたダイレクトメソッドに応答する .NET コンソールアプリを作成します。

重要

この記事では、Shared Access Signature (対称キー認証とも呼ばれます) を使用してデバイスを接続する手順について説明します。この認証方法はテストと評価には便利ですが、X.509 証明書を使用してデバイスを認証する方が安全なアプローチです。詳細については、「セキュリティのベストプラクティス」>「接続のセキュリティ」をご覧ください。

Visual Studio で、 [新しいプロジェクトの作成] を選択し、 [コンソールアプリ (.NET Framework)] プロジェクトテンプレートを選択します。 [次へ] をクリックして続行します。
[新しいプロジェクトの構成] で、プロジェクトに SimulateDeviceMethods という名前を付け、[次へ] を選びます。
.NET Framework の既定のバージョンをそのまま使い、[作成] を選んでプロジェクトを作成します。
ソリューションエクスプローラーで [SimulateDeviceMethods] プロジェクトを右クリックし、[NuGet パッケージの管理] を選びます。
[NuGet パッケージマネージャー] で [参照] を選択し、Microsoft.Azure.Devices.Client を検索して選択します。 [インストール] を選択します。

この手順により、パッケージのダウンロードとインストールが実行され、Azure IoT device SDK NuGet パッケージへの参照とその依存関係が追加されます。

Program.cs ファイルの先頭に次の using ステートメントを追加します。

using Microsoft.Azure.Devices.Client;
using Microsoft.Azure.Devices.Shared;
using Newtonsoft.Json;
using System.Threading.Tasks;
using System.Text;

Program クラスに次のフィールドを追加します。プレースホルダーの値は、前のセクションで記したデバイス接続文字列に置き換えてください。
```
static string DeviceConnectionString = "<yourDeviceConnectionString>";
static DeviceClient Client = null;
```

次のコードを追加して、デバイスにダイレクトメソッドを実装します。

static Task<MethodResponse> LockDoor(MethodRequest methodRequest, object userContext)
{
    Console.WriteLine();
    Console.WriteLine("Locking Door!");
    Console.WriteLine("\nReturning response for method {0}", methodRequest.Name);

    string result = "'Door was locked.'";
    return Task.FromResult(new MethodResponse(Encoding.UTF8.GetBytes(result), 200));
}

次のメソッドを追加して、デバイスにデバイスツインリスナーを実装します。

private static async Task OnDesiredPropertyChanged(TwinCollection desiredProperties, 
  object userContext)
{
    Console.WriteLine("Desired property change:");
    Console.WriteLine(JsonConvert.SerializeObject(desiredProperties));
}

最後に、IoT ハブへの接続を開いてメソッドリスナーを初期化する次のコードを Main メソッドに追加します。

try
{
    Console.WriteLine("Connecting to hub");
    Client = DeviceClient.CreateFromConnectionString(DeviceConnectionString, 
      TransportType.Mqtt);

    Client.SetMethodHandlerAsync("LockDoor", LockDoor, null);
    Client.SetDesiredPropertyUpdateCallbackAsync(OnDesiredPropertyChanged, null);

    Console.WriteLine("Waiting for direct method call and device twin update\n Press enter to exit.");
    Console.ReadLine();

    Console.WriteLine("Exiting...");

    Client.SetMethodHandlerAsync("LockDoor", null, null);
    Client.CloseAsync().Wait();
}
catch (Exception ex)
{
    Console.WriteLine();
    Console.WriteLine("Error in sample: {0}", ex.Message);
}

作業内容を保存し、ソリューションを構築します。

注意

わかりやすくするために、この記事では再試行ポリシーは実装しません。運用環境のコードには、「一時的な障害の処理」で推奨されているように、再試行ポリシー (接続の再試行など) を実装する必要があります。

IoT ハブ接続文字列を取得する

この記事では、デバイス上で直接メソッドを呼び出すようにジョブをスケジュールし、デバイスツインを更新するようにジョブをスケジュールし、各ジョブの進行状況を監視するバックエンドサービスを作成します。これらの操作を実行するには、サービスにレジストリ読み取りおよびレジストリ書き込みのアクセス許可が必要です。既定では、すべての IoT ハブは、これらのアクセス許可を付与する registryReadWrite という名前の共有アクセスポリシーがある状態で作成されます。

registryReadWrite ポリシーの IoT Hub 接続文字列を取得するには、次の手順を実行します。

Azure portal で、 [リソースグループ] を選択します。ハブが配置されているリソースグループを選択し、リソースの一覧からハブを選択します。
ハブの左側のウィンドウで、 [共有アクセスポリシー] を選択します。
ポリシーの一覧から、 [registryReadWrite] ポリシーを選択します。
[プライマリ接続文字列] をコピーし、値を保存します。

IoT Hub の共有アクセスポリシーとアクセス許可の詳細については、「アクセス制御とアクセス許可」を参照してください。

重要

この記事では、Shared Access Signature を使用してサービスに接続する手順について説明しています。この認証方法はテストと評価には便利ですが、サービスに対する認証方法としては、Microsoft Entra ID またはマネージド ID を使用する方が安全です。詳細については、「セキュリティのベストプラクティス」の「クラウドのセキュリティ」を参照してください。>

ダイレクトメソッドを呼び出し、デバイスツインの更新を送信するジョブのスケジュール

このセクションでは、ジョブを使用して LockDoor ダイレクトメソッドを呼び出し、複数のデバイスに必要なプロパティの更新を送信する .NET コンソールアプリ (C# を使用) を作成します。

Visual Studio で、 [ファイル]>[新規]>[プロジェクト] の順に選択します。 [新しいプロジェクトの作成] で、 [コンソールアプリ (.NET Framework)] を選択してから、 [次へ] を選択します。
[新しいプロジェクトの構成] で、プロジェクトに ScheduleJob という名前を付け [作成] を選びます。
.NET Framework の既定のバージョンをそのまま使い、[作成] を選んでプロジェクトを作成します。
ソリューションエクスプローラーで [ScheduleJob] プロジェクトを右クリックし、 [NuGet パッケージの管理] を選択します。
[NuGet パッケージマネージャー] で [参照] を選択し、Microsoft.Azure.Devices を検索して選択してから、 [インストール] を選択します。

この手順により、パッケージのダウンロードとインストールが実行され、Azure IoT service SDK NuGet パッケージへの参照とその依存関係が追加されます。
Program.cs ファイルの先頭に次の using ステートメントを追加します。
```
using Microsoft.Azure.Devices;
using Microsoft.Azure.Devices.Shared;
```
既定のステートメント内に存在しない場合は、次の using ステートメントを追加します。
```
using System.Threading;
using System.Threading.Tasks;
```
Program クラスに次のフィールドを追加します。プレースホルダーを前述の「IoT ハブ接続文字列を取得する」でコピーした IoT Hub 接続文字列とデバイスの名前に置き換えます。
```
static JobClient jobClient;
static string connString = "<yourIotHubConnectionString>";
static string deviceId = "<yourDeviceId>";
```

Program クラスに次のメソッドを追加します。

public static async Task MonitorJob(string jobId)
{
    JobResponse result;
    do
    {
        result = await jobClient.GetJobAsync(jobId);
        Console.WriteLine("Job Status : " + result.Status.ToString());
        Thread.Sleep(2000);
    } while ((result.Status != JobStatus.Completed) && 
      (result.Status != JobStatus.Failed));
}

Program クラスに次のメソッドを追加します。

public static async Task StartMethodJob(string jobId)
{
    CloudToDeviceMethod directMethod = 
      new CloudToDeviceMethod("LockDoor", TimeSpan.FromSeconds(5), 
      TimeSpan.FromSeconds(5));

    JobResponse result = await jobClient.ScheduleDeviceMethodAsync(jobId,
        $"DeviceId IN ['{deviceId}']",
        directMethod,
        DateTime.UtcNow,
        (long)TimeSpan.FromMinutes(2).TotalSeconds);

    Console.WriteLine("Started Method Job");
}

別のメソッドを Program クラスに追加します。

public static async Task StartTwinUpdateJob(string jobId)
{
    Twin twin = new Twin(deviceId);
    twin.Tags = new TwinCollection();
    twin.Tags["Building"] = "43";
    twin.Tags["Floor"] = "3";
    twin.ETag = "*";

    twin.Properties.Desired["LocationUpdate"] = DateTime.UtcNow;

    JobResponse createJobResponse = jobClient.ScheduleTwinUpdateAsync(
        jobId,
        $"DeviceId IN ['{deviceId}']", 
        twin, 
        DateTime.UtcNow, 
        (long)TimeSpan.FromMinutes(2).TotalSeconds).Result;

    Console.WriteLine("Started Twin Update Job");
}

注意

クエリ構文の詳細については、IoT Hub クエリ言語に関するページを参照してください。

最後に、Main メソッドに次の行を追加します。

Console.WriteLine("Press ENTER to start running jobs.");
Console.ReadLine();

jobClient = JobClient.CreateFromConnectionString(connString);

string methodJobId = Guid.NewGuid().ToString();

StartMethodJob(methodJobId);
MonitorJob(methodJobId).Wait();
Console.WriteLine("Press ENTER to run the next job.");
Console.ReadLine();

string twinUpdateJobId = Guid.NewGuid().ToString();

StartTwinUpdateJob(twinUpdateJobId);
MonitorJob(twinUpdateJobId).Wait();
Console.WriteLine("Press ENTER to exit.");
Console.ReadLine();

作業内容を保存し、ソリューションを構築します。

アプリの実行

これで、アプリを実行する準備が整いました。

Visual Studio ソリューションエクスプローラーでソリューションを右クリックし、 [スタートアッププロジェクトの設定] を選択します。
[共通プロパティ]>[スタートアッププロジェクト] の順に選択し、 [マルチスタートアッププロジェクト] を選択します。
SimulateDeviceMethods が一覧の一番上にあり、その後に ScheduleJob があることを確認します。両方のアクションを [開始] に設定し、 [OK] を選択します。
[開始] をクリックしてプロジェクトを実行するか、 [デバッグ] メニューに移動し、 [デバッグの開始] をクリックします。

デバイスとバックエンドアプリの両方からの出力が表示されます。

次の手順

この記事では、ダイレクトメソッドを実行してデバイスツインのプロパティを更新するようにジョブをスケジュールしました。

IoT Hub とデバイス管理パターンの調査を続けるには、「Raspberry Pi 3 B+ 参照イメージを使用した Device Update for Azure IoT Hub のチュートリアル」でイメージを更新してください。

次の方法で共有

ジョブのスケジュールとブロードキャスト (.NET)

前提条件

シミュレート対象デバイスアプリの作成

IoT ハブ接続文字列を取得する

ダイレクトメソッドを呼び出し、デバイスツインの更新を送信するジョブのスケジュール

アプリの実行

次の手順

フィードバック

その他のリソース

次の方法で共有

ジョブのスケジュールとブロードキャスト (.NET)

前提条件

シミュレート対象デバイス アプリの作成

IoT ハブ接続文字列を取得する

ダイレクト メソッドを呼び出し、デバイス ツインの更新を送信するジョブのスケジュール

アプリの実行

次の手順

フィードバック

その他のリソース

シミュレート対象デバイスアプリの作成

ダイレクトメソッドを呼び出し、デバイスツインの更新を送信するジョブのスケジュール