Skip to content

Latest commit

 

History

History
132 lines (79 loc) · 8.08 KB

horizontal-arm-route-messages.md

File metadata and controls

132 lines (79 loc) · 8.08 KB
title description author ms.service services ms.topic ms.date ms.author ms.custom
Use ARM template to publish IoT Hub, storage account, route messages
Use ARM template to publish IoT Hub, storage account, route messages
robinsh
iot-hub
iot-hub
quickstart
08/24/2020
robinsh
mvc, subject-armqs

Quickstart: Deploy an Azure IoT Hub and a storage account using an ARM template

In this quickstart, you use an Azure Resource Manager template (ARM template) to create an IoT Hub that will route messages to Azure Storage, and a storage account to hold the messages. After manually adding a virtual IoT device to the hub to submit the messages, you configure that connection information in an application called arm-read-write to submit messages from the device to the hub. The hub is configured so the messages sent to the hub are automatically routed to the storage account. At the end of this quickstart, you can open the storage account and see the messages sent.

[!INCLUDE About Azure Resource Manager]

Prerequisites

If you don't have an Azure subscription, create a free Azure account before you begin.

Review the template

The template used in this quickstart is called 101-iothub-auto-route-messages from Azure Quickstart Templates.

:::code language="json" source="~/quickstart-templates/101-iothub-auto-route-messages/azuredeploy.json":::

Two Azure resources are defined in the template:

Deploy the template and run the sample app

This section provides the steps to deploy the template, create a virtual device, and run the arm-read-write application to send the messages.

  1. Create the resources by deploying the ARM template.

    [!TIP] Select the button below to start the deployment of the template. While it's running, set up the arm-read-write application to run.

    Deploy To Azure

  2. Download and unzip the IoT C# Samples.

  3. Open a command window and go to the folder where you unzipped the IoT C# Samples. Find the folder with the arm-read-write.csproj file. You create the environment variables in this command window. Log into the [Azure portal](https://portal.azure.com] to get the keys. Select Resource Groups then select the resource group used for this quickstart.

    Select the resource group

  4. You see the IoT Hub and storage account that were created when you deployed the ARM template. Wait until the template is fully deployed before continuing. Then select your resource group to see your resources.

    View resources in the resource group

  5. You need the hub name. Select the hub in the list of resources. Copy the name of the hub from the top of the IoT Hub section to the Windows clipboard.

    Copy the hub name

    Substitute the hub name in this command where noted, and execute this command in the command window:

    SET IOT_HUB_URI=<hub name goes here>.azure-devices-net;

    which will look this example:

    SET IOT_HUB_URI=ContosoTestHubdlxlud5h.azure-devices-net;

  6. The next environment variable is the IoT Device Key. Add a new device to the hub by selecting IOT Devices from the IoT Hub menu for the hub.

    Select IoT Devices

  7. On the right side of the screen, select + NEW to add a new device.

    Fill in the new device name. This quickstart uses a name starting with Contoso-Test-Device. Save the device and then open that screen again to retrieve the device key. (The key is generated for you when you close the pane.) Select either the primary or secondary key and copy it to the Windows clipboard. In the command window, set the command to execute and then press Enter. The command should look like this one but with the device key pasted in:

    SET IOT_DEVICE_KEY=<device-key-goes-here>

  8. The last environment variable is the Device ID. In the command window, set up the command and execute it.

    SET IOT_DEVICE_ID=<device-id-goes-here>

    which will look like this example:

    SET IOT_DEVICE_ID=Contoso-Test-Device

  9. To see the environment variables you've defined, type SET on the command line and press Enter, then look for the ones starting with IoT.

    See environment variables

Now the environment variables are set, run the application from the same command window. Because you're using the same window, the variables will be accessible in memory when you run the application.

  1. To run the application, type the following command in the command window and press Enter.

    dotnet run arm-read-write

    The application generates and displays messages on the console as it sends each message to the IoT hub. The hub was configured in the ARM template to have automated routing. Messages containing the text "level = storage" are automatically routed to the storage account. Let the app run for 10 to 15 minutes, then press Enter once or twice until it stops running.

Review deployed resources

  1. Log in to the Azure portal and select the Resource Group, then select the storage account.

  2. Drill down into the storage account until you find files.

    Look at the storage account files

  3. Select one of the files and select Download and download the file to a location you can find later. It will have a name that's numeric, like 47. Add ".txt" to the end and then double-click on the file to open it.

  4. When you open the file, each row is for a different message; the body of each message is also encrypted. It must be in order for you to perform queries against the body of the message.

    View the sent messages

    [!NOTE] These messages are encoded in UTF-32 and base64. If you read the message back, you have to decode it from base64 and utf-32 in order to read it as ASCII. If you're interested, you can use the method ReadOneRowFromFile in the Routing Tutorial to read one for from one of these message files and decode it into ASCII. ReadOneRowFromFile is in the IoT C# Samples repository that you unzipped for this quickstart. Here is the path from the top of that folder: ./iot-hub/Tutorials/Routing/SimulatedDevice/Program.cs. Set the boolean readTheFile to true, and hardcode the path to the file on disk, and it will open and translate the first row in the file.

You have deployed an ARM template to create an IoT Hub and a storage account, and run a program to send messages to the hub. The messages are then automatically stored in the storage account where they can be viewed.

Clean up resources

To remove the resources added during this quickstart, log into the Azure portal. Select Resource Groups, then find the resource group you used for this quickstart. Select the resource group and then select Delete. It will delete all of the resources in the group.

Next steps

[!div class="nextstepaction"] Tutorial: Create and deploy your first ARM template