Azure Resource Manager を使用してルートとエンドポイントを作成および削除する

[アーティクル]
04/13/2023

この記事では、Azure CLI または Azure PowerShell を使って Azure IoT Hub テンプレートをエクスポートする方法、IoT ハブにルートを追加する方法、テンプレートを IoT ハブに再デプロイする方法について説明します。 Azure Resource Manager テンプレートを使用して、Azure Event Hubs、Azure Service Bus キューとトピック、Azure Storage に対してルートとエンドポイントを作成します。

Azure Resource Manager テンプレートは、JSON ファイルを使用してリソースを定義する必要がある場合に便利です。すべての Azure リソースには、そのリソースで使用されるコンポーネントを定義するテンプレートがあります。すべての Azure リソーステンプレートをエクスポートできます。

重要

Resource Manager テンプレートを使用してリソースをデプロイするときには、デプロイしている種類のすべての既存のリソースがテンプレートによって置き換えられます。

新しい IoT ハブを作成するときには、既存のデプロイされたリソースを上書きすることは問題ではありません。新しい IoT ハブを作成するには、既にデプロイされている IoT ハブから既存のテンプレートをエクスポートするのではなく、必要なプロパティが設定された基本のテンプレートを使用できます。

ただし、既存の IoT ハブの Resource Manager テンプレートにルートを追加する場合は、IoT ハブからエクスポートしたテンプレートを使用して、更新されたテンプレートをデプロイした後もすべての既存のリソースとプロパティが接続されたままになるようにします。既にデプロイされているリソースは置き換えられません。たとえば、以前にデプロイし、エクスポートされた Resource Manager テンプレートには IoT ハブのストレージ情報が含まれていることがあります (ストレージに接続している場合)。

IoT Hub のルーティングのしくみについては、「IoT Hub メッセージルーティングを使用して device-to-cloud メッセージを別のエンドポイントに送信する」を参照してください。ストレージにメッセージを送信するルートを設定し、シミュレートされたデバイスでテストする手順については、「チュートリアル: IoT Hub メッセージルーティングを使用してデバイスデータを Azure Storage に送信する」を参照してください。

前提条件

この記事で説明する手順では、次のリソースを使用します。

Azure Resource Manager テンプレート
IoT ハブ
Azure のエンドポイントサービス

Azure Resource Manager テンプレート

この記事では、Azure portal の Azure Resource Manager テンプレートを使って IoT Hub や他の Azure サービスを操作します。 Resource Manager テンプレートを使用する方法の詳細については、「Azure Resource Manager テンプレートとは」を参照してください。

IoT ハブ

IoT ハブルートを作成するには、Azure IoT Hub を使用して作成した IoT ハブが必要です。デバイスメッセージとイベントログは、IoT ハブで生成されます。

IoT ハブルートを作成するときに使用する次のハブリソースがあることを確認してください。

Azure サブスクリプション内の IoT ハブ。ハブがまだない場合は、Azure Resource Manager テンプレートを使用して IoT ハブを作成する (PowerShell) 手順を実行することをお勧めします。

エンドポイントサービス

IoT ハブルートを作成するには、ルートへのエンドポイントとして使用する他の Azure サービスが少なくとも 1 つ必要です。エンドポイントは、デバイスメッセージとイベントログを受信します。 IoT ハブルートと接続するエンドポイントに使用する Azure サービス (Event Hubs、Service Bus キューまたはトピック、Azure Storage) を選択できます。

IoT ハブルートでエンドポイントを作成するときに使用する次のリソースの "いずれか" があることを確認してください。

Event Hubs リソース (とコンテナー)。新しい Event Hubs リソースを作成する必要がある場合は、「クイックスタート: Resource Manager テンプレートを使用したイベントハブの作成」を参照してください。
Service Bus キューリソース。新しい Service Bus キューを作成する必要がある場合は、「クイックスタート: Resource Manager テンプレートを使用した Service Bus の名前空間とキューの作成」を参照してください。
Service Bus トピックリソース。新しい Service Bus トピックを作成する必要がある場合は、「クイックスタート: Resource Manager テンプレートを使用したトピックとサブスクリプションを含んだ Service Bus 名前空間の作成」を参照してください。
Azure Storage リソース。新しい Azure ストレージを作成する必要がある場合は、「ストレージアカウントを作成する」を参照してください。

ルートの作成

IoT Hub では、メッセージを送信する、またはイベントをキャプチャするルートを作成できます。各ルートには、データソースとエンドポイントがあります。データソースは、メッセージまたはイベントログが生成される場所です。エンドポイントは、メッセージまたはイベントログが最終的に到達する場所です。 IoT ハブで新しいルートを作成するときに、データソースとエンドポイントの場所を選択します。次に、ルーティングクエリを使って、エンドポイントに移動する前にメッセージまたはイベントをフィルター処理します。

IoT ハブルートのエンドポイントとして、イベントハブ、Service Bus キューまたはトピック、Azure ストレージアカウントを使用できます。エンドポイントの作成に使用するサービスは、事前に Azure アカウントに存在する必要があります。

IoT ハブから Resource Manager テンプレートをエクスポートする

最初に、IoT ハブから Resource Manager テンプレートをエクスポートし、それにルートを追加します。

Azure portal で IoT Hub に移動します。リソースメニューの [オートメーション] で、[テンプレートのエクスポート] を選択します。
[テンプレートのエクスポート] の [テンプレート] タブで、次の手順を完了します。
1. IoT ハブ用に生成された JSON ファイルを表示します。
2. [パラメーターを含める] チェックボックスをオフにします。
3. [ダウンロード] を選択して、JSON ファイルのローカルコピーをダウンロードします。
このテンプレートには、IoT ハブに機能またはサービスを追加するために使用できるプレースホルダーがいくつかあります。この記事では、routing 内にあるか、その下で入れ子になっているプロパティにのみ値を追加します。

Resource Manager テンプレートに新しいエンドポイントを追加する

JSON ファイルで、"routing" の下で入れ子になっている "endpoints": [] プロパティを見つけます。エンドポイントに対して選択した Azure サービス (Event Hubs、Service Bus キューまたはトピック、Azure Storage) に基づいて、新しいエンドポイントを追加する手順を完了します。

Event Hubs リソース (とコンテナー) を作成する方法については、「クイックスタート: Resource Manager テンプレートを使用したイベントハブの作成」を参照してください。

Azure portal で、Event Hubs リソースからプライマリ接続文字列を取得します。リソースの [共有アクセスポリシー] ウィンドウで、ポリシーのいずれかを選ぶと、キーと接続文字列の情報が表示されます。接続文字列の末尾にあるエンティティパスにイベントハブ名を追加します。たとえば、 ;EntityPath=my-event-hubsを使用します。この名前は、名前空間名ではなく、イベントハブ名です。

name には、Event Hubs エンドポイントの一意の値を使用します。 id パラメーターは空の文字列のままにします。 Azure サービスは、エンドポイントをデプロイするときに id 値を提供します。

"routing": {
   "endpoints": {
      "serviceBusQueues": [],
      "serviceBusTopics": [],
      "eventHubs": [
            {
               "connectionString": "my Event Hubs connection string + entity path",
               "authenticationType": "keyBased",
               "name": "my-event-hubs-endpoint",
               "id": "",
               "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
               "resourceGroup": "my-resource-group"
            }
      ],
      "storageContainers": [],
      "cosmosDBSqlCollections": []
   },
},

Service Bus キューリソース (名前空間とキュー) を作成する方法については、「クイックスタート: Resource Manager テンプレートを使用した Service Bus の名前空間とキューの作成」を参照してください。

Azure portal で、Service Bus リソースからプライマリ接続文字列を取得します。リソースの [共有アクセスポリシー] ウィンドウで、ポリシーのいずれかを選ぶと、キーと接続文字列の情報が表示されます。接続文字列の末尾にあるエンティティパスにイベントハブ名を追加します。たとえば、 ;EntityPath=my-service-bus-queueを使用します。この名前は、名前空間名ではなく、キュー名です。

name には、Service Bus キューエンドポイントの一意の値を使用します。 id パラメーターは空の文字列のままにします。 Azure サービスは、エンドポイントをデプロイするときに id 値を提供します。

"routing": {
   "endpoints": {
      "serviceBusQueues": [
            {
               "connectionString": "my Service Bus connection string + entity path",
               "authenticationType": "keyBased",
               "name": "my-service-bus-queue-endpoint",
               "id": "",
               "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
               "resourceGroup": "my-resource-group"
            }
      ],
      "serviceBusTopics": [],
      "eventHubs": [],
      "storageContainers": [],
      "cosmosDBSqlCollections": []
   },
},

Service Bus トピックリソース (名前空間、トピック、サブスクリプション) を作成する必要がある場合は、「クイックスタート: Resource Manager テンプレートを使用した Service Bus の名前空間とトピックの作成」を参照してください。

Azure portal で、Service Bus リソースからプライマリ接続文字列を取得します。リソースの [共有アクセスポリシー] ウィンドウで、ポリシーのいずれかを選ぶと、キーと接続文字列の情報が表示されます。接続文字列の末尾にあるエンティティパスにイベントハブ名を追加します。たとえば、 ;EntityPath=my-service-bus-topicを使用します。この名前は、名前空間名ではなく、トピック名です。

name には、エンドポイントの一意の名前を入力します。 id パラメーターは空の文字列のままにします。 Azure サービスは、エンドポイントをデプロイするときに id 値を提供します。

"routing": {
   "endpoints": {
      "serviceBusQueues": [],
      "serviceBusTopics": [
         {
            "connectionString": "my Service Bus connection string + entity path",
            "authenticationType": "keyBased",
            "name": "my-service-bus-topic-endpoint",
            "id": "",
            "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "resourceGroup": "my-resource-group"
         }
      ],
      "eventHubs": [],
      "storageContainers": [],
      "cosmosDBSqlCollections": []
   },
},

Azure Storage リソース (名前空間、トピック、サブスクリプション) を作成する方法については、「ストレージアカウントを作成する」を参照してください。

Azure portal で、リソースの [アクセスキー] ウィンドウにある Azure Storage リソースのプライマリ接続文字列を取得します。

"routing": {
   "endpoints": {
      "serviceBusQueues": [],
      "serviceBusTopics": [],
      "eventHubs": [],
      "storageContainers": [
         {
            "connectionString": "my Azure storage connection string",
            "containerName": "my-container",
            "fileNameFormat": "{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.avro",
            "batchFrequencyInSeconds": 100,
            "maxChunkSizeInBytes": 104857600,
            "encoding": "avro",
            "authenticationType": "keyBased",
            "name": "my-storage-endpoint",
            "id": "",
            "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "resourceGroup": "my-resource-group"
         }
      ],
      "cosmosDBSqlCollections": []
   },
},

Resource Manager テンプレートに新しいルートを追加する

JSON ファイルで、"routing" の下にある、入れ子になった "routes": [] プロパティを見つけます。選んだエンドポイントサービス (Event Hubs、Service Bus キューまたはトピック、または Azure Storage) に従って、次の新しいルートを追加します。

既定のフォールバックルートは、DeviceMessages からメッセージを収集します。別のオプション (DeviceConnectionStateEvents など) を選択します。ソースオプションの詳細については、「az iot hub route」を参照してください。

注意事項

"routes" の既存の値を、次のコード例で使用されているルート値に置き換えると、デプロイ時に既存のルートが削除されます。既存のルートを維持するには、新しいルートオブジェクトを "routes" リストに "追加" します。

テンプレートの詳細については、「Azure Resource Manager テンプレートリソース定義」を参照してください。

"routes": [
    {
        "name": "MyIotHubRoute",
        "source": "DeviceConnectionStateEvents",
        "condition": "true",
        "endpointNames": [
        "my-event-hubs-endpoint"
        ],
        "isEnabled": true
    }
],

JSON ファイルを保存します。

"routes": [
    {
        "name": "MyIotHubRoute",
        "source": "DeviceConnectionStateEvents",
        "condition": "true",
        "endpointNames": [
        "my-service-bus-queue-endpoint"
        ],
        "isEnabled": true
    }
],

JSON ファイルを保存します。

"routes": [
    {
        "name": "MyIotHubRoute",
        "source": "DeviceConnectionStateEvents",
        "condition": "true",
        "endpointNames": [
        "my-service-bus-topic-endpoint"
        ],
        "isEnabled": true
    }
],

JSON ファイルを保存します。

"routes": [
    {
        "name": "MyIotHubRoute",
        "source": "DeviceConnectionStateEvents",
        "condition": "true",
        "endpointNames": [
        "my-storage-endpoint"
        ],
        "isEnabled": true
    }
],

JSON ファイルを保存します。

Resource Manager テンプレートをデプロイする

新しいエンドポイントとルートが Resource Manager テンプレートに追加されたので、JSON ファイルを IoT ハブにデプロイできます。

az deployment group create \
  --name my-iot-hub-template \
  --resource-group my-resource-group \
  --template-file "my\path\to\template.json"

New-AzResourceGroupDeployment `
  -Name MyTemplate `
  -ResourceGroupName MyResourceGroup `
  -TemplateFile "my\path\to\template.json"

Azure Cloud Shell のデプロイ

Azure Cloud Shell は Web ブラウザーで実行されるので、デプロイコマンドを実行する前にテンプレートファイルをアップロードできます。ファイルをアップロードすると、template-file パラメーターで使用する必要があるのは (ファイルのパス全体ではなく) テンプレートファイル名のみになります。

ファイルをアップロードする Azure Cloud Shell のボタンの場所を示すスクリーンショット。

Azure CLI
PowerShell

az deployment group create \
  --name my-iot-hub-template \
  --resource-group my-resource-group \
  --template-file "template.json"

New-AzResourceGroupDeployment `
  -Name MyIoTHubTemplate `
  -ResourceGroupName MyResourceGroup `
  -TemplateFile "template.json"

Note

デプロイに失敗した場合は、-verbose スイッチを使用して、作成しているリソースに関する情報を取得します。デバッグの詳細については、-debug スイッチを使用してください。

デプロイを確認する

テンプレートが Azure に正常にデプロイされたことを確認するには、Azure portal で、リソースグループリソースに移動します。リソースメニューの [設定] で、[デプロイ] を選択して、デプロイの一覧にあるテンプレートを確認します。

テストテンプレートが強調表示された、Azure portal 内のリソースのデプロイの一覧を示すスクリーンショット。

Azure portal で新しいルートを表示するには、IoT Hub リソースに移動します。 [メッセージルーティング] ウィンドウの [ルート] タブで、ルートが一覧表示されていることを確認します。

次の手順

このハウツー記事では、Event Hubs、Service Bus キューとトピック、Azure Storage に対してルートとエンドポイントを作成する方法について説明しました。

メッセージルーティングの詳細については、「チュートリアル: IoT Hub メッセージルーティングを使用してデバイスデータを Azure Storage に送信する」を参照してください。このチュートリアルでは、ストレージルートを作成し、IoT ハブでデバイスを使ってテストします。

Azure Resource Manager を使用してルートとエンドポイントを作成および削除する

前提条件

Azure Resource Manager テンプレート

IoT ハブ

エンドポイント サービス

ルートの作成

IoT ハブから Resource Manager テンプレートをエクスポートする

Resource Manager テンプレートに新しいエンドポイントを追加する

Resource Manager テンプレートに新しいルートを追加する

Resource Manager テンプレートをデプロイする

ローカル デプロイ

Azure Cloud Shell のデプロイ

デプロイを確認する

次の手順

その他のリソース

エンドポイントサービス

ローカルデプロイ