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

適用対象: IoT Edge 1.4

重要

サポートされているリリースは、Azure IoT Edge 1.5 LTS と IoT Edge 1.4 です。 IoT Edge 1.4 LTS は、2024 年 11 月 12 日にサービス終了になります。 以前のリリースの場合は、「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 でどのように動作するかを確認してください。

• X.509 証明書を使用して IoT Edge デバイスを大規模に作成およびプロビジョニングする
• TPM を使用して IoT Edge デバイスを大規模に作成およびプロビジョニングする
• 対称キーを使用して IoT Edge デバイスを大規模に作成およびプロビジョニングする

前提条件

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

デバイス管理ツール

デバイスを登録する手順には、Azure portal、Visual Studio Code、または Azure CLI を使用できます。 各ユーティリティには、独自の前提条件があり、インストールが必要な場合があります。

ポータル

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

Visual Studio Code

• Azure サブスクリプション内の無料または標準の IoT ハブ
• Visual Studio Code
• Azure IoT Edge 拡張機能。 "Visual Studio Code 用の Azure IoT Edge Tools" 拡張機能は、メンテナンス モードになっています。
• Azure IoT Hub 拡張機能

Azure CLI

• 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 アクセラレーションを使用する場合は、インストール プロセスを再起動する必要があります。

開発者ツール

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

1. ターゲット デバイスの実行ポリシーを 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 デバイスとは別に作成および管理されます。

1. Azure Portal にサインインし、IoT Hub に移動します。

2. 左側のウィンドウで、メニューから [デバイス] を選択し、[デバイスを追加する] を選択します。

3. [デバイスの作成] ページで、次の情報を指定します。

   • 説明的なデバイス ID を作成します。たとえば、my-edge-device-1 (すべて小文字) です。 このデバイス ID は後で使用するので、メモしておいてください。
   • [IoT Edge デバイス] のチェック ボックスをオンにします。
   • 認証の種類として [対称キー] を選択します。
   • 認証キーを自動生成して、新しいデバイスをハブに接続するために、既定の設定を使用します。

4. [保存] を選択します。

IoT ハブに新しいデバイスが一覧表示されます。

Visual Studio Code

Azure へのサインイン

Visual Studio Code 用の Azure IoT 拡張機能を使用して、IoT ハブで操作を実行できます。 Azure IoT 拡張機能の前提条件をインストール済みであることを確認します。

Azure IoT Edge と Azure IoT Hub 拡張機能がインストールされると、左側のアイコン メニューに Azure アイコンが追加されます。 Visual Studio Code を使用して Azure アカウントにサインインできます。そのためには、Azure アイコンを選択し、[Azure にサインイン] を選択します。

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

新しいデバイスの登録方法は、Azure portal で IoT Edge デバイスを作成する方法と似ています。 この仮想デバイスはツインの一方であり、実際のデバイスはツインのもう一方です。 Visual Studio Code では、次の手順に従ってこれを設定できます。

1. Visual Studio Code エクスプローラー メニューで、[Azure IoT Hub] セクションを展開します。
2. [Azure IoT Hub] セクション ヘッダーで [...] を選択します。 省略記号が表示されない場合は、ヘッダーを選択するかポイントします。
3. [Create IoT Edge Device]\(IoT Edge デバイスの作成\) を選択します。
4. 表示されたテキスト ボックスで、my-edge-device-1 (すべて小文字) などの ID をデバイスに指定し、Enter キーを押します。

Visual Studio Code の出力コンソールに、コマンドの結果 (JSON 出力) が表示されます。 デバイスの情報には、指定した deviceId が含まれ、IoT ハブに物理デバイスを接続するために使用できる connectionString が生成されます。 出力コンソールには、キーやその他のデバイス識別情報も表示されます。

これで、エクスプローラー メニューの [Azure IoT Hub]>[デバイス] セクションの一覧にこのデバイスが表示されます。

Note

デバイスが一覧になければ、[Azure IoT Hub] の下にあるリンク [IOT ハブの選択] から IoT ハブを選択し、プロンプトに従う必要がある場合があります。 プロンプトでは、最初にサブスクリプション、次に IoT ハブを選択するように求められます。 このプロセスにより、Visual Studio Code が IoT ハブ (およびその中のすべてのデバイス) を認識します。 Visual Studio Code を更新すると、デバイスが表示されます。

Azure CLI

az iot hub device-identity create コマンドを使用して、IoT ハブに新しいデバイス ID を作成します。 device_id_here を、my-edge-device-1 (すべて小文字) など、独自の新しい一意のデバイス ID に置き換えます。 hub_name_here を既存の IoT ハブに置き換えます。

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

• --device-id または -d: IoT ハブ内で一意のわかりやすい名前を指定します。

• --hub-name または -n: IoT ハブの名前を指定します。

• --edge-enabled または --ee: デバイスが IoT Edge デバイスであることを宣言します。

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

CLI に The command requires the extension azure-iot. (このコマンドには拡張機能 azure-iot が必要です。)Do you want to install it now? (今すぐインストールしますか?) と表示された場合は、Y を入力し、Enter を押します。これにより、ダウンロードが開始され、デバイスが作成されます。

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

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

対称キー認証を使用するデバイスでは、IoT Edge ランタイムのインストールとプロビジョニングを完了するために接続文字列が必要です。 IoT Edge デバイスを作成すると、このデバイスの接続文字列が生成されます。 Visual Studio Code と Azure CLI の場合、接続文字列は JSON 出力に含まれます。 Azure portal を使用してデバイスを作成する場合は、デバイス自体で接続文字列を見つけることができます。 IoT ハブでデバイスを選択すると、デバイス ページに Primary connection string として表示されます。

ポータル

IoT ハブに接続するエッジ対応デバイスが、IoT ハブの [デバイス] ページに一覧表示されます。 複数のデバイスがある場合は、[IoT Edge デバイス] という種類を選択し、[適用] を選択すると、一覧をフィルター処理できます。

デバイスを設定する準備ができたら、物理デバイスを IoT ハブ内でのその ID にリンクする接続文字列が必要です。 対称キーを使用して認証を行うデバイスでは、接続文字列をポータルでコピーできます。 ポータルで接続文字列を見つけるには、次のようにします。

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

Visual Studio Code

IoT ハブに接続するすべてのデバイスは、Visual Studio Code エクスプローラーの [Azure IoT Hub] セクションに表示されます。 IoT Edge デバイスとそれ以外のデバイスはアイコンで区別できるほか、各 IoT Edge デバイスには $edgeAgent と $edgeHub の各モジュールがデプロイされています。

デバイスを設定する準備ができたら、物理デバイスを IoT ハブ内でのその ID にリンクする接続文字列が必要です。 Visual Studio Code から接続文字列を取得する方法をこちらに示します。

1. [Azure IoT Hub] セクションでデバイスの ID (名前) を右クリックします。

2. [Copy Device Connection String]\(デバイス接続文字列のコピー\) を選択します。

   接続文字列がクリップボードにコピーされます。

右クリック メニューから [Get Device Info]\(デバイス情報の取得\) を選択して、接続文字列を含むすべてのデバイス情報を出力ウィンドウに表示することもできます。

Azure CLI

IoT ハブのすべてのデバイスを表示するには、az iot hub device-identity list コマンドを使用します。 hub_name_here を自分の IoT ハブ名に置き換えてください。

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

IoT Edge デバイスとして登録されたすべてのデバイスのプロパティ capabilities.iotEdge が true に設定されています。 デバイス ID を含め、JSON 出力として他にも多くのメタデータが表示されます。

デバイスを設定する準備ができたら、物理デバイスを IoT ハブ内でのその ID にリンクする接続文字列が必要になります。 次の az iot hub device-identity connection-string show コマンドを使用すると、単一のデバイスの接続文字列が返されます。 [device_id] と [hub_name] を独自の値に置き換えます。 device-identity パラメーターの値は、大文字と小文字が区別されます。

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

コンソールに、次のような JSON 出力が表示されます。

{
  "connectionString": "HostName=[hub_name].azure-devices.net;DeviceId=[device_id];SharedAccessKey=[device_key]"
}

ヒント

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

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

IoT Edge をインストールする

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

Note

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

1. 管理者特権の PowerShell セッションで、ターゲット デバイス アーキテクチャに応じて次のいずれかのコマンドを実行し、IoT Edge for Linux on Windows をダウンロードします。

   • X64、AMD64

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

   • ARM64

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

2. 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"
   

3. ターゲット デバイスの実行ポリシーがまだ AllSigned に設定されていない場合、これを設定します。 最新の実行ポリシーをチェックしたり実行ポリシーを AllSigned に設定したりするためのコマンドについては、PowerShell の前提条件を参照してください。

4. 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 コマンドのオプションでパラメーターを指定することで、仮想マシンで使用できるリソースをカスタマイズできます。 これは、最小ハードウェア要件を持つデバイスに EFLOW をデプロイするために必要です。

   たとえば、次のコマンドは、1 つの vCPU コア、1 GB の RAM (MB で表現)、および 2 GB のディスク領域を持つ仮想マシンを作成します。

   Deploy-Eflow -cpuCount 1 -memoryInMB 1024 -vmDataSize 2
   

   使用できるすべてのオプション パラメーターについては、「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 を使用したグラフィックス デバイスのデプロイ」を参照してください。

5. ライセンス条項に同意するには、「Y」と入力します。

6. 必要に応じて、「O」または「R」を入力して [Optional diagnostic data](オプションの診断データ) をオンまたはオフに切り替えます。

7. デプロイが完了すると、PowerShell ウィンドウに、「デプロイが成功しました」と表示されます。

   

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

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

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

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

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

Provision-EflowVm -provisioningType ManualConnectionString -devConnString "PASTE_DEVICE_CONNECTION_STRING_HERE"

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

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

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

1. PowerShell セッションで次のコマンドを使用して、お使いの IoT Edge for Linux on Windows 仮想マシンにサインインします。

   Connect-EflowVm
   

   Note

   仮想マシンへの SSH 接続が許可されるアカウントは、それを作成したユーザーだけです。

2. ログインすると、次の Linux コマンドを使用して、実行中の IoT Edge モジュールの一覧を確認できます。

   sudo iotedge list
   

3. IoT Edge サービスのトラブルシューティングを行う必要がある場合は、次の Linux コマンドを使用します。

   1. サービスのログを取得します。

      sudo iotedge system logs
      

   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 のインストールを削除する場合は、次のコマンドを使用します。

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

次のステップ

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