Visual Studio 2022 を使用して、Azure IoT Edge用のモジュールを開発およびデバッグする

1. Solution Explorerで、メイン プロジェクトの名前を右クリックし、 ランタイム バージョン IoT Edgeを設定します。

   'Set IoT Edge Runtime version' という名前のメニュー項目を検索して選択する方法のスクリーンショット

2. ドロップダウン メニューを使用して、IoT Edge デバイスが実行されているランタイム バージョンを選択し、OK を選択して変更を保存します。 変更が行われなかった場合は、[キャンセル] を選択して終了します。

   拡張機能には、最新のランタイム バージョンの選択は含まれません。 ランタイム バージョンを 1.2 より高く設定するには、deployment.debug.template.json配置マニフェスト ファイル を 開きます。 システム ランタイム モジュール イメージ edgeAgent および edgeHub のランタイム バージョンを変更します。 たとえば、ランタイム バージョン 1.5 IoT Edge使用するには、配置マニフェスト ファイルで次の行を変更します。

   "systemModules": {
      "edgeAgent": {
       //...
         "image": "mcr.microsoft.com/azureiotedge-agent:1.5"
       //...
      "edgeHub": {
      //...
         "image": "mcr.microsoft.com/azureiotedge-hub:1.5",
      //...
   

3. バージョンを変更した場合は、プロジェクトの名前を右クリックして配置マニフェストを再生成し、Generate deployment for IoT Edge を選択します。 これにより、配置テンプレートに基づいて配置マニフェストが生成され、Visual Studio プロジェクトの config フォルダーに配置されます。

1. deployment.debug.template.json 配置マニフェスト ファイルを開きます。 deployment マニフェストは、ターゲット IoT Edge デバイスで構成するモジュールについて説明する JSON ドキュメントです。

2. システム ランタイム モジュール イメージ edgeAgent および edgeHub のランタイム バージョンを変更します。 たとえば、ランタイム バージョン 1.5 IoT Edge使用するには、配置マニフェスト ファイルで次の行を変更します。

   "systemModules": {
       "edgeAgent": {
       //...
           "image": "mcr.microsoft.com/azureiotedge-agent:1.5",
       //...
       "edgeHub": {
       //...
           "image": "mcr.microsoft.com/azureiotedge-hub:1.5",
       //...
   

シミュレーターを使用したデバッグ

Azure IoT EdgeHub Dev Tool は、ローカル開発とデバッグエクスペリエンスを提供します。 このツールは、IoT Edge ランタイムなしでモジュールIoT Edge開始するのに役立ちます。これにより、IoT Edgeモジュールとソリューションをローカルで作成、開発、テスト、実行、デバッグできます。 テストするために、イメージをコンテナー レジストリにプッシュしたり、それらをデバイスに配置したりする必要はありません。

詳細については、「Azure IoT EdgeHub Dev Tool を参照してください。

Visual Studioでツールを初期化するには:

1. Azure ポータルまたはAzure CLIから、IoT HubにあるIoT Edgeデバイスの接続文字列を取得します。

   CLI を使用してconnection stringを取得する場合は、次のコマンドを使用します。"[device_id]" と "[hub_name]" を実際の値に置き換えます。

   az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]
   

2. Visual Studioの Tools メニューから、Azure IoT Edge Tools>Setup IoT Edge Simulator を選択します。

3. connection stringを貼り付け、OK を選択>。

1 つのモジュールをビルドしてデバッグする

通常は、複数のモジュールを含むソリューション全体内で実行する前に、各モジュールをテストしてデバッグする必要があります。 IoT Edge シミュレーター ツールを使用すると、ポート 53000 経由の送信メッセージを分離して 1 つのモジュールを実行できます。

1. Solution Explorer で、モジュール プロジェクト フォルダー (たとえば、IotEdgeModule1) を選択して強調表示します。 カスタム モジュールをスタートアップ プロジェクトとして設定します。 メニューから [プロジェクト スタートアップ プロジェクトとして設定] を選択します。

2. F5 を押すか、実行ツール バー ボタンを選択して、1 つのモジュールのIoT Edge シミュレーターを起動します。 最初は 10 秒から 20 秒かかる場合があります。

   モジュールの実行方法を示すスクリーンショット。

3. モジュールが正常に初期化されると、.NET Core コンソール アプリ ウィンドウが表示されます。

4. モジュールを検査するためのブレークポイントを設定します。

   • C# で開発する場合は 内の 関数にブレークポイントを設定します。
   • C を使用する場合は main.c 内の 関数にブレークポイントを設定します。

5. メッセージを送信してモジュールをテストします。 単一のモジュールをデバッグする場合、シミュレーターは既定のポート53000でメッセージをリッスンします。 モジュールにメッセージを送信するには、 Git Bash や WSL Bash などのコマンド シェルから次の curl コマンドを実行します。

   curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data":"hello world"}' http://localhost:53000/api/v1/messages
   

   URL で右中かっこ/右角かっこが一致しないエラーが発生した場合、代わりに次のコマンドを試してください。

   curl --header "Content-Type: application/json" --request POST --data "{\"inputName\": \"input1\", \"data\", \"hello world\"}"  http://localhost:53000/api/v1/messages
   

   

   ブレークポイントがトリガーされるはずです。 デバッガーの実行中に見つかった Visual Studio Locals ウィンドウで変数を監視できます。 Debug>Windows>Locals に移動します。

   Bash またはシェルに、 という確認が表示されるはずです。

   .NET コンソールに次の情報が表示されます。

   IoT Hub module client initialized.
   Received message: 1, Body: [hello world]
   

6. Ctrl + F5 キーを押すか停止ボタンをクリックして、デバッグを停止します。

複数のモジュールのビルドとデバッグ

1 つのモジュールの開発が完了したら、複数のモジュールを含むソリューション全体を実行してデバッグします。 IoT Edge シミュレーター ツールを使用すると、メッセージ ルーティング用のシミュレートされた edgeHub を含め、配置マニフェストで定義されているすべてのモジュールを実行できます。 この例では、2 つのカスタム モジュールとシミュレートされた温度センサー モジュールを実行します。 シミュレートされた温度センサー モジュールからのメッセージは、各カスタム モジュールにルーティングされます。

1. Solution Explorer で、メイン プロジェクト フォルダーを右クリックして、ソリューションに 2 つ目のモジュールを追加します。 メニューで Add>New IoT Edge Module を選択します。

   

2. Add module ウィンドウで、新しいモジュールに名前を付け、リポジトリ URL の localhost:5000 部分を、前と同様にAzure Container Registryログイン サーバーに置き換えます。

3. ファイルを開き、新しいモジュールが modules セクションに追加されていることを確認します。 新しいモジュールからIoT Hubにメッセージを送信するために、 の EdgeHub セクションにも新しいルートが追加されました。 シミュレートされた温度センサーから新しいモジュールにデータを送信するには、 の次のような行によって別のルートを追加します。 (2 か所) を独自のモジュール名に置き換えます。

   "sensorTo<NewModuleName>": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/<NewModuleName>/inputs/input1\")"
   

4. メイン プロジェクト (AzureIotEdgeApp1 など) を右クリックし、[スタートアップ プロジェクトとして設定] を選択します。 メイン プロジェクトをスタートアップ プロジェクトとして設定すると、ソリューション内のすべてのモジュールが実行されます。 これには、ソリューションに追加した両方のモジュール、シミュレートされた温度センサー モジュール、シミュレートされた Edge ハブが含まれます。

5. [F5] キーを押すか、実行ツールバー ボタンを選択してソリューションを実行します。 最初は 10 秒から 20 秒かかる場合があります。 このプロジェクトに必要なポートをバインドする可能性のある他の Docker コンテナーが実行中でないことを確認してください。

6. 2 つの .NET Core コンソール アプリ ウィンドウがモジュールごとに 1 つ表示されます。

7. モジュールを検査するためのブレークポイントを設定します。

   • C# で開発する場合は 内の 関数にブレークポイントを設定します。
   • C を使用する場合は main.c 内の 関数にブレークポイントを設定します。

8. 各モジュール内にブレークポイントを作成したら、F5 キーを押して複数のモジュールを同時に実行し、デバッグします。 複数の .NET Core コンソール アプリ ウィンドウが表示され、各ウィンドウは異なるモジュールを表します。

   

9. Ctrl + F5 キーを押すか停止ボタンをクリックして、デバッグを停止します。

イメージをビルドしてレジストリにプッシュする

モジュールを開発してデバッグしたら、モジュール イメージをビルドしてAzure Container Registryにプッシュします。 次に、モジュールを IoT Edge デバイスにデプロイします。

1. メイン IoT Edge プロジェクトを、個々のモジュールの 1 つではなく、スタートアップ プロジェクトとして設定します。

2. モジュール イメージに対して作成する構成として [デバッグ] または [リリース] を選択します。

   注

   Debug を選択すると、Visual Studioは Dockerfile.(amd64|windows-amd64).debug を使用して Docker イメージをビルドします。 これには、コンテナー イメージ内の .NET Core コマンド ライン デバッガー VSDBG が含まれます。 運用対応のIoT Edge モジュールの場合は、VSDBG なしで を使用する Dockerfile.(amd64|windows-amd64) 構成を使用します。

3. Azure Container Registry (ACR) などのプライベート レジストリを使用する場合は、次の Docker コマンドを使用してサインインします。 Azure ポータルのレジストリの Access キー ページからユーザー名とパスワードを取得します。

   docker login <ACR login server>
   

4. Azure Container Registry ログイン情報を、deployment.debug.template.json ファイルのランタイム設定に追加します。 レジストリ資格情報は、 ファイル (最も安全) に追加することも、 ファイルに直接追加することもできます。

   資格情報を ファイルに追加する:

   Solution Explorer で、ツール バー ボタン Show All Files を選択します。 ファイルが表示されます。 Azure Container Registryユーザー名とパスワードを .env ファイルに追加します。 これらの資格情報は、Azure ポータルのAzure Container Registryの Access Keys ページで見つけます。

   

       DEFAULT_RT_IMAGE=1.5
       CONTAINER_REGISTRY_USERNAME_myregistry=<my-registry-name>
       CONTAINER_REGISTRY_PASSWORD_myregistry=<my-registry-password>
   

   資格情報を deployment.debug.template.json に直接追加する

   資格情報をデプロイ テンプレートに直接追加する場合は、プレースホルダーを ACR 管理者のユーザー名、パスワード、レジストリ名に置き換えます。

         "settings": {
           "minDockerVersion": "v1.25",
           "loggingOptions": "",
           "registryCredentials": {
             "registry1": {
               "username": "<username>",
               "password": "<password>",
               "address": "<registry name>.azurecr.io"
             }
           }
         }
   

   注

   この記事では、Azure Container Registryの管理者ログイン資格情報を使用します。これは、開発とテストのシナリオに便利です。 運用環境のシナリオに向けて準備ができたら、サービス プリンシパルのような最小限の特権で認証できるオプションを使用することをお勧めします。 詳細については、[コンテナー レジストリへのアクセスを管理する] を参照してください。

5. ローカル レジストリを使用する場合は、 ローカル レジストリを実行します。

6. 最後に、Solution Explorer でメイン プロジェクト フォルダーを右クリックし、Build と Push IoT Edge Modules を選択して、各モジュールの Docker イメージをビルドしてプッシュします。 これには数分かかる場合があります。 Visual Studioの出力コンソールに Finished Build and Push IoT Edge Modules. が表示されたら、完了です。

ソリューションのデプロイ

モジュール イメージをビルドしてAzure Container Registryにプッシュしたので、ソリューションを IoT Edge デバイスにデプロイします。 このチュートリアルには、配置マニフェスト テンプレートが既にあります。 そこから配置マニフェストを生成し、Azure CLI コマンドを使用して、AzureのIoT Edge デバイスにモジュールをデプロイします。

1. Visual Studio Solution Explorerでメインプロジェクトを右クリックし、IoT Edge のデプロイを生成を選択します。

   '配置の生成' メニュー項目の場所を示すスクリーンショット。

2. ローカル Visual Studioメイン プロジェクト フォルダーに移動し、config フォルダーを確認します。 ファイル パスは のようになるでしょう。 ここで、生成された配置マニフェスト ( など) を見つけます。

3. ファイルを開き、スキーマのバージョンが 1.2 に設定されていることを確認します。

    "$edgeHub": {
        "properties.desired": {
          "schemaVersion": "1.2",
          "routes": {
            "IotEdgeModule2022ToIoTHub": "FROM /messages/modules/IotEdgeModule2022/outputs/* INTO $upstream",
            "sensorToIotEdgeModule2022": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/IotEdgeModule2022/inputs/input1\")",
            "IotEdgeModule2022bToIoTHub": "FROM /messages/modules/IotEdgeModule2022b/outputs/* INTO $upstream"
          },
          "storeAndForwardConfiguration": {
            "timeToLiveSecs": 7200
          }
        }
      }
   

   ヒント

   Visual Studio 2022 のデプロイ テンプレートには、1.2 スキーマ バージョンが必要です。 1.1 または 1.0 にする必要がある場合は、デプロイが生成されるまで待機します ( で変更しないでください)。 デプロイを生成すると、既定で 1.2 スキーマが作成されます。 ただし、必要に応じて、生成されたマニフェストdeployment.amd64.debug.jsonを手動で変更してから、Azureに配置することができます。

   重要

   IoT Edge デバイスがデプロイされると、現在、スキーマ バージョン 1.2 (バージョン 1.1 は問題ありません) のAzure ポータルに正しく表示されません。ただし、これはまだIoT Hubで接続されており、Azure CLIを使用していつでも通信できるため、デバイスには影響しません。

   

4. 次に、Azure CLI コマンドを使用してマニフェストをデプロイしましょう。 Visual Studio Developer コマンド プロンプトを開き、config ディレクトリに変更します。

       cd config
   

5. IoT Edge デバイスのマニフェストを IoT Hub にデプロイします。 このコマンドによって、ソリューションで開発されたモジュールを使用するようにデバイスが構成されます。 配置マニフェストは、前の手順で作成し、config フォルダーに保存しました。 config フォルダーから次の配置コマンドを実行します。 、、 は、実際の値に置き換えます。 IoT HubにIoT Edgeデバイス ID が存在しない場合は、作成する必要があります。

       az iot edge set-modules --device-id [device id] --hub-name [hub name] --content [file path]
   

   たとえば、コマンドは次のようになります。

   az iot edge set-modules --device-id my-device-name --hub-name my-iot-hub-name --content deployment.amd64.debug.json
   

6. コマンドを実行すると、コマンド プロンプトに JSON で出力されたデプロイの確認が表示されます。

モジュールの Docker イメージをビルドする

モジュールを開発したら、IoT Edge デバイスにデプロイするためにコンテナー レジストリに格納するモジュール イメージをビルドします。

モジュールの Dockerfile を使用して、モジュールの Docker イメージをビルドします。

docker build --rm -f "<DockerFilePath>" -t <ImageNameAndTag> "<ContextPath>" 

たとえば、コマンド シェルがプロジェクト ディレクトリにあり、モジュール名が IotEdgeModule1 の場合は、次のコマンドを使用して、ローカル レジストリまたは Azure コンテナー レジストリのイメージをビルドします。

# Build the image for the local registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t localhost:5000/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

# Or build the image for an Azure Container Registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t myacr.azurecr.io/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

モジュールの Docker イメージをプッシュする

モジュール イメージをローカル レジストリまたはコンテナー レジストリにプッシュします。

docker push <ImageName>

次に例を示します。

# Push the Docker image to the local registry

docker push localhost:5000/iotedgemodule1:0.0.1-amd64

# Or push the Docker image to an Azure Container Registry
az acr login --name myacr
docker push myacr.azurecr.io/iotedgemodule1:0.0.1-amd64

IoT Edge デバイスにモジュールをデプロイします。

Visual Studioで、メイン プロジェクトで deployment.debug.template.json 配置マニフェスト ファイルを開きます。 deployment マニフェストは、ターゲット IoT Edge デバイスで構成するモジュールについて説明する JSON ドキュメントです。 デプロイする前に、Azure Container Registry資格情報、モジュール イメージ、および適切な createOptions 値を更新する必要があります。 createOption 値の詳細については、「IoT Edge モジュールのコンテナー作成オプションを構成する方法を参照してください。

1. Azure Container Registryを使用してモジュール イメージを格納する場合は、edgeAgent 設定の deployment.debug.template.json に資格情報を追加する必要があります。 たとえば、

   "modulesContent": {
   "$edgeAgent": {
     "properties.desired": {
       "schemaVersion": "1.1",
       "runtime": {
         "type": "docker",
         "settings": {
           "minDockerVersion": "v1.25",
           "loggingOptions": "",
           "registryCredentials": {
             "myacr": {
               "username": "myacr",
               "password": "<your_acr_password>",
               "address": "myacr.azurecr.io"
             }
           }
         }
       },
   //...
   

2. 画像 のプロパティの値を、レジストリにプッシュしたモジュール イメージ名に置き換えます。 たとえば、カスタム モジュール IotEdgeModule1 用にタグ付けされたイメージ をプッシュした場合は、イメージ プロパティの値を タグ値に置き換えます。

3. createOptions 値を、"展開テンプレートのシステムおよびカスタム モジュールごとに" 文字列化されたコンテンツに追加または置き換えます。

   たとえば、IotEdgeModule1 の イメージ と createOptions の設定は次のようになります。

   "IotEdgeModule1": {
   "version": "1.0.0",
   "type": "docker",
   "status": "running",
   "restartPolicy": "always",
   "settings": {
       "image": "myacr.azurecr.io/iotedgemodule1:0.0.1-amd64",
       "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}"
   }
   

IoT Edge Azure CLI set-modules コマンドを使用して、モジュールをAzure IoT Hubにデプロイします。 たとえば、deployment.debug.amd64.json ファイルで定義されているモジュールを IoT Hub my-iot-hub IoT Edge デバイス my-device にデプロイするには、次のコマンドを実行します。

az iot edge set-modules --hub-name my-iot-hub --device-id my-device --content ./deployment.debug.template.json --login "HostName=my-iot-hub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=<SharedAccessKey>"