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

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

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

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

• ご使用の環境内の Azure CLI

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

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 ハブに新しいデバイスが一覧表示されます。

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]>[デバイス] セクションの一覧にこのデバイスが表示されます。

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 ハブの [デバイス] ページに一覧表示されます。 複数のデバイスがある場合は、[IoT Edge デバイス] という種類を選択し、[適用] を選択すると、一覧をフィルター処理できます。

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

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

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]\(デバイス情報の取得\) を選択して、接続文字列を含むすべてのデバイス情報を出力ウィンドウに表示することもできます。

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]"
}

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

インストールは、数個のコマンドで実行できます。 ターミナルを開き、次のコマンドを実行します。

• 22.04:

  wget https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
  sudo dpkg -i packages-microsoft-prod.deb
  rm packages-microsoft-prod.deb
  

• 20.04:

  wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
  sudo dpkg -i packages-microsoft-prod.deb
  rm packages-microsoft-prod.deb
  

APT を使用したインストールは、少ないコマンドで実行できます。 ターミナルを開き、次のコマンドを実行します。

• 11 - Bullseye (arm32v7):

  curl https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb > ./packages-microsoft-prod.deb
  sudo apt install ./packages-microsoft-prod.deb
  

インストールは、数個のコマンドで実行できます。 ターミナルを開き、次のコマンドを実行します。

• 9.x (amd64):

    wget https://packages.microsoft.com/config/rhel/9.0/packages-microsoft-prod.rpm -O packages-microsoft-prod.rpm
    sudo yum localinstall packages-microsoft-prod.rpm
    rm packages-microsoft-prod.rpm
  

• 8.x (amd64):

    wget https://packages.microsoft.com/config/rhel/8/packages-microsoft-prod.rpm -O packages-microsoft-prod.rpm
    sudo yum localinstall packages-microsoft-prod.rpm
    rm packages-microsoft-prod.rpm
  

後のステップで、スナップ ストアから IoT Edge ランタイムをインストールします。 次のセクションに進みます。

Moby エンジンをインストールします。

sudo apt-get update; \
  sudo apt-get install moby-engine

Moby エンジンをインストールします。

sudo apt-get update; \
  sudo apt-get install moby-engine

Moby エンジンと CLI をインストールします。

sudo yum install moby-engine moby-cli

curl -ssl https://raw.githubusercontent.com/moby/moby/master/contrib/check-config.sh -o check-config.sh
chmod +x check-config.sh
./check-config.sh

IoT Edge には、Docker と IoT ID サービスへの依存関係があります。 次のコマンドを使って、依存関係をインストールします。

sudo snap install docker
sudo snap install azure-iot-identity

Docker スナップは Canonical によって提供され、運用シナリオでサポートされます。

1. 既存の Docker デーモンの構成ファイルを作成または編集します

   sudo nano /etc/docker/daemon.json
   

2. 例で示すように、既定のログ ドライバーを local ログ ドライバーに設定します。

      {
         "log-driver": "local"
      }
   

3. コンテナー エンジンを再起動して、変更を有効にします。

   sudo systemctl restart docker
   

現在、ローカル ログ ドライバーの設定は Docker スナップについてはサポートされていません。

(まだ最新の状態でない場合) 最新バージョンの IoT Edge と IoT ID サービス パッケージをインストールします。

• 22.04:

  sudo apt-get update; \
     sudo apt-get install aziot-edge
  

• 20.04:

  sudo apt-get update; \
     sudo apt-get install aziot-edge defender-iot-micro-agent-edge
  

オプションの defender-iot-micro-agent-edge パッケージには、セキュリティ態勢管理、脆弱性、脅威検出、フリート管理などのエンドポイントの可視性を提供する Microsoft Defender for IoT セキュリティ マイクロ エージェントが含まれており、IoT Edge デバイスのセキュリティ保護に役立ちます。 Edge デバイスのセキュリティ監視とセキュリティ強化を有効にするには、Edge エージェントを使ってマイクロ エージェントをインストールすることをお勧めします。 Microsoft Defender for IoT の詳細については、「デバイス ビルダー向け Microsoft Defender for IoT とは」を参照してください。

(まだ最新の状態でない場合) 最新バージョンの IoT Edge と IoT ID サービス パッケージをインストールします。

sudo apt-get update; \
  sudo apt-get install aziot-edge defender-iot-micro-agent-edge

オプションの defender-iot-micro-agent-edge パッケージには、セキュリティ態勢管理、脆弱性、脅威検出、フリート管理などのエンドポイントの可視性を提供する Microsoft Defender for IoT セキュリティ マイクロ エージェントが含まれており、IoT Edge デバイスのセキュリティ保護に役立ちます。 Edge デバイスのセキュリティ監視とセキュリティ強化を有効にするには、Edge エージェントを使ってマイクロ エージェントをインストールすることをお勧めします。 Microsoft Defender for IoT の詳細については、「デバイス ビルダー向け Microsoft Defender for IoT とは」を参照してください。

(まだ最新の状態でない場合) 最新バージョンの IoT Edge と IoT ID サービス パッケージをインストールします。

sudo yum install aziot-edge

スナップ ストアから IoT Edge をインストールします。

sudo snap install azure-iot-edge

スナップを接続する

既定では、スナップは依存関係がなく、信頼されておらず、厳密に制限されています。 そのため、インストールの後で、スナップを他のスナップやシステム リソースに接続する必要があります。 次のコマンドを使って、IoT ID サービスと IoT Edge スナップを相互に、およびシステム リソースと接続します。 始めるには、スナップを手動で接続する必要があります。 運用環境のデプロイでは、それらを自動的に接続するように構成して、プロビジョニングの作業量を減らすことができます。

#------------------------
#  IoT Identity Service
#------------------------

# Connect the Identity Service snap to the logging system
# and grant permission to query system info

sudo snap connect azure-iot-identity:log-observe
sudo snap connect azure-iot-identity:mount-observe
sudo snap connect azure-iot-identity:system-observe
sudo snap connect azure-iot-identity:hostname-control

# If using a TPM, enable TPM access

sudo snap connect azure-iot-identity:tpm

#------------
#  IoT Edge
#------------

# Connect to your /home directory to enable writing support bundles

sudo snap connect azure-iot-edge:home

# Connect to logging and grant permission to query system info

sudo snap connect azure-iot-edge:log-observe
sudo snap connect azure-iot-edge:mount-observe
sudo snap connect azure-iot-edge:system-observe
sudo snap connect azure-iot-edge:hostname-control
# Allow IoT Edge to connect to the /var/run/iotedge folder and use sockets

sudo snap connect azure-iot-edge:run-iotedge

# Connect IoT Edge to Docker

sudo snap connect azure-iot-edge:docker docker:docker-daemon

次のコマンドを使って、対称キー認証で IoT Edge デバイスを構成できます。

sudo iotedge config mp --connection-string 'PASTE_DEVICE_CONNECTION_STRING_HERE'

この iotedge config mp コマンドは、デバイス上に構成ファイルを作成し、接続文字列をこの構成ファイルに入力します。

1. 構成の変更を適用します。

   sudo iotedge config apply
   

2. 構成ファイルを表示する場合は、次の方法で開きます。

   sudo nano /etc/aziot/config.toml
   

1. ホーム ディレクトリに config.toml ファイルを作成し、スナップに対する対称キー認証で IoT Edge デバイスを構成します。

   sudo nano ~/config.toml
   

2. 接続文字列と次のプロビジョニング設定を使って、手動でプロビジョニングできます。

   [provisioning]
   source = "manual"
   connection_string = "REPLACE_WITH_DEVICE_CONNECTION_STRING"
   

   プロビジョニング構成の設定について詳しくは、「IoT Edge デバイスの設定を構成する」をご覧ください。

3. 次のコマンドを使って、IoT Edge と ID サービスの構成を設定します。

   sudo snap set azure-iot-edge raw-config="$(cat ~/config.toml)"
   

sudo apt-get autoremove --purge aziot-edge

IoT Edge を再インストールし、今後同じ構成情報を使用する場合は、--purgeフラグを使用しないでください。 --purge フラグによって、構成ファイルを含め、IoT Edge に関連付けられているすべてのファイルが削除されます。

sudo yum remove aziot-edge

IoT Edge ランタイムを削除します。

sudo snap remove azure-iot-edge

Azure ID サービスを削除します。

sudo snap remove azure-iot-identity

sudo apt-get autoremove --purge moby-engine

sudo yum remove moby-cli
sudo yum remove moby-engine

sudo snap remove docker