クイックスタート:初めての IoT Edge モジュールを Linux 仮想デバイスにデプロイする

[アーティクル]
07/08/2024

適用対象: IoT Edge 1.5 IoT Edge 1.4

重要

サポートされているリリースは、IoT Edge 1.5 LTS と IoT Edge 1.4 LTS です。 IoT Edge 1.4 LTS は、2024 年 11 月 12 日にサポートが終了します。以前のリリースの場合は、「IoT Edge を更新する」を参照してください。

このクイックスタートでは、コンテナー化されたコードを Linux IoT Edge 仮想デバイスに配置して、Azure IoT Edge をテストします。 IoT Edge を使用すると、ご利用のデバイス上のコードをリモートで管理できるため、より多くのワークロードをエッジに送信できます。このクイックスタートでは、IoT Edge デバイス用に Azure 仮想マシンを使用することをお勧めします。これにより、テストマシンをすばやく作成し、終了したら削除できます。

このクイックスタートでは、次の方法について説明します。

IoT Hub を作成します。
IoT Edge デバイスを IoT ハブに登録します。
IoT Edge ランタイムを仮想デバイスにインストールして開始します。
モジュールを IoT Edge デバイスにリモートで展開する。

デバイスとクラウドのクイックスタートのアーキテクチャの図。

このクイックスタートでは、IoT Edge デバイスとして構成された Linux 仮想マシンを作成する手順について説明します。その後、Azure portal からご自身のデバイスにモジュールを配置します。このクイックスタートで使用されているモジュールは、温度、湿度、圧力のデータを生成するシミュレートされたセンサーです。他の Azure IoT Edge チュートリアルでは、ここで行う作業を基盤としており、ビジネスに関する分析情報を得るためにシミュレートされたデータを分析する追加のモジュールを配置しています。

アクティブな Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

前提条件

Azure CLI の環境を準備します。

Azure Cloud Shell で Bash 環境を使用します。詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。
CLI リファレンスコマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
- ローカルインストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。認証プロセスを完了するには、ターミナルに表示される手順に従います。その他のサインインオプションについては、Azure CLI でのサインインに関するページを参照してください。
- 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。
- az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。最新バージョンにアップグレードするには、az upgrade を実行します。

クラウドリソース:

このクイックスタートで使用するすべてのリソースを管理するためのリソースグループです。このクイックスタートと以下のチュートリアルでは、リソースグループ名の例 IoTEdgeResources を使用しています。
```
az group create --name IoTEdgeResources --location westus2
```

IoT Hub の作成

このクイックスタートでは、最初に Azure CLI を使用して IoT ハブを作成します。

クラウドで IoT ハブを作成する方法の図。

このクイックスタートでは無料レベルの IoT Hub を使用できます。 IoT Hub を以前に使用したことがあり、ハブを作成済みである場合は、その IoT ハブを使用することができます。

次のコードにより、無料の F1 ハブがリソースグループ IoTEdgeResources に作成されます。 {hub_name} は、実際の IoT ハブの一意の名前に置き換えてください。 IoT ハブの作成には数分かかることがあります。

az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1 --partition-count 2

サブスクリプションに無料のハブが既に 1 つあるためにエラーが発生する場合は、SKU を S1 に変更します。各サブスクリプションで使用できる無料 IoT ハブは 1 つのみです。 IoT ハブの名前が利用できないというエラーが発生した場合、自分以外のだれかが既にその名前のハブを所有していることを意味します。新しい名前を試してください。

IoT Edge デバイスを登録する

新しく作成された IoT ハブに IoT Edge デバイスを登録します。

IoT Hub ID でデバイスを登録する方法の図。

お使いの IoT ハブと通信できるように、IoT Edge デバイスのデバイス ID を作成します。デバイス ID はクラウドに置かれるので、デバイスの一意の接続文字列を使用して、物理デバイスとデバイス ID とを関連付けることになります。

IoT Edge デバイスは、一般的な IoT デバイスとは異なる動作をし、別に管理できるため、この ID は IoT Edge デバイス用として --edge-enabled フラグで宣言します。

Azure Cloud Shell で、次のコマンドを入力して、myEdgeDevice という名前のデバイスをハブに作成します。
```
az iot hub device-identity create --device-id myEdgeDevice --edge-enabled --hub-name {hub_name}
```
iothubowner ポリシーキーに関するエラーが表示された場合は、Cloud Shell で最新バージョンの azure-iot 拡張機能が実行されていることを確認してください。
デバイスの接続文字列を確認します。この接続文字列により、IoT Hub 内で物理デバイスとその ID をリンクさせます。これには、IoT ハブの名前、デバイスの名前、2 つの間の接続を認証する共有キーが含まれています。次のセクションで IoT Edge デバイスを設定するときに、この接続文字列についてもう一度触れます。
```
az iot hub device-identity connection-string show --device-id myEdgeDevice --hub-name {hub_name}
```
たとえば、接続文字列は HostName=contoso-hub.azure-devices.net;DeviceId=myEdgeDevice;SharedAccessKey=<DEVICE_SHARED_ACCESS_KEY> のようになります。

IoT Edge デバイスを構成する

Azure IoT Edge ランタイムがインストールされた仮想マシンを作成します。

デバイスでランタイムを開始する方法の図。

IoT Edge ランタイムはすべての IoT Edge デバイスに展開されます。これは 3 つのコンポーネントで構成されます。 IoT Edge セキュリティデーモンは、IoT Edge デバイスが起動するたびに開始され、IoT Edge エージェントを起動してデバイスをブートストラップします。 IoT Edge エージェントは、IoT Edge ハブなど、IoT Edge デバイス上のモジュールの展開と監視を容易にします。 IoT Edge ハブは、IoT Edge デバイス上のモジュール間、およびデバイスと IoT ハブの間の通信を管理します。

ランタイムの構成中に、デバイスの接続文字列を入力します。これは、Azure CLI から取得した文字列です。この文字列によって、Azure 内の IoT Edge デバイス ID と物理デバイスとが関連付けられます。

IoT Edge デバイスを展開する

このセクションでは、Azure Resource Manager テンプレートを使用して新しい仮想マシンを作成し、そこに IoT Edge ランタイムをインストールします。代わりにご自分の Linux デバイスを使用する場合は、1 つの Linux IoT Edge デバイスを手動でプロビジョニングする方法に関するページのインストール手順を行ってから、このクイックスタートに戻ることができます。

[Azure へのデプロイ] ボタンまたは CLI コマンドを使用して、事前構築済みの iotedge-vm-deploy テンプレートに基づいて IoT Edge デバイスを作成します。

IoT Edge Azure Resource Manager テンプレートを使用してデプロイします。

bash または Cloud Shell ユーザーの場合は、次のコマンドをテキストエディターにコピーし、プレースホルダーのテキストを実際の情報に置き換えてから、bash または Cloud Shell ウィンドウにコピーします。

az deployment group create \
--resource-group IoTEdgeResources \
--template-uri "https://raw.githubusercontent.com/Azure/iotedge-vm-deploy/main/edgeDeploy.json" \
--parameters dnsLabelPrefix='<REPLACE_WITH_VM_NAME>' \
--parameters adminUsername='azureUser' \
--parameters deviceConnectionString=$(az iot hub device-identity connection-string show --device-id myEdgeDevice --hub-name <REPLACE_WITH_HUB_NAME> -o tsv) \
--parameters authenticationType='password' \
--parameters adminPasswordOrKey="<REPLACE_WITH_PASSWORD>"

PowerShell ユーザーの場合は、次のコマンドを PowerShell ウィンドウにコピーし、プレースホルダーのテキストを実際の情報に置き換えます。

az deployment group create `
--resource-group IoTEdgeResources `
--template-uri "https://raw.githubusercontent.com/Azure/iotedge-vm-deploy/main/edgeDeploy.json" `
--parameters dnsLabelPrefix='<REPLACE_WITH_VM_NAME>' `
--parameters adminUsername='azureUser' `
--parameters deviceConnectionString=$(az iot hub device-identity connection-string show --device-id myEdgeDevice --hub-name <REPLACE_WITH_HUB_NAME> -o tsv) `
--parameters authenticationType='password' `
--parameters adminPasswordOrKey="<REPLACE_WITH_PASSWORD>"

このテンプレートにより、以下のパラメーターが受け取られます。

パラメーター	説明
resource-group	リソースが作成されるリソースグループ。この記事全体で使用してきた既定の IoTEdgeResources を使用するか、サブスクリプションの既存のリソースグループの名前を指定します。
template-uri	使用している Resource Manager テンプレートへのポインター。
dnsLabelPrefix	仮想マシンのホスト名を作成するために使用される文字列。プレースホルダーテキストを仮想マシンの名前に置き換えます。
adminUsername	仮想マシンの管理者アカウントのユーザー名。例の azureUser を使用するか、新しいユーザー名を入力します。
deviceConnectionString	仮想マシンで IoT Edge ランタイムを構成するために使用される IoT Hub のデバイス ID の接続文字列。このパラメーター内の CLI コマンドで、接続文字列を取得します。プレースホルダーのテキストを実際の IoT ハブ名に置き換えます。
authenticationType	管理者アカウントの認証方法。このクイックスタートでは password 認証を使用しますが、このパラメーターを sshPublicKey に設定することもできます。
adminPasswordOrKey	管理者アカウントの SSH キーのパスワードまたは値。プレースホルダーのテキストをセキュリティで保護されたパスワードに置き換えます。パスワードは、12 文字以上で、小文字、大文字、数字、特殊文字の 4 つのうち 3 つを使用する必要があります。

デプロイが完了すると、仮想マシンに接続するための SSH 情報を含む JSON 形式の出力が CLI で受信されます。 outputs セクションの public SSH エントリの値をコピーします。たとえば、SSH コマンドは ssh azureUser@edge-vm.westus2.cloudapp.azure.com のようになります。

IoT Edge ランタイムの状態を確認する

このクイックスタートの残りのコマンドは、IoT Edge デバイス自体で実行します。これにより、デバイスの動作を実際に確認することができます。仮想マシンを使用している場合は、設定した管理者のユーザー名と、デプロイコマンドによって出力された DNS 名を使用して、そのマシンに接続します。 DNS 名は、Azure portal の仮想マシンの概要ページでも確認できます。次のコマンドを使用して、仮想マシンに接続します。 {admin username} と {DNS name} を独自の値に置き換えます。

ssh {admin username}@{DNS name}

仮想マシンに接続したら、ランタイムが IoT Edge デバイスに正常にインストールされ、構成されていることを確認します。

IoT Edge が実行されていることを確認します。次のコマンドを実行すると、IoT Edge が実行されている場合は [OK] の状態が返されます。そうでない場合は、サービスエラーが表示されます。
```
sudo iotedge system status
```
ヒント

iotedge コマンドの実行には、昇格された特権が必要です。 IoT Edge ランタイムのインストール後に初めてマシンにサインインし直すと、アクセス許可は自動的に更新されます。それまでは、コマンドの前に sudo を使用します。
サービスのトラブルシューティングが必要な場合は、サービスログを取得します。
```
sudo iotedge system logs
```
IoT Edge デバイス上で実行されているすべてのモジュールを表示します。初めてサービスが開始されたので、edgeAgent モジュールが実行されていることのみが確認できます。 edgeAgent モジュールが既定で実行され、デバイスにデプロイする追加モジュールのインストールと起動を支援します。
```
sudo iotedge list
```

IoT Edge デバイスの構成はこれで完了です。クラウドからモジュールをデプロイして実行することができます。

モジュールを展開する

Azure IoT Edge デバイスをクラウドから管理し、IoT Hub に利用統計情報を送信するモジュールを展開します。

クラウドからデバイスにモジュールをデプロイする方法の図。

Azure IoT Edge の主要な機能の 1 つは、クラウドからお客様の IoT Edge デバイスにコードをデプロイすることです。 IoT Edge モジュールは、コンテナーとして実装されている実行可能ファイルのパッケージです。このセクションでは、Microsoft アーティファクトレジストリの IoT Edge モジュールのセクションから事前構築済みのモジュールをデプロイします。

このセクションでデプロイするモジュールはセンサーをシミュレートし、生成されたデータを送信します。シミュレートされたデータを開発とテストに使用できるため、このモジュールは IoT Edge の使用を開始する際にコードの一部として役に立ちます。このモジュールで行われる内容を正確に確認したい場合は、シミュレートされた温度センサーのソースコードをご覧いただけます。

次の手順に従って、最初のモジュールをデプロイします。

Azure portal にサインインして、お使いの IoT ハブに移動します。
左側のメニューの [デバイス管理] で、[デバイス] を選択します。
一覧からターゲット IoT Edge デバイスのデバイス ID を選択します。

新しい IoT Edge デバイスを作成すると、状態コード 417 -- The device's deployment configuration is not set が Azure portal に表示されます。この状態は正常であり、デバイスでモジュールのデプロイを受け取る準備ができていることを意味します。
上部のバーで [モジュールの設定] を選択します。

デバイスで実行するモジュールを選びます。自分でビルドしたモジュールまたはコンテナーレジストリ内のイメージから選択できます。このクイックスタートでは、Microsoft コンテナーレジストリからモジュールをデプロイします。
[IoT Edge モジュール] セクションで [追加] を選び、次に [IoT Edge モジュール] を選びます。

次のモジュール設定を更新します。

設定	Value
IoT モジュール名	`SimulatedTemperatureSensor`
画像の URL	`mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:latest`
再起動ポリシー	常時
必要な状態	実行中

[次へ: ルート] を選び、ルートの構成を続行します。
シミュレートされた温度モジュールから IoT Hub にすべてのメッセージを送信するルートを追加します。

設定値

名前 SimulatedTemperatureSensorToIoTHub

値 FROM /messages/modules/SimulatedTemperatureSensor/* INTO $upstream
確認と作成 をクリックします。
JSON ファイルを確認し、 [作成] を選択します。この JSON ファイルには、IoT Edge デバイスにデプロイするすべてのモジュールが定義されます。

Note

IoT Edge デバイスに新しいデプロイを送信しても、デバイスには何もプッシュされません。代わりに、デバイスから IoT Hub に対して、新しい指示のクエリが定期的に実行されます。更新されたデプロイマニフェストがデバイスによって検出されると、新しいデプロイに関する情報が使用されてクラウドからモジュールイメージがプルされ、ローカルでのモジュールの実行が開始されます。このプロセスには数分かかることがあります。

設定	値
名前	`SimulatedTemperatureSensorToIoTHub`
値	`FROM /messages/modules/SimulatedTemperatureSensor/* INTO $upstream`

モジュールのデプロイの詳細が作成されると、ウィザードは [デバイスの詳細] ページに戻ります。 [モジュール] タブでデプロイの状態を確認します。

$edgeAgent、 $edgeHub、および SimulatedTemperatureSensor という 3 つのモジュールが表示されています。 [デバイス別に報告] ではなく [デプロイで指定] の下に [はい] となっているモジュールが 1 つ以上ある場合、それらはまだ IoT Edge デバイスによって起動されている途中です。数分待ってから、ページを更新します。

モジュールのデプロイで問題が発生した場合は、「Azure portal から IoT Edge デバイスのトラブルシューティングを行う」を参照してください。

生成されたデータを表示する

このクイックスタートでは、新しい IoT Edge デバイスを作成し、そこに IoT Edge ランタイムをインストールしました。その後、Azure portal を使用して、IoT Edge モジュールをデプロイし、デバイス自体を変更せずにモジュールをデバイスで実行しました。

この場合、プッシュしたモジュールによって、後でテストするために使用できるサンプル環境データが生成されます。シミュレートされたセンサーは、マシンと、マシンの周囲の環境の両方を監視します。たとえば、このセンサーは、サーバールーム、工場のフロア、または風力タービンに配置されている可能性があります。メッセージには、周囲の温度と湿度、機械の温度と圧力、タイムスタンプが含まれます。 IoT Edge のチュートリアルでは、このモジュールによって作成されたデータを分析用のテストデータとして使用します。

再び IoT Edge デバイスでコマンドプロンプトを開くか、Azure CLI から SSH 接続を使用します。 IoT Edge デバイスで、クラウドからデプロイされたモジュールが実行されていることを確認します。

sudo iotedge list

温度センサーモジュールから送信されているメッセージを確認します。

sudo iotedge logs SimulatedTemperatureSensor -f

ヒント

IoT Edge のコマンドでは、モジュール名を参照する際に大文字と小文字が区別されます。

リソースをクリーンアップする

IoT Edge のチュートリアルに進む場合は、このクイックスタートで登録および設定したデバイスを使用できます。それ以外の場合は、課金されないようにするために、作成した Azure リソースを削除してもかまいません。

新しいリソースグループで仮想マシンと IoT ハブを作成した場合、そのグループと関連するすべてのリソースを削除できます。リソースグループの内容を再確認して、残しておくべきものがないことを確認してください。グループ全体を削除したくない場合は、リソースを個別に削除してもかまいません。

重要

リソースグループを削除すると、元に戻すことができません。

IoTEdgeResources グループを削除します。リソースグループを削除するのに数分かかる場合があります。

az group delete --name IoTEdgeResources --yes

リソースグループが削除されたことは、リソースグループの一覧を表示することによって確認できます。

az group list

次のステップ

このクイックスタートでは、IoT Edge デバイスを作成し、Azure IoT Edge クラウドインターフェイスを使用してコードをデバイスにデプロイしました。その環境に関する生データを生成するテストデバイスができあがりました。

次のチュートリアルでは、Azure portal からデバイスのアクティビティと正常性を監視する方法について説明します。

IoT Edge デバイスを監視する

次の方法で共有

クイックスタート:初めての IoT Edge モジュールを Linux 仮想デバイスにデプロイする

前提条件

IoT Hub の作成

IoT Edge デバイスを登録する

IoT Edge デバイスを構成する

IoT Edge デバイスを展開する

IoT Edge ランタイムの状態を確認する

モジュールを展開する

生成されたデータを表示する

リソースをクリーンアップする

次のステップ

フィードバック

その他のリソース

次の方法で共有

クイック スタート:初めての IoT Edge モジュールを Linux 仮想デバイスにデプロイする

前提条件

IoT Hub の作成

IoT Edge デバイスを登録する

IoT Edge デバイスを構成する

IoT Edge デバイスを展開する

IoT Edge ランタイムの状態を確認する

モジュールを展開する

生成されたデータを表示する

リソースをクリーンアップする

次のステップ

フィードバック

その他のリソース

クイックスタート:初めての IoT Edge モジュールを Linux 仮想デバイスにデプロイする