Azure Stack Edge Pro 上のファイルを移動する C# IoT Edge モジュールを開発する

[アーティクル]
11/15/2023

適用対象: はい (Pro GPU SKU の場合) Azure Stack Edge Pro - GPU はい (Pro 2 SKU の場合) Azure Stack Edge Pro 2 はい (Pro R SKU の場合) Azure Stack Edge Pro R はい (Mini R SKU の場合) Azure Stack Edge Mini R

この記事では、Azure Stack Edge Pro デバイスにデプロイするために、IoT Edge モジュールを作成する方法を説明します。 Azure Stack Edge Pro は、データを処理してネットワーク経由で Azure に送信できるストレージソリューションです。

Azure IoT Edge モジュールを Azure Stack Edge Pro と共に使用して、データを変換し、Azure に移動することができます。この記事で使用されるモジュールによって、Azure Stack Edge Pro デバイス上でファイルをローカル共有からクラウド共有にコピーするロジックが実装されます。

この記事では、次のことについて説明します。

モジュールを格納して管理するコンテナーレジストリを作成する (Docker イメージ)。
IoT Edge モジュールを作成して Azure Stack Edge Pro デバイスにデプロイする。

IoT Edge モジュールについて

Azure Stack Edge Pro デバイスでは、IoT Edge モジュールをデプロイして実行できます。 Edge モジュールは基本的には Docker コンテナーであり、デバイスからのメッセージの取り込み、メッセージの変換、IoT Hub へのメッセージの送信など、特定のタスクを実行できます。この記事では、Azure Stack Edge Pro デバイス上でファイルをローカル共有からクラウド共有にコピーするモジュールを作成します。

ファイルは、Azure Stack Edge Pro デバイス上のローカル共有に書き込まれます。
ファイルイベントジェネレーターは、ローカル共有に書き込まれる各ファイルに対して、ファイルイベントを作成します。ファイルイベントは、ファイルが変更されたときも生成されます。その後ファイルイベントは (IoT Edge ランタイムの) IoT Edge Hub に送信されます。
IoT Edge のカスタムモジュールは、ファイルイベントを処理して、ファイルへの相対パスも含むファイルイベントオブジェクトを作成します。モジュールは、相対ファイルパスを使用して絶対パスを生成し、ファイルをローカル共有からクラウド共有にコピーします。その後、モジュールはファイルをローカル共有から削除します。

Azure Stack Edge Pro での Azure IoT Edge モジュールのしくみ

ファイルがクラウド共有に移動すると、ユーザーの Azure Storage アカウントに自動的にアップロードされます。

前提条件

開始する前に、以下の項目があることを確認します:

実行中の Azure Stack Edge Pro デバイス。
- デバイスには、関連付けられた IoT Hub リソースもある。
- デバイスで Edge コンピューティングロールが構成されている。詳細については、Azure Stack Edge Pro での「コンピューティングの構成」をご覧ください。
次の開発リソース。
- Visual Studio Code。
- Visual Studio Code 用の C# (OmniSharp を使用) 拡張機能
- Visual Studio Code 用の Azure IoT Edge 拡張機能
- .NET Core 2.1 SDK。
- Docker CE。ソフトウェアをダウンロードしてインストールするには、アカウントの作成が必要になる場合があります。

コンテナーレジストリを作成する

Azure Container Registry は、プライベート Docker コンテナーイメージを保存および管理する Azure のプライベート Docker レジストリです。クラウドで使用できる 2 つの一般的な Docker レジストリサービスは、Azure Container Registry と Docker Hub です。この記事では、Container Registry を使用します。

ブラウザーから、Azure portal にサインインしてください。
[Create a resource] (リソースの作成) > [コンテナー] > [Container Registry] を選択します。 Create をクリックしてください。
[プロバイダー]:
1. 5 - 50 文字の英数字を含む、Azure 内で一意のレジストリ名。
2. サブスクリプションを選択します。
3. 新しいリソースグループを作成するか、既存のリソースグループを選択します。
4. [場所] を選択します。この場所は、Azure Stack Edge リソースと関連付けられているのと同じ場所にすることをお勧めします。
5. [管理者ユーザー] を [有効] に切り替えます。
6. SKU を [Basic] に設定します。
［作成］ を選択します
コンテナーレジストリが作成されたら、その場所を参照し、[アクセスキー] を選択します。
ログインサーバー、ユーザー名、およびパスワードの値をコピーします。これらの値は、後で Docker イメージをレジストリに発行し、レジストリの資格情報を Azure IoT Edge ランタイムに追加する際に使用します。

IoT Edge モジュールプロジェクトを作成する

次のステップでは、.NET Core 2.1 SDK に基づいて IoT Edge モジュールプロジェクトを作成します。プロジェクトでは、Visual Studio Code と Azure IoT Edge の拡張機能を使用します。

新しいソリューションの作成

独自のコードでカスタマイズできる C# ソリューションテンプレートを作成します。

Visual Studio Code で、[表示] > [コマンドパレット] を選択して、VS Code コマンドパレットを開きます。
コマンドパレットで、Azure: Sign in コマンドを入力して実行し、手順に従って Azure アカウントにサインインします。既にサインインしている場合、この手順は省略できます。
コマンドパレットで、Azure IoT Edge:New IoT Edge solution コマンドを入力して実行します。コマンドパレットで、次の情報を指定してソリューションを作成します。
1. ソリューションの作成先フォルダーを選択します。
2. ソリューションの名前を指定するか、既定の EdgeSolution をそのまま使用します。
3. モジュールテンプレートとして C# Module を選択します。
4. 既定のモジュール名を指定する名前で置き換えます。この場合は FileCopyModule です。
5. 前のセクションで作成したコンテナーレジストリを、最初のモジュールのイメージリポジトリとして指定します。 localhost:5000 を、コピーしたログインサーバーの値に置き換えます。
  
  最終的な文字列は、<Login server name>/<Module name> のようになります。この例では、文字列は mycontreg2.azurecr.io/filecopymodule です。
[ファイル] > [フォルダーを開く] に移動します。
先に作成した [EdgeSolution] フォルダーを選択します。 VS Code ウィンドウに、IoT Edge ソリューションワークスペースと 5 つの上位レベルコンポーネントが表示されます。この記事では、.vscode フォルダー、.gitignore ファイル、.env ファイル、deployment.template.json** は編集しません。

変更するコンポーネントは、モジュールフォルダーだけです。このフォルダーには、モジュールの C# コードと、モジュールをコンテナーイメージとしてビルドするための Docker ファイルが含まれています。

カスタムコードでモジュールを更新する

VS Code エクスプローラーで、[モジュール] > [FileCopyModule] > [Program.cs] の順に開きます。
[FileCopyModule] 名前空間の上部で、後で使用する型として次の using ステートメントを追加します。 Microsoft.Azure.Devices.Client.Transport.Mqtt は、メッセージを IoT Edge Hub に送信するためのプロトコルです。
```
namespace FileCopyModule
{
    using Microsoft.Azure.Devices.Client.Transport.Mqtt;
    using Newtonsoft.Json;
```

InputFolderPath と OutputFolderPath 変数を Program クラスに追加します。

class Program
    {
        static int counter;
        private const string InputFolderPath = "/home/input";
        private const string OutputFolderPath = "/home/output";

前の手順の直後に、FileEvent クラスを追加してメッセージ本文を定義します。

/// <summary>
/// The FileEvent class defines the body of incoming messages. 
/// </summary>
private class FileEvent
{
    public string ChangeType { get; set; }

    public string ShareRelativeFilePath { get; set; }

    public string ShareName { get; set; }
}

Init メソッドでは、コードによって ModuleClient オブジェクトが作成され、構成されます。このオブジェクトにより、モジュールは MQTT プロトコルを使用してローカルの Azure IoT Edge ランタイムに接続し、メッセージを送受信することができます。 Init メソッドで使用される接続文字列は、IoT Edge ランタイムによってモジュールに提供されます。コードによって、IoT Edge ハブから input1 エンドポイントを介してメッセージを受信するための FileCopy コールバックが登録されます。 Init メソッドを次のコードに置き換えます。

/// <summary>
/// Initializes the ModuleClient and sets up the callback to receive
/// messages containing file event information
/// </summary>
static async Task Init()
{
    MqttTransportSettings mqttSetting = new MqttTransportSettings(TransportType.Mqtt_Tcp_Only);
    ITransportSettings[] settings = { mqttSetting };

    // Open a connection to the IoT Edge runtime
    ModuleClient ioTHubModuleClient = await ModuleClient.CreateFromEnvironmentAsync(settings);
    await ioTHubModuleClient.OpenAsync();
    Console.WriteLine("IoT Hub module client initialized.");

    // Register callback to be called when a message is received by the module
    await ioTHubModuleClient.SetInputMessageHandlerAsync("input1", FileCopy, ioTHubModuleClient);
}

PipeMessage メソッドのコードを削除し、その代わりに FileCopy のコードを挿入します。

    /// <summary>
    /// This method is called whenever the module is sent a message from the IoT Edge Hub.
    /// This method deserializes the file event, extracts the corresponding relative file path, and creates the absolute input file path using the relative file path and the InputFolderPath.
    /// This method also forms the absolute output file path using the relative file path and the OutputFolderPath. It then copies the input file to output file and deletes the input file after the copy is complete.
    /// </summary>
    static async Task<MessageResponse> FileCopy(Message message, object userContext)
    {
        int counterValue = Interlocked.Increment(ref counter);

        try
        {
            byte[] messageBytes = message.GetBytes();
            string messageString = Encoding.UTF8.GetString(messageBytes);
            Console.WriteLine($"Received message: {counterValue}, Body: [{messageString}]");

            if (!string.IsNullOrEmpty(messageString))
            {
                var fileEvent = JsonConvert.DeserializeObject<FileEvent>(messageString);

                string relativeFileName = fileEvent.ShareRelativeFilePath.Replace("\\", "/");
                string inputFilePath = InputFolderPath + relativeFileName;
                string outputFilePath = OutputFolderPath + relativeFileName;

                if (File.Exists(inputFilePath))                
                {
                    Console.WriteLine($"Moving input file: {inputFilePath} to output file: {outputFilePath}");
                    var outputDir = Path.GetDirectoryName(outputFilePath);
                    if (!Directory.Exists(outputDir))
                    {
                        Directory.CreateDirectory(outputDir);
                    }

                    File.Copy(inputFilePath, outputFilePath, true);
                    Console.WriteLine($"Copied input file: {inputFilePath} to output file: {outputFilePath}");
                    File.Delete(inputFilePath);
                    Console.WriteLine($"Deleted input file: {inputFilePath}");
                } 
                else
                {
                    Console.WriteLine($"Skipping this event as input file doesn't exist: {inputFilePath}");   
                }
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("Caught exception: {0}", ex.Message);
            Console.WriteLine(ex.StackTrace);
        }

        Console.WriteLine($"Processed event.");
        return MessageResponse.Completed;
    }

このファイルを保存します。
このプロジェクト用の既存のコードサンプルをダウンロードすることもできます。このサンプルでは、program.cs ファイルに対して保存したファイルを検証できます。

IoT Edge ソリューションのビルド

前のセクションで IoT Edge ソリューションを作成して、ファイルをローカル共有からクラウド共有にコピーするためにコードを FileCopyModule に追加しました。次は、ソリューションをコンテナーイメージとしてビルドして、それをコンテナーレジストリにプッシュする必要があります。

VSCode で、[Terminal] (ターミナル) > [New Terminal] (新しいターミナル) に移動して、新しい Visual Studio Code 統合ターミナルを開きます。
統合ターミナルで次のコマンドを入力して、Docker にサインインします。

docker login <ACR login server> -u <ACR username>

コンテナーレジストリからコピーしたログインサーバーとユーザー名を使用します。
入力を求められたら、パスワードを入力します。ログインサーバー、ユーザー名、パスワードは、Azure portal のコンテナーレジストリ内の [アクセスキー] から取得することもできます。
資格情報を提供すると、モジュールイメージを Azure Container Registry にプッシュできます。 VS Code エクスプローラーで、module.json ファイルを右クリックし、[Build and Push IoT Edge solution] (IoT Edge ソリューションのビルドとプッシュ) を選択します。

Visual Studio Code でソリューションをビルドすると、統合ターミナルで 2 つのコマンドが実行されます。docker build と docker push です。この 2 つのコマンドによって、ご自身のコードがビルドされ、CSharpModule.dll がコンテナー化されたうえで、ソリューションを初期化したときに指定したコンテナーレジストリにコードがプッシュされます。

モジュールプラットフォームを選択するように求められます。 Linux に対応する amd64 を選択します。

重要

Linux のモジュールのみがサポートされています。

次の警告が表示されますが、無視できます。

Program.cs(77,44): warning CS1998: This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread. (この非同期メソッドには 'await' 演算子がないため、同期的に実行されます。'await' 演算子を使用して非ブロッキング API 呼び出しを待機するか、'await Task.Run(...)' を使用してバックグラウンドのスレッドに対して CPU 主体の処理を実行することを検討してください。)
タグを含む完全なコンテナーイメージアドレスは、VS Code 統合ターミナルで確認できます。イメージアドレスは、<repository>:<version>-<platform> の形式で、module.json ファイルの情報から作成されます。この記事では、mycontreg2.azurecr.io/filecopymodule:0.0.1-amd64 のようになります。

次のステップ

Azure Stack Edge Pro でこのモジュールをデプロイして実行するには、「モジュールの追加」の手順をご覧ください。

Azure Stack Edge Pro 上のファイルを移動する C# IoT Edge モジュールを開発する

IoT Edge モジュールについて

前提条件

コンテナー レジストリを作成する

IoT Edge モジュール プロジェクトを作成する