You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Quickstart: Deploy an Azure IoT hub and a storage account using an ARM template
15
15
16
-
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.
16
+
In this quickstart, you use an Azure Resource Manager template (ARM template) to create an IoT hub, an Azure Storage account, and a route to send messages from the IoT hub to storage. The hub is configured so the messages sent to the hub are automatically routed to the storage account if they meet the routing condition. At the end of this quickstart, you can open the storage account and see the messages sent.
If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template will open in the Azure portal.
20
+
If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template opens in the Azure portal.
21
21
22
22
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.devices%2Fiothub-auto-route-messages%2Fazuredeploy.json)
23
23
24
24
## Prerequisites
25
25
26
-
- If you don't have an Azure subscription, create a [free Azure account](https://azure.microsoft.com/free/) before you begin.
27
-
28
-
- The sample application you run in this quickstart is written using C#. You need the .NET SDK 6.0 or greater on your development machine.
29
-
30
-
You can download the .NET Core SDK for multiple platforms from [.NET](https://dotnet.microsoft.com/download).
31
-
32
-
You can verify the current version of C# on your development machine using the following command:
33
-
34
-
```cmd/sh
35
-
dotnet --version
36
-
```
37
-
38
-
- Download and unzip the [IoT C# SDK](https://github.com/Azure/azure-iot-sdk-csharp/archive/main.zip).
26
+
* If you don't have an Azure subscription, create a [free Azure account](https://azure.microsoft.com/free/) before you begin.
39
27
40
28
## Review the template
41
29
42
30
The template used in this quickstart is called `101-iothub-auto-route-messages` from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/iothub-auto-route-messages).
This section provides the steps to deploy the template, create a virtual device, and run the arm-read-write application to send the messages.
34
+
*[Microsoft.Storage/storageAccounts](/azure/templates/microsoft.storage/storageaccounts): A storage account with a container.
35
+
*[Microsoft.Devices/IotHubs](/azure/templates/microsoft.devices/iothubs): An IoT hub with an endpoint that points to the storage container and a route to send filtered messages to that endpoint.
54
36
55
-
1. Create the resources by deploying the ARM template.
56
-
57
-
> [!TIP]
58
-
> Select the button below to start the deployment of the template. While it's running, set up the arm-read-write application to run.
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.devices%2Fiothub-auto-route-messages%2Fazuredeploy.json)
39
+
## Deploy the template
61
40
62
-
1. Open a command window and go to the folder where you unzipped the IoT C# SDK. Find the folder with the arm-read-write.csproj file. You create the environment variables in this command window. Sign in to the [Azure portal](https://portal.azure.com) to get the keys. Select **Resource Groups** then select the resource group used for this quickstart.
41
+
This section provides the steps to deploy the ARM template.
63
42
64
-
43
+
- Create the resources by deploying the ARM template.
65
44
66
-
1. 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.
45
+
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.devices%2Fiothub-auto-route-messages%2Fazuredeploy.json)
67
46
68
-
47
+
## Send device-to-cloud messages
69
48
70
-
1. 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.
49
+
In this section, you register a device in your new IoT hub and then send messages from that device to IoT Hub. The route that the template configured in the IoT hub only sends messages to storage if they contain the message property `level=storage`. To test that this routing condition works as expected, we'll send some messages with that property and some without.
71
50
72
-
Substitute the hub name in this command where noted, and execute this command in the command window:
51
+
>[!TIP]
52
+
>This quickstart uses the Azure CLI simulated device for convenience. For a code example of sending device-to-cloud messages with message properties for routing, see [HubRoutingSample](https://github.com/Azure/azure-iot-sdk-csharp/tree/main/iothub/device/samples/how%20to%20guides/HubRoutingSample) in the Azure IoT SDK for .NET.
73
53
74
-
```cmd
75
-
SET IOT_HUB_URI=<hub name goes here>.azure-devices-net;
76
-
```
54
+
1. Retrieve the name of the IoT hub that the template created for you.
77
55
78
-
which will look this example:
56
+
If you used the default commands in the previous section, your resources were created in the **ContosoResourceGrp** resource group. If you used a different resource group, update the following command to match.
79
57
80
-
```cmd
81
-
SET IOT_HUB_URI=ContosoTestHubdlxlud5h.azure-devices-net;
58
+
```azurecli
59
+
az iot hub list --resource-group ContosoResourceGrp --output table
82
60
```
83
61
84
-
1. The next environment variable is the IoT Device Key. Add a new device to the hub by selecting **Devices** from the IoT Hub menu for the hub.
85
-
86
-
:::image type="content" source="./media/horizontal-arm-route-messages/04-select-iot-devices.png" alt-text="Screenshot that shows devices in the left pane." border="true":::
87
-
88
-
1. On the right side of the screen, select **+ Add Device** to add a new device.
62
+
1. Copy the name of your IoT hub from the output. It should be formatted like `contosoHub{randomidentifier}`
89
63
90
-
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:
64
+
1. Add a device to the hub.
91
65
92
-
```cmd
93
-
SET IOT_DEVICE_KEY=<device-key-goes-here>
66
+
```azurecli
67
+
az iot hub device-identity create --device-id contosoDevice --hub-name {YourIoTHubName}
94
68
```
95
69
96
-
1.The last environment variable is the **Device ID**. In the command window, set up the command and execute it.
70
+
1.Simulate the device and send device-to-cloud messages.
97
71
98
-
```cmd
99
-
SET IOT_DEVICE_ID=<device-id-goes-here>
100
-
```
101
-
102
-
which will look like this example:
72
+
The `--data` parameter lets us set the message body.
103
73
104
-
```cmd
105
-
SET IOT_DEVICE_ID=Contoso-Test-Device
74
+
```azurecli
75
+
az iot device simulate \
76
+
--device-id contosoDevice \
77
+
--hub-name {YourIoTHubName} \
78
+
--data "This message won't be routed."
106
79
```
107
80
108
-
1. 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**.
81
+
The simulator sends 100 messages and then disconnects. You don't need to wait for all 100 for the purposes of this quickstart.
>The Azure CLI won't print the messages as it sends them. If you want to watch the messages as the arrive at your hub, you can install the [Azure IoT Hub extension for Visual Studio Code](./reference-iot-hub-extension.md) and use it to monitor the built-in endpoint.
111
85
112
-
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.
86
+
1. Send device-to-cloud messages to be routed to storage.
113
87
114
-
1. To run the application, type the following command in the command window and press **Enter**.
88
+
The `--properties` parameter allows us to add message, application, or system properties to the default message. For this quickstart, the route in your IoT hub is looking for messages that contain the message property `level=storage`.
115
89
116
-
`dotnet run arm-read-write`
117
-
118
-
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.
90
+
```azurecli
91
+
az iot device simulate \
92
+
--device-id contosoDevice \
93
+
--hub-name {YourIoTHubName} \
94
+
--properties level=storage \
95
+
--data "This message will be routed to storage."
96
+
```
119
97
120
98
## Review deployed resources
121
99
@@ -125,7 +103,7 @@ This section provides the steps to deploy the template, create a virtual device,
125
103
126
104
127
105
128
-
1. 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.
106
+
1. Select one of the files and select **Download** and download the file to a location you can find later. It has a name that's numeric, like 47. Add _.txt_ to the end and then double-click on the file to open it.
129
107
130
108
1. 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.
131
109
@@ -134,11 +112,11 @@ This section provides the steps to deploy the template, create a virtual device,
134
112
> [!NOTE]
135
113
> 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# SDK repository that you unzipped for this quickstart. Here is the path from the top of that folder: *./iothub/device/samples/getting started/RoutingTutorial/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.
136
114
137
-
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.
115
+
In this quickstart, you deployed an ARM template to create an IoT hub and a storage account, then run a program to send messages to the hub. The messages are routed based on their message properties and stored in the storage account where they can be viewed.
138
116
139
117
## Clean up resources
140
118
141
-
To remove the resources added during this quickstart, sign in to the [Azure portal](https://portal.azure.com). 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.
119
+
To remove the resources added during this quickstart, sign in to the [Azure portal](https://portal.azure.com). Select **Resource Groups**, then find the resource group you used for this quickstart. Select the resource group and then select *Delete*. When the group is deleted, so are all of the resources in the group.
0 commit comments