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
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-deploy-modules-portal.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
---
2
2
title: Deploy modules from Azure portal - Azure IoT Edge
3
-
description: Use your IoT Hub in the Azure portal to push an IoT Edge module from your IoT Hub to your IoT Edge device, as configured by a deployment manifest.
3
+
description: Use your IoT hub in the Azure portal to push an IoT Edge module from your IoT hub to your IoT Edge device, as configured by a deployment manifest.
> Starting August 28th 2024, Azure Marketplace is updating the distribution model for IoT Edge modules. Partners (module publishers) will begin [hosting their IoT Edge modules](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?subcategories=iot-edge-modules&filters=partners&page=1) on publisher-owned container registries. IoT Edge module images won't be available for download from the Azure Marketplace container registry.
18
+
> Starting August 28, 2024, Microsoft Azure Marketplace is updating the distribution model for IoT Edge modules. Partners (module publishers) begin [hosting their IoT Edge modules](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?subcategories=iot-edge-modules&filters=partners&page=1) on publisher-owned container registries. IoT Edge module images aren't available for download from the container registry for Azure Marketplace.
19
19
>
20
20
> Contact the [IoT Edge module publisher](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?filters=partners&subcategories=iot-edge-modules&page=1) to obtain the updated container image URI and [update your IoT Edge device configurations](how-to-update-iot-edge.md#update-partner-module-uris) with the new image URI provided by the publisher.
21
21
>
22
22
> IoT Edge devices that don't use [partner modules](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?filters=partners&page=1&subcategories=iot-edge-modules) acquired from Azure Marketplace aren't affected and no action is required.
23
23
24
24
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.
25
25
26
-
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](how-to-deploy-at-scale.md).
26
+
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 IoT Edge modules at scale using the Azure portal](how-to-deploy-at-scale.md).
27
27
28
28
## Prerequisites
29
29
30
-
* An [IoT Hub](../iot-hub/iot-hub-create-through-portal.md) in your Azure subscription.
30
+
* An [IoT hub](../iot-hub/iot-hub-create-through-portal.md) in your Azure subscription.
31
31
* An IoT Edge device.
32
32
33
-
If you don't have an IoT Edge device set up, you can create one in an Azure virtual machine. Follow the steps in one of the quickstart articles to [Create a virtual Linux device](quickstart-linux.md) or [Create a virtual Windows device](quickstart.md).
33
+
If you don't have an IoT Edge device set up, you can create one in an Azure virtual machine. Follow the steps in one of the quickstart articles to [create a virtual Linux device](quickstart-linux.md) or [create a virtual Windows device](quickstart.md).
34
34
35
35
## Configure a deployment manifest
36
36
37
-
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](module-composition.md).
37
+
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 [Learn how to deploy modules and establish routes in IoT Edge](module-composition.md).
38
38
39
39
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**.
40
40
41
41
>[!NOTE]
42
42
>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.
43
43
>
44
-
>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.
44
+
>If you're 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.
45
45
46
46
### Select device and add modules
47
47
48
-
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT Hub.
48
+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT hub.
49
49
1. On the left pane, select **Devices** under the **Device management** menu.
50
50
1. Select the target IoT Edge device from the list.
51
51
1. On the upper bar, select **Set Modules**.
52
-
1. In the **Container Registry Credentials** section of the page, provide credentials to access container registries that contain module images. For example, your modules are in your private container registry or you are using a partner container registry that requires authentication.
52
+
1. In the **Container Registry Credentials** section of the page, provide credentials to access container registries that contain module images. For example, your modules are in your private container registry or you're using a partner container registry that requires authentication.
53
53
1. In the **IoT Edge Modules** section of the page, select **Add**.
54
54
55
55
:::image type="content" source="media/how-to-deploy-modules-portal/set-modules-add.png" alt-text="Screenshot of selecting add IoT Edges modules toolbar button in the Azure portal.":::
@@ -92,7 +92,7 @@ For more information about deploying Azure Stream Analytics in an IoT Edge modul
92
92
93
93
### Specify routes
94
94
95
-
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.
95
+
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.
96
96
97
97
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.
98
98
@@ -102,16 +102,16 @@ Once the routes are set, select **Next: Review + create** to continue to the nex
102
102
103
103
### Review deployment
104
104
105
-
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](iot-edge-runtime.md) and are required defaults in every deployment.
105
+
The review section shows you the JSON deployment manifest that was created based on your selections in the previous two sections. There are two modules declared that you didn't add: **$edgeAgent** and **$edgeHub**. These two modules make up the [IoT Edge runtime](iot-edge-runtime.md) and are required defaults in every deployment.
106
106
107
107
Review your deployment information, then select **Create**.
108
108
109
109
## View modules on your device
110
110
111
-
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.
111
+
Once you deploy 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, and useful information like the deployment status and exit code.
112
112
113
-
Select **Next: Routes** and continue with deployment as described by [Specify routes](#specify-routes) and [Review Deployment](#review-deployment) earlier in this article.
113
+
Select **Next: Routes** and continue with deployment as described by [Specify routes](#specify-routes) and [Review deployment](#review-deployment) earlier in this article.
114
114
115
115
## Next steps
116
116
117
-
Learn how to [Deploy and monitor IoT Edge modules at scale](how-to-deploy-at-scale.md).
117
+
Learn how to [Deploy IoT Edge modules at scale using the Azure portal](how-to-deploy-at-scale.md).
0 commit comments