対称キーを使用して IoT Edge for Linux on Windows デバイスを作成してプロビジョニングする

[アーティクル]
07/05/2022

適用対象: IoT Edge 1.1

重要

IoT Edge 1.1 のサポート終了日は、2022 年 12 月 13 日でした。本製品、サービス、テクノロジ、または API のサポート内容については、Microsoft 製品のライフサイクルに関するページをご確認ください。最新バージョンの IoT Edge への更新の詳細については、「 Update IoT Edge」を参照してください。

この記事では、IoT Edge for Linux on Windows デバイスを登録およびプロビジョニングするエンドツーエンドの手順について説明します。

IoT ハブに接続するすべてのデバイスには、cloud-to-device または device-to-cloud の通信の追跡に使用されるデバイス ID があります。デバイスをその接続情報で構成します。これには、IoT ハブホスト名、デバイス ID、IoT Hub に対して認証を行うためにデバイスで使用される情報が含まれます。

この記事の手順では、手動プロビジョニングと呼ばれるプロセスについて説明します。ここでは、1 つのデバイスを IoT ハブに接続します。手動プロビジョニングの場合、IoT Edge デバイスの認証には 2 つのオプションがあります。

対称キー: IoT Hub で新しいデバイス ID を作成すると、サービスによって 2 つのキーが作成されます。いずれかのキーをデバイスに配置すると、認証時にそのキーが IoT Hub に提示されます。

この認証方法は比較的すばやく開始できますが、それほど安全ではありません。
X.509 自己署名: 2 つの X.509 ID 証明書を作成し、デバイスに配置します。 IoT Hub で新しいデバイス ID を作成するときは、両方の証明書の拇印を指定します。デバイスでは IoT Hub に対して認証を行うときに、1 つの証明書が提示され、その証明書がその拇印と一致することが IoT によって検証されます。

この認証方法はより安全であり、運用環境のシナリオの場合に推奨されます。

この記事では、認証方法として対称キーを使用する方法について説明します。 X.509 証明書を使用する場合は、「x.509 証明書を使用して IoT Edge for Linux on Windows デバイスを作成およびプロビジョニングする」を参照してください。

Note

設定するデバイスが多数あり、それぞれを手動でプロビジョニングしたくない場合は、次の記事のいずれかを使用して、IoT Edge が IoT Hub Device Provisioning Service でどのように動作するかを確認してください。

前提条件

この記事では、IoT Edge デバイスを登録し、IoT Edge for Linux on Windows をインストールする方法について説明します。これらのタスクには、実行するために使用されるさまざまな前提条件とユーティリティがあります。次に進む前に、すべての前提条件が満たされていることを確認してください。

デバイス管理ツール

デバイスを登録する手順には、Azure portal、Visual Studio Code、または Azure CLI を使用できます。ユーティリティごとに個別の前提条件があります。

Azure サブスクリプション内の無料または標準の IoT ハブ。

Azure サブスクリプション内の無料または標準の IoT ハブ
ご使用の環境内の Azure CLI

Azure CLI のバージョンは、少なくとも 2.0.70 以降である必要があります。検証するには、az --version を使用します。このバージョンでは、az 拡張機能のコマンドがサポートされ、Knack コマンドフレームワークが導入されています。

デバイスの要件

以下の最小要件を備えた Windows デバイス:

システム要件
- Windows 10¹/11 (Pro、Enterprise、IoT Enterprise)
- Windows Server 2019¹/2022
  _{¹ 現在のすべての累積更新プログラムがインストールされた Windows 10 および Windows Server 2019 最小ビルド 17763。}
ハードウェア要件
- 最小空きメモリ容量: 1 GB
- 最小空きディスク領域:10 GB
仮想化サポート
- Windows 10 で Hyper-V を有効にします。詳細については、「Windows 10 上に Hyper-V をインストールする」を参照してください。
- Windows サーバーで、Hyper-V ロールをインストールし、既定のネットワークスイッチを作成します。詳細については、「Azure IoT Edge for Linux on Windows の入れ子になった仮想化」を参照してください。
- 仮想マシンで、入れ子になった仮想化を構成します。詳細については、入れ子になった仮想化に関するページを参照してください。
ネットワークのサポート
- Windows Server には既定のスイッチは付属していません。 EFLOW を Windows Server デバイスにデプロイする前に、仮想スイッチを作成する必要があります。詳細については、Windows 上の Linux のために仮想スイッチを作成することに関する記事を参照してください。
- デスクトップバージョンの Windows には、EFLOW のインストールに使用できる既定のスイッチが付属しています。必要な場合は、独自のカスタム仮想スイッチを作成できます。

ヒント

Azure IoT Edge for Linux on Windows のデプロイで GPU アクセラレーション対応の Linux モジュールを使用する場合は、いくつかの構成オプションを検討する必要があります。

お使いの GPU のアーキテクチャに応じて適切なドライバーをインストールする必要があり、Windows Insider Program ビルドを入手することが必要な場合があります。構成上の必要性を特定し、それらの前提条件を満たすには、「Azure IoT Edge for Linux on Windows 用の GPU アクセラレーション」を参照してください。

時間をとって、現時点で GPU アクセラレータの前提条件を満たしていることをご確認ください。インストール中に GPU アクセラレーションを使用する場合は、インストールプロセスを再起動する必要があります。

開発者用ツール

PowerShell または Windows Admin Center を使用して、IoT Edge デバイスを管理できます。ユーティリティごとに個別の前提条件があります。

PowerShell
Windows Admin Center

PowerShell を使用する場合は、次の手順に従って、Azure IoT Edge for Linux on Windows のインストールと Linux 仮想マシンのデプロイに使用するターゲットデバイスを準備してください。

ターゲットデバイスの実行ポリシーを AllSigned に設定します。現在の実行ポリシーは、管理者特権の PowerShell プロンプトで次のコマンドを使用して確認できます。
```
Get-ExecutionPolicy -List
```
local machine の実行ポリシーが AllSigned になっていない場合は、次のようにして実行ポリシーを設定できます。
```
Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
```

Azure IoT Edge for Linux on Windows PowerShell モジュールの詳細については、PowerShell 関数リファレンスを参照してください。

デバイスを登録する

デバイスを登録するには、好みに応じて Azure portal、Visual Studio Code、または Azure CLI を使用できます。

Azure portal の IoT Hubで、IoT Edge デバイスは、Edge 対応ではない IoT デバイスとは別に作成および管理されます。

Azure Portal にサインインし、IoT Hub に移動します。
左側のウィンドウで、メニューから [デバイス] を選択し、[デバイスを追加する] を選択します。
[デバイスの作成] ページで、次の情報を指定します。
- わかりやすいデバイス ID を作成します。このデバイス ID は、後で使用するのでメモしておいてください。
- [IoT Edge デバイス] のチェックボックスをオンにします。
- 認証の種類として [対称キー] を選択します。
- 認証キーを自動生成して、新しいデバイスをハブに接続するために、既定の設定を使用します。
[保存] を選択します。

az iot hub device-identity create コマンドを使用して、IoT ハブに新しいデバイス ID を作成します。次に例を示します。

az iot hub device-identity create --device-id device_id_here --hub-name hub_name_here --edge-enabled

このコマンドには、3 つのパラメーターが含まれます。

--device-id または -d: IoT ハブ内で一意のわかりやすい名前を指定します。
--hub-name または -n: IoT ハブの名前を指定します。
--edge-enabled または --ee: デバイスが IoT Edge デバイスであることを宣言します。

デバイスが IoT Hub に登録されたので、IoT Edge ランタイムのインストールとプロビジョニングを完了するために使用する情報を取得します。

登録済みデバイスを表示し、プロビジョニング情報を取得する

対称キー認証を使用するデバイスでは、IoT Edge ランタイムのインストールとプロビジョニングを完了するために接続文字列が必要です。

IoT ハブに接続するエッジ対応デバイスが、デバイス ページに一覧表示されます。 IoT Edge デバイスの種類で一覧をフィルター処理できます。

Azure portal、IoT Hub でデバイスを表示する方法を示すスクリーンショット。

デバイスを設定する準備ができたら、物理デバイスを IoT ハブ内でのその ID にリンクする接続文字列が必要です。

対称キーを使用して認証を行うデバイスでは、接続文字列をポータルでコピーできます。

ポータルの [デバイス] ページで、一覧から IoT Edge デバイス ID を選択します。
[プライマリ接続文字列] または [セカンダリ接続文字列] のどちらかの値をコピーします。

IoT ハブのすべてのデバイスを表示するには、az iot hub device-identity list コマンドを使用します。次に例を示します。

az iot hub device-identity list --hub-name hub_name_here

IoT Edge デバイスとして登録されたすべてのデバイスのプロパティ capabilities.iotEdge は true に設定されます。

デバイスを設定する準備ができたら、物理デバイスを IoT ハブ内でのその ID にリンクする接続文字列が必要です。 az iot hub device-identity connection-string show コマンドを使用すると、単一のデバイスの接続文字列が返されます。

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

ヒント

connection-string show コマンドは、Azure IoT 拡張機能のバージョン 0.9.8 で導入され、これによって、非推奨の show-connection-string コマンドが置き換えられました。このコマンドの実行中にエラーが発生した場合は、拡張機能のバージョンが 0.9.8 以降に更新されていることを確認してください。詳細情報と最新の更新プログラムについては、Azure CLI 用の Microsoft Azure IoT 拡張機能に関するページを参照してください。

device-id パラメーターの値は、大文字と小文字が区別されます。

デバイスで使用する接続文字列をコピーする場合は、接続文字列を囲んでいる引用符を含めないでください。

IoT Edge をインストールする

ターゲットデバイスに Azure IoT Edge for Linux on Windows をデプロイします。

PowerShell
Windows Admin Center

IoT Edge for Linux on Windows をターゲットデバイスにインストールします。

Note

下記の PowerShell の手順では、IoT Edge for Linux on Windows をローカルデバイスにデプロイする方法の概要を示しています。 PowerShell を使用してリモートターゲットデバイスにデプロイする場合は、リモート PowerShell を使用してリモートデバイスへの接続を確立し、そのデバイスでこれらのコマンドをリモートで実行することができます。

管理者特権の PowerShell セッションで、次の各コマンドを実行し、IoT Edge for Linux on Windows をダウンロードします。

$msiPath = $([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))
$ProgressPreference = 'SilentlyContinue'
Invoke-WebRequest "https://aka.ms/AzEflowMSI" -OutFile $msiPath

IoT Edge for Linux on Windows をデバイスにインストールします。
```
Start-Process -Wait msiexec -ArgumentList "/i","$([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))","/qn"
```
インストールコマンドに INSTALLDIR="<FULLY_QUALIFIED_PATH>" パラメーターと VHDXDIR="<FULLY_QUALIFIED_PATH>" パラメーターを追加することで、IoT Edge for Linux on Windows のカスタムインストールと VHDX ディレクトリを指定できます。たとえば、インストールに D:\EFLOW フォルダーを使用し、VHDX に D:\EFLOW-VHDX を使用する場合は、次の PowerShell コマンドレットを使用できます。
```
Start-Process -Wait msiexec -ArgumentList "/i","$([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))","/qn","INSTALLDIR=D:\EFLOW", "VHDXDIR=D:\EFLOW-VHDX"
```
ターゲットデバイスの実行ポリシーがまだ AllSigned に設定されていない場合、これを設定します。最新の実行ポリシーをチェックしたり実行ポリシーを AllSigned に設定したりするためのコマンドについては、PowerShell の前提条件を参照してください。
IoT Edge for Linux on Windows のデプロイを作成します。このデプロイによって Linux 仮想マシンが作成され、IoT Edge ランタイムが自動的にインストールされます。
```
Deploy-Eflow
```
ヒント

既定では Deploy-Eflow コマンドを実行すると、1 GB の RAM、1 つの仮想 CPU コア、16 GB のディスク領域を持つ Linux 仮想マシンを作成します。ですが、VM に必要なリソースは、デプロイするワークロードに大きく左右されます。ワークロードを処理するのに十分なメモリがなければ、VM は起動に失敗します。

Deploy-Eflow コマンドのオプションでパラメーターを指定することで、仮想マシンで使用できるリソースをカスタマイズできます。

たとえば下のコマンドでは、4 つの vCPU コア、4 GB の RAM (MB で表現)、20 GB のディスク領域を持つ仮想マシンを作成します。
```
Deploy-Eflow -cpuCount 4 -memoryInMB 4096 -vmDiskSize 20
```
使用できるすべてのオプションパラメーターについては、「IoT Edge for Linux on Windows 用の PowerShell 関数」を参照してください。
警告

既定では、EFLOW の Linux 仮想マシンには DNS 構成がありません。 DHCP を使用したデプロイでは、DHCP サーバーによって伝達された DNS 構成の取得が試みられます。 DNS の構成を確認して、インターネット接続を確保してください。詳細については、AzEFLOW-DNS に関するページを参照してください。

GPU をデプロイに割り当てて、GPU アクセラレーション対応の Linux モジュールを有効にできます。これらの機能にアクセスするには、「Azure IoT Edge for Linux on Windows 用の GPU アクセラレーション」に詳述されている前提条件をインストールする必要があります。

GPU パススルーを使用するには、Deploy-Eflow コマンドに gpuName、gpuPassthroughType、gpuCount の各パラメーターを追加します。使用できるすべてのオプションパラメーターについては、「IoT Edge for Linux on Windows 用の PowerShell 関数」を参照してください。

警告

ハードウェアデバイスのパススルーを有効にすると、セキュリティリスクが高まる可能性があります。該当する場合は、GPU ベンダーが提供する、デバイスのリスク軽減ドライバーをお勧めします。詳細については、「Discrete Device Assignment を使用したグラフィックスデバイスのデプロイ」を参照してください。
ライセンス条項に同意するには、「Y」と入力します。
必要に応じて、「O」または「R」を入力して [Optional diagnostic data](オプションの診断データ) をオンまたはオフに切り替えます。
デプロイが完了すると、PowerShell ウィンドウに、「デプロイが成功しました」と表示されます。

デプロイが正常に完了したら、デバイスをプロビジョニングする準備が整いました。

Note

Windows Admin Center 用の Azure IoT Edge 拡張機能は、現在パブリックプレビューの段階にあります。管理プロセスは、一般公開される機能とは異なることがあります。

Windows Admin Center をインストールして開きます。

Windows Admin Center 開始ページにある接続の一覧に、Windows Admin Center を実行している PC を表すローカルホスト接続が表示されます。その他の管理対象のサーバー、PC、またはクラスターもここに表示されます。

Windows Admin Center を使って、ローカルデバイスまたはリモートマネージドデバイスの Azure IoT Edge for Linux on Windows を管理できます。このガイドでは、Azure IoT Edge for Linux on Windows のデプロイのターゲットデバイスとしてローカルホストを使用します。
[すべての接続] に、次のようにローカルデバイスが一覧表示されていることを確認します。

ローカルデバイスではなくリモートターゲットデバイスにデプロイしようとして、目的のターゲットデバイスが一覧に表示されない場合は、指示に従ってデバイスを追加します。
[+ 追加] を選択してデプロイの作成を開始します。このデプロイによって Linux 仮想マシンが作成され、IoT Edge ランタイムが自動的にインストールされます。
[Add or create resources]$リソースの追加または作成$ ペインで、Azure IoT Edge のタイルを見つけます。 [Create new]$新規作成$ を選択して、Azure IoT Edge for Linux on Windows の新しいインスタンスをデバイスにインストールします。

IoT Edge for Linux on Windows がデバイスで既に実行されている場合は、[Add]$追加$ を選択して既存の IoT Edge デバイスに接続し、Windows Admin Center でそれを管理できます。

$Windows Admin Center の Azure IoT Edge のタイルで [Create New]$新規作成$ を選択する (PNG)。$
[Create an Azure IoT Edge for Linux on Windows deployment]$Azure IoT Edge for Linux on Windows のデプロイを作成する$ ペインが開きます。 [1. 作業の開始] タブで、最小要件を満たしていることを確認し、[次へ] を選択します。
ライセンス条項を確認し、[同意する] をオンにして、[次へ] を選択します。
必要に応じて、[Optional diagnostic data]$オプションの診断データ$ をオンまたはオフに切り替えることができます。
Next: Deploy を選択します。

$[Next: Deploy]$次へ: デプロイ$ ボタンを、オプションの診断データの設定を切り替えた後で選択する (PNG)。$
2。[展開] タブの [ターゲットデバイスの選択一覧にあるデバイスをクリックして、最小要件を満たしていることを確認します。状態がサポート対象であることを確認した後、[次へ] を選択します。
[2.2 設定] タブで、デプロイの構成設定を確認します。次の表は、設定とその既定値を示しています。

設定既定値

仮想ディスクのサイズ (GB) 16

メモリ (MB) (偶数) 1024

コア数 2

Azure IoT Edge のバージョン 1.1 (LTS)

Note

IoT Edge linux on Windows では、Linux 仮想マシンに内部 IP アドレスを割り当てる既定のスイッチが使用されます。 Windows マシンの外部からは、この内部 IP アドレスに到達できません。 Windows マシンにログオンしている間は、ローカルで仮想マシンに接続できます。

Windows Server を使おうとしている場合は、IoT Edge for Linux on Windows をデプロイする前に既定のスイッチを設定します。

GPU をデプロイに割り当てて、GPU アクセラレーション対応の Linux モジュールを有効にできます。これらの機能にアクセスするには、「Azure IoT Edge for Linux on Windows 用の GPU アクセラレーション」に詳述されている前提条件をインストールする必要があります。デプロイプロセスのこの時点でこれらの前提条件のみをインストールする場合は、最初からもう一度開始する必要があります。

GPU パススルーでは、デプロイに割り当てる GPU アダプターに応じて、デバイス直接割り当て (DDA) と GPU 準仮想化 (GPU-PV) の 2 つのオプションを使用できます。

方法がデバイス直接割り当てでの場合は、Linux 仮想マシンに割り当てる GPU プロセッサの数を選択します。

準仮想化の方法の場合、追加の設定は必要はありません。

警告

ハードウェアデバイスのパススルーを有効にすると、セキュリティリスクが高まる可能性があります。該当する場合は、GPU ベンダーが提供する、デバイスのリスク軽減ドライバーをお勧めします。詳細については、「Discrete Device Assignment を使用したグラフィックスデバイスのデプロイ」を参照してください。

設定に問題がなければ、[次へ] を選択します。
[2.3 Deployment]$2.3 デプロイ$ タブで、デプロイの進行状況を確認できます。完全なプロセスには、Azure IoT Edge for Linux on Windows パッケージのダウンロード、パッケージのインストール、ホストデバイスの構成、Linux 仮想マシンの設定が含まれます。このプロセスの完了には数分かかる場合があります。デプロイが成功したときの表示を次に示します。

$デプロイが成功すると、各ステップに緑色のチェックマークと [Complete]$完了$ ラベルが表示される (PNG)。$
デプロイが完了すると、デバイスをプロビジョニングする準備が整います。 次へ: 接続を選択して、3 に進みます。Azure IoT Edge デバイスのプロビジョニングを処理する [接続] タブ。

設定	既定値
仮想ディスクのサイズ (GB)	16
メモリ (MB) (偶数)	1024
コア数	2
Azure IoT Edge のバージョン	1.1 (LTS)

クラウド ID を使用してデバイスをプロビジョニングする

クラウド ID と認証情報を使用してデバイスを設定する準備ができました。

対称キーを使用してデバイスをプロビジョニングするには、デバイスの接続文字列が必要です。

Windows Admin Center または管理者特権の PowerShell セッションを使用して、デバイスをプロビジョニングできます。

PowerShell
Windows Admin Center

管理者特権の PowerShell セッションで、ターゲットデバイスに対して次のコマンドを実行します。プレースホルダーテキストは実際の値に置き換えてください。

Provision-EflowVm -provisioningType ManualConnectionString -devConnString "PASTE_DEVICE_CONNECTION_STRING_HERE"

Provision-EflowVM コマンドの詳細については、「IoT Edge for Linux on Windows 用の PowerShell 関数」を参照してください。

[Azure IoT Edge device provisioning]$Azure IoT Edge デバイスのプロビジョニング$ ペインで、プロビジョニング方法のドロップダウンから [Connection String (Manual)]$接続文字列 (手動)$ を選択します。
デバイスの登録後、IoT Hub から取得したデバイスの接続文字列を指定します。
[選択した方法でプロビジョニングする] を選択します。

$デバイスの接続文字列を貼り付けた後、[Provisioning with the selected method]$選択した方法でプロビジョニング$ を選択する$
プロビジョニングが完了したら、[完了] を選択します。メインダッシュボードに自動的に戻ります。これで、種類が IoT Edge Devices の新しいデバイスが一覧に表示されるはずです。 IoT Edge デバイスを選択して、それに接続できます。 [Overview]$概要$ ページでは、デバイスの [IoT Edge Module List]$IoT Edge モジュール一覧$ と [IoT Edge Status]$IoT Edge の状態$ を見ることができます。

構成が成功したことを確認する

IoT Edge for Linux on Windows が IoT Edge デバイスに正常にインストールされ、構成されたことを確認します。

PowerShell
Windows Admin Center

PowerShell セッションで次のコマンドを使用して、お使いの IoT Edge for Linux on Windows 仮想マシンにログインします。
```
Connect-EflowVm
```
Note

仮想マシンへの SSH 接続が許可されるアカウントは、それを作成したユーザーだけです。
ログインすると、次の Linux コマンドを使用して、実行中の IoT Edge モジュールの一覧を確認できます。
```
sudo iotedge list
```
IoT Edge サービスのトラブルシューティングを行う必要がある場合は、次の Linux コマンドを使用します。
1. サービスのログを取得します。
```
sudo journalctl -u iotedge
```
2. check ツールを使用して、デバイスの構成と接続の状態を確認します。
```
sudo iotedge check
```
Note

新しくプロビジョニングされたデバイスでは、IoT Edge ハブに関連するエラーが表示される場合があります。

× 運用環境の準備: Edge ハブのストレージディレクトリがホストファイルシステムに保持されています - エラー

edgeHub コンテナーの現在の状態を確認できませんでした

このエラーは、IoT Edge ハブモジュールが実行されていないために、新しくプロビジョニングされたデバイスで発生します。このエラーを解決するには、IoT Hub でデバイスのモジュールを設定し、デプロイを作成します。デバイスのデプロイを作成することで、IoT Edge ハブモジュールを含むモジュールがデバイス上で開始されます。

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

IoT Edge for Linux on Windows をアンインストールする

デバイスから Azure IoT Edge for Linux on Windows のインストールを削除する場合は、次のコマンドを使用します。

Windows で [設定] を開きます
[プログラムの追加と削除] を選択します
[Azure IoT Edge LTS] アプリを選択します
[アンインストール] を選択します

次のステップ

IoT Edge モジュールのデプロイに進んで、デバイスにモジュールをデプロイする方法を確認します。
IoT Edge for Linux on Windows 仮想マシンで証明書を管理し、ホスト OS から Linux 仮想マシンにファイルを転送する方法について確認します。
プロキシサーバー経由で通信するように IoT Edge デバイスを構成する方法について確認します。

次の方法で共有

対称キーを使用して IoT Edge for Linux on Windows デバイスを作成してプロビジョニングする

前提条件

デバイス管理ツール

デバイスの要件

開発者用ツール

デバイスを登録する

Visual Studio Code を使用して新しいデバイスを登録する

登録済みデバイスを表示し、プロビジョニング情報を取得する

IoT Edge をインストールする

クラウド ID を使用してデバイスをプロビジョニングする

構成が成功したことを確認する

IoT Edge for Linux on Windows をアンインストールする

次のステップ

その他のリソース