Skip to content

Commit 15ee141

Browse files
authored
Merge pull request #99819 from ScarlettFalls/quickstarts-update
Update for quickstarts deploy module
2 parents 6ac7e8f + 9461856 commit 15ee141

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

includes/iot-edge-deploy-module.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,53 @@
55
author: kgremban
66
ms.service: iot-edge
77
ms.topic: include
8-
ms.date: 11/05/2019
8+
ms.date: 12/31/2019
99
ms.author: kgremban
1010
ms.custom: include file
1111
---
1212

13-
One of the key capabilities of Azure IoT Edge is being able to deploy code to your IoT Edge devices from the cloud. **IoT Edge modules** are executable packages implemented as containers. In this section, you deploy a pre-built module from the [IoT Edge Modules section of the Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules).
13+
One of the key capabilities of Azure IoT Edge is being able to deploy code to your IoT Edge devices from the cloud. **IoT Edge modules** are executable packages implemented as containers. In this section, you deploy a pre-built module from the [IoT Edge Modules section of the Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules) directly from your Azure IoT Hub.
1414

15-
The module that you deploy in this section simulates a sensor and sends generated data. This module is a useful piece of code when you're getting started with IoT Edge because you can use the simulated data for development and testing. If you want to see exactly what this module does, you can view the [simulated temperature sensor source code](https://github.com/Azure/iotedge/blob/027a509549a248647ed41ca7fe1dc508771c8123/edge-modules/SimulatedTemperatureSensor/src/Program.cs).
15+
The module that you deploy in this section simulates a sensor and sends generated data. This module is a useful piece of code when you're getting started with IoT Edge because you can use the simulated data for development and testing. If you want to see exactly what this module does, you can view the [simulated temperature sensor source code](https://github.com/Azure/iotedge/blob/027a509549a248647ed41ca7fe1dc508771c8123/edge-modules/SimulatedTemperatureSensor/src/Program.cs).
1616

1717
To deploy your first module from the Azure Marketplace, use the following steps:
1818

19-
1. In the [Azure portal](https://portal.azure.com), enter **Simulated Temperature Sensor** into the search and open the Marketplace result.
19+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT hub.
2020

21-
![Simulated Temperature Sensor in Azure portal search](./media/iot-edge-deploy-module/search-for-temperature-sensor.png)
21+
1. From the menu on the left pane, under **Automatic Device Management**, select **IoT Edge**.
22+
23+
1. Click on the device ID of the target device from the list of devices.
2224

23-
2. Choose an IoT Edge device to receive this module. On the **Target Devices for IoT Edge Module** page, provide the following information:
25+
1. On the upper bar, select **Set Modules**.
2426

25-
1. **Subscription**: select the subscription that contains the IoT hub you're using.
27+
1. In the **IoT Edge Modules** section of the page, click **Add**.
2628

27-
2. **IoT Hub**: select the name of the IoT hub you're using. Leave **Deploy to a device** selected.
29+
1. From the drop-down menu, select **Marketplace Module**.
2830

29-
3. **IoT Edge Device Name**: if you used the suggested device name earlier in this quickstart, enter **myEdgeDevice**. Or, select **Find Device** to choose from a list of IoT Edge devices in your IoT hub.
31+
![Simulated Temperature Sensor in Azure portal search](./media/iot-edge-deploy-module/search-for-temperature-sensor.png)
3032

31-
4. Select **Create**.
33+
1. In the **IoT Edge Module Marketplace**, search for "Simulated Temperature Sensor" and select that module.
3234

33-
3. Now that you've chosen an IoT Edge module from the Azure Marketplace, and chosen an IoT Edge device to receive the module, you're taken to a tabbed wizard that helps you define exactly how to deploy the module.
35+
1. Notice that the SimulatedTemperatureSensor module is auto populated. In the tutorials, you use this page to add additional modules to your deployment. For this quickstart, only deploy this one module. No credentials are required because it's public.
3436

3537
![Set modules on device](./media/iot-edge-deploy-module/set-modules-on-device.png)
3638

37-
Notice that the **SimulatedTemperatureSensor** module is auto populated. In the tutorials, you use this page to add additional modules to your deployment. For this quickstart, only deploy this one module. No credentials are required because its public.
38-
3939
Select **Next: Routes** to continue to the next step of the wizard.
4040

41-
4. On the **Routes** tab of the wizard, you define how messages are passed between modules and the IoT Hub. Messages are constructed using name/value pairs. For the quickstart, you want all messages from all modules to go to IoT Hub (`$upstream`). If it's not auto populated, add the following code for the **Value** for the **Name** `upstream`:
41+
1. On the **Routes** tab of the wizard, you define how messages are passed between modules and the IoT Hub. Messages are constructed using name/value pairs. For the quickstart, you want all messages from all modules to go to IoT Hub (`$upstream`). If it's not auto populated, add the following code for the **Value** for the **Name** `upstream`:
4242

4343
```sql
4444
FROM /messages/* INTO $upstream
4545
```
4646
4747
Select **Next: Review + create** to continue to the next step of the wizard.
4848
49-
5. On the **Review + create** tab of the wizard, you can preview the JSON file that defines all the modules that get deployed to your IoT Edge device. Notice that the **SimulatedTemperatureSensor** module is included, and two additional system modules called **edgeAgent** and **edgeHub**. Select **Create** when you're done reviewing.
49+
1. On the **Review + create** tab of the wizard, you can preview the JSON file that defines all the modules that get deployed to your IoT Edge device. Notice that the **SimulatedTemperatureSensor** module is included, and two additional system modules called **edgeAgent** and **edgeHub**. Select **Create** when you're done reviewing.
5050
5151
When you submit a new deployment to an IoT Edge device, nothing is pushed to your device. Instead, the device queries IoT Hub regularly for any new instructions. If the device finds an updated deployment manifest, it uses the information about the new deployment to pull the module images from the cloud then starts running the modules locally. This process may take a few minutes.
5252
53-
6. After you create the module deployment details, the wizard returns you to the **IoT Edge** page of your IoT hub. Select your device from the list of IoT Edge devices to see its details.
53+
1. After you create the module deployment details, the wizard returns you to the **IoT Edge** page of your IoT hub. Select your device from the list of IoT Edge devices to see its details.
5454
55-
7. On the device details page, scroll down to the **Modules** section. Three modules should be listed: $edgeAgent, $edgeHub, and SimulatedTemperatureSensor. If one or more of the modules are listed as specified in deployment but not reported by device, your IoT Edge device is still starting them. Wait a few moments and select **Refresh** at the top of the page.
55+
1. On the device details page, scroll down to the **Modules** tab. Three modules should be listed: $edgeAgent, $edgeHub, and SimulatedTemperatureSensor. If one or more of the modules are listed as specified in deployment but not reported by device, your IoT Edge device is still starting them. Wait a few moments and select **Refresh** at the top of the page.
5656
5757
![View SimulatedTemperatureSensor in list of deployed modules](./media/iot-edge-deploy-module/deployed-modules-marketplace.png)
55.2 KB
Loading
-23.4 KB
Loading

0 commit comments

Comments
 (0)