Edit

Deploy Azure IoT Edge modules from the Azure portal

  • Article

Applies to: IoT Edge 1.4 checkmark IoT Edge 1.4

Important

IoT Edge 1.4 is the supported release. If you are on an earlier release, see Update IoT Edge.

Once you create IoT Edge modules with your business logic, you want to deploy them to your devices to operate at the edge. If you have multiple modules that work together to collect and process data, you can deploy them all at once and declare the routing rules that connect them.

This article shows how the Azure portal guides you through creating a deployment manifest and pushing the deployment to an IoT Edge device. For information about creating a deployment that targets multiple devices based on their shared tags, see Deploy and monitor IoT Edge modules at scale.

Prerequisites

Configure a deployment manifest

A deployment manifest is a JSON document that describes which modules to deploy, how data flows between the modules, and desired properties of the module twins. For more information about how deployment manifests work and how to create them, see Understand how IoT Edge modules can be used, configured, and reused.

The Azure portal has a wizard that walks you through creating the deployment manifest, instead of building the JSON document manually. It has three steps: Add modules, Specify routes, and Review deployment.

Note

The steps in this article reflect the latest schema version of the IoT Edge agent and hub. Schema version 1.1 was released along with IoT Edge version 1.0.10, and enables the module startup order and route prioritization features.

If you are deploying to a device running version 1.0.9 or earlier, edit the Runtime Settings in the Modules step of the wizard to use schema version 1.0.

Select device and add modules

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

  2. On the left pane, select Devices under the Device management menu.

  3. Select the target IoT Edge device from the list.

  4. On the upper bar, select Set Modules.

  5. In the Container Registry Credentials section of the page, provide the credentials to access any private container registries that contain your module images.

  6. In the IoT Edge Modules section of the page, select Add.

  7. Choose one of the three types of modules from the drop-down menu:

    • IoT Edge Module - You provide the module name and container image URI. For example, the image URI for the sample SimulatedTemperatureSensor module is mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0. If the module image is stored in a private container registry, add the credentials on this page to access the image.
    • Marketplace Module - Modules hosted in the Azure Marketplace. Some marketplace modules require additional configuration, so review the module details in the Azure Marketplace IoT Edge Modules list.
    • Azure Stream Analytics Module - Modules generated from an Azure Stream Analytics workload.

  8. After adding a module, select the module name from the list to open the module settings. Fill out the optional fields if necessary.

    For more information about the available module settings, see Module configuration and management.

    For more information about the module twin see Define or update desired properties.

  9. Repeat steps 6 through 8 to add additional modules to your deployment.

  10. Select Next: Routes to continue to the routes section.

Specify routes

On the Routes tab, you define how messages are passed between modules and the IoT Hub. Messages are constructed using name/value pairs. By default, the first deployment for a new device includes a route called route and defined as FROM /messages/* INTO $upstream, which means that any messages output by any modules are sent to your IoT hub.

The Priority and Time to live parameters are optional parameters that you can include in a route definition. The priority parameter allows you to choose which routes should have their messages processed first, or which routes should be processed last. Priority is determined by setting a number 0-9, where 0 is top priority. The time to live parameter allows you to declare how long messages in that route should be held until they're either processed or removed from the queue.

For more information about how to create routes, see Declare routes.

Once the routes are set, select Next: Review + create to continue to the next step of the wizard.

Review deployment

The review section shows you the JSON deployment manifest that was created based on your selections in the previous two sections. Note that there are two modules declared that you didn't add: $edgeAgent and $edgeHub. These two modules make up the IoT Edge runtime and are required defaults in every deployment.

Review your deployment information, then select Create.

View modules on your device

Once you've deployed modules to your device, you can view all of them in the device details page of your IoT Hub. This page displays the name of each deployed module, as well as useful information like the deployment status and exit code.

Deploy modules from Azure Marketplace

Azure Marketplace is an online applications and services marketplace where you can browse through a wide range of enterprise applications and solutions that are certified and optimized to run on Azure, including IoT Edge modules.

You can deploy an IoT Edge module from the Azure Marketplace and from your IoT Hub.

Deploy from Azure Marketplace

Peruse the IoT Edge modules in the marketplace and when you find the one you want you can deploy it by selecting Create or Get it now. Proceed with the deployment wizard steps which may vary depending on the IoT Edge module you selected:

  1. Acknowledge the provider's terms of use and privacy policy by selecting Continue. You may first have to provide contact information.
  2. Choose your subscription and the IoT Hub to which the target device is attached.
  3. Choose Deploy to a device.
  4. Enter the name of the device or select Find Device to browse among the devices registered with the hub.
  5. Select Create to continue the standard process of configuring a deployment manifest, including adding other modules if desired. Details for the new module such as image URI, create options, and desired properties are predefined but can be changed.

Verify that the module is deployed in your IoT Hub in the Azure portal. Select your device, select Set Modules and the module should be listed in the IoT Edge Modules section.

Deploy from Azure IoT Hub

You can quickly deploy a module from the Azure Marketplace onto your device in your IoT Hub in the Azure portal.

  1. In the Azure portal, navigate to your IoT Hub.
  2. On the left pane, select Devices under the Device management menu.
  3. Select the IoT Edge device that is to receive the deployment.
  4. On the upper bar, select Set Modules.
  5. In the IoT Edge Modules section, click Add, and select Marketplace Module from the drop-down menu.

Screenshot showing how to add a module in I o T Hub.

Choose a module from the IoT Edge Module Marketplace page. The module you select is automatically configured for your subscription, resource group, and device. It then appears in your list of IoT Edge modules. Some modules may require additional configuration.

Tip

The information about IoT Edge modules from the Azure IoT Hub is limited. You can first learn more about the IoT Edge modules in the Azure Marketplace.

Select Next: Routes and continue with deployment as described by Specify routes and Review Deployment earlier in this article.

Next steps

Learn how to Deploy and monitor IoT Edge modules at scale