Tutorial: Send device data to Azure Storage using IoT Hub message routing

There are no other prerequisites for the Azure portal.

You can use the local Azure CLI.

• If you prefer, install the Azure CLI to run CLI reference commands.

• Local Azure CLI, see how to install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.

  • Sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.

  • When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.

  • Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.

1. Sign in to the Azure portal and navigate to your IoT hub.

2. Select Devices from the Device management section of the menu.

3. Select Add device.

   

4. Provide a device ID and select Save.

5. The new device should be in the list of devices now. If it's not, refresh the page. Select the device ID to open the device details page.

6. Copy one of the device keys and save it. You'll use this value to configure the sample code that generates simulated device telemetry messages.

   

1. Define variables for your IoT hub and device.

   IOTHUB_NAME: Replace this placeholder with the name of your IoT hub.

   DEVICE_NAME: Replace this placeholder with any name you want to use for the device in this tutorial.

   hubName=IOTHUB_NAME
   deviceName=DEVICE_NAME
   

2. Run the az iot hub device-identity create command in your CLI shell. This command creates the device identity.

   az iot hub device-identity create --device-id $deviceName --hub-name $hubName
   

3. From the device-identity output, copy the primaryKey value without the surrounding quotation marks and save it. You'll use this value to configure the sample code that generates simulated device telemetry messages.

1. In the Azure portal, navigate to your IoT hub.

2. Select Shared access policies from the Security settings section of the menu.

3. Select the iothubowner policy.

   

4. Copy the Primary connection string.

   

1. Run the az iot hub connection-string show command:

   az iot hub connection-string show --hub-name $hubName
   

2. Copy the connection string without the surrounding quotation marks.

1. In the Azure portal, search for Storage accounts.

2. Select Create.

3. Provide the following values for your storage account:

   Expand table

   Parameter	Value
   Subscription	Select the same subscription that contains your IoT hub.
   Resource group	Select the same resource group that contains your IoT hub.
   Storage account name	Provide a globally unique name for your storage account.
   Performance	Accept the default Standard value.

   

4. You can accept all the other default values by selecting Review + create.

5. After validation completes, select Create.

6. After the deployment is complete, select Go to resource.

7. In the storage account menu, select Containers from the Data storage section.

8. Select + Container to create a new container.

   

9. Provide a name for your container and select Create.

1. Define the variables for your storage account and container.

   GROUP_NAME: Replace this placeholder with the name of the resource group that contains your IoT hub.

   STORAGE_NAME: Replace this placeholder with a name for your storage account. Storage account names must be lowercase and globally unique.

   CONTAINER_NAME: Replace this placeholder with a name for your container.

   resourceGroup=GROUP_NAME
   storageName=STORAGE_NAME
   containerName=CONTAINER_NAME
   

2. Use the az storage account create command to create a standard general-purpose v2 storage account.

   az storage account create --name $storageName --resource-group $resourceGroup
   

3. Use the az storage container create to add a container to your storage account.

   az storage container create --auth-mode login --account-name $storageName --name $containerName
   

1. In the Azure portal, go to your IoT hub.

2. In the resource menu under Hub settings, select Message routing then select Add.

   

3. On the Endpoint tab, create a Storage endpoint by providing the following information:

   Expand table

   Parameter	Value
   Endpoint type	Select Storage.
   Endpoint name	Provide a unique name for this endpoint.
   Azure Storage container	Select Pick a container. Follow the prompts to select the storage account and container that you created in the previous section.
   Encoding	Select JSON. If this field is greyed out, then your storage account region doesn't support JSON. In that case, continue with the default AVRO.

   

4. Accept the default values for the rest of the parameters and select Create + next.

5. On the Route tab, provide the following information to create a route that points to the Storage endpoint you created:

   Expand table

   Parameter	Value
   Name	Create a name for your route.
   Data source	Verify that Device Telemetry Messages is selected from the dropdown list.
   Enable route	Verify that this field is checked.
   Routing query	Enter level="storage" as the query string.

   

6. Select Create + skip enrichments.

1. Configure the variables that you need for the endpoint and route commands.

   ENDPOINT_NAME: Provide a name for the endpoint that represents your storage container.

   ROUTE_NAME: Provide a name for the route that filters messages for the storage endpoint

   endpointName=ENDPOINT_NAME
   routeName=ROUTE_NAME
   

2. Use the az iot hub message-endpoint create command to create a custom endpoint that points to the storage container you made in the previous section.

   az iot hub message-endpoint create storage-container \
     --connection-string $(az storage account show-connection-string --name $storageName --query connectionString -o tsv) \
     --endpoint-name $endpointName \
     --hub-name $hubName \
     --container $containerName \
     --resource-group $resourceGroup \
     --encoding json
   

3. Use the az iot hub message-route create command to create a route that passes any message where level=storage to the storage container endpoint.

   az iot hub message-route create \
     --route-name $routeName \
     --hub-name $hubName \
     --resource-group $resourceGroup \
     --source-type devicemessages \
     --endpoint-name $endpointName \
     --enabled true \
     --condition 'level="storage"'
   

1. In the Azure portal, navigate to the resource group that contains the IoT hub and storage account for this tutorial.
2. Review all the resources that are in the resource group to determine which ones you want to clean up.
   • If you want to delete all the resource, select Delete resource group.
   • If you only want to delete certain resource, use the check boxes next to each resource name to select the ones you want to delete. Then select Delete.

1. Use the az resource list command to view all the resources in your resource group.

   az resource list --resource-group $resourceGroup --output table
   

2. Review all the resources that are in the resource group to determine which ones you want to clean up.

   • If you want to delete all the resources, use the az group delete command.

     az group delete --name $resourceGroup
     

   • If you only want to delete certain resources, use the az resource delete command. For example:

     az resource delete --resource-group $resourceGroup --name $storageName