Skip to content

Commit 0d41531

Browse files
authored
Merge pull request #109410 from ScarlettFalls/visual-studio-update
UI updates for develop IoT Edge module Visual Studio
2 parents 25f6186 + f06ee85 commit 0d41531

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

articles/iot-edge/how-to-visual-studio-develop-module.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ description: Use Visual Studio with Azure IoT Tools to develop a C or C# IoT Edg
44
services: iot-edge
55
author: shizn
66
manager: philmea
7-
87
ms.author: xshi
9-
ms.date: 07/22/2019
8+
ms.date: 3/27/2020
109
ms.topic: conceptual
1110
ms.service: iot-edge
1211
---
@@ -25,7 +24,7 @@ This article shows you how to use the Azure IoT Edge Tools for Visual Studio 201
2524

2625
## Prerequisites
2726

28-
This article assumes that you use a computer or virtual machine running Windows as your development machine. On Windows computers you can develop either Windows or Linux modules. To develop Windows modules, use a Windows computer running version 1809/build 17763 or newer. To develop Linux modules, use a Windows computer that meets the [requirements for Docker Desktop](https://docs.docker.com/docker-for-windows/install/#what-to-know-before-you-install).
27+
This article assumes that you use a computer or virtual machine running Windows as your development machine. On Windows computers, you can develop either Windows or Linux modules. To develop Windows modules, use a Windows computer running version 1809/build 17763 or newer. To develop Linux modules, use a Windows computer that meets the [requirements for Docker Desktop](https://docs.docker.com/docker-for-windows/install/#what-to-know-before-you-install).
2928

3029
Because this article uses Visual Studio 2019 as the main development tool, install Visual Studio. Make sure you include the **Azure development** and **Desktop development with C++** workloads in your Visual Studio 2019 installation. You can [Modify Visual Studio 2019](https://docs.microsoft.com/visualstudio/install/modify-visual-studio?view=vs-2019) to add the required workloads.
3130

@@ -66,15 +65,15 @@ After your Visual Studio 2019 is ready, you also need the following tools and co
6665

6766
### Check your tools version
6867

69-
1. From the **Tools** menu, select **Extensions and Updates**. Expand **Installed > Tools** and you can find **Azure IoT Edge Tools** and **Cloud Explorer for Visual Studio**.
68+
1. From the **Extensions** menu, select **Manage Extensions**. Expand **Installed > Tools** and you can find **Azure IoT Edge Tools for Visual Studio** and **Cloud Explorer for Visual Studio**.
7069

7170
1. Note the installed version. You can compare this version with the latest version on Visual Studio Marketplace ([Cloud Explorer](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.CloudExplorerForVS2019), [Azure IoT Edge](https://marketplace.visualstudio.com/items?itemName=vsc-iot.vs16iotedgetools))
7271

7372
1. If your version is older than what's available on Visual Studio Marketplace, update your tools in Visual Studio as shown in the following section.
7473

7574
### Update your tools
7675

77-
1. In the **Extensions and Updates** dialog, expand **Updates > Visual Studio Marketplace**, select **Azure IoT Edge Tools** or **Cloud Explorer for Visual Studio** and select **Update**.
76+
1. In the **Manage Extensions** window, expand **Updates > Visual Studio Marketplace**, select **Azure IoT Edge Tools** or **Cloud Explorer for Visual Studio** and select **Update**.
7877

7978
1. After the tools update is downloaded, close Visual Studio to trigger the tools update using the VSIX installer.
8079

@@ -117,7 +116,7 @@ When you're ready to customize the module template with your own code, use the [
117116

118117
![Copy Edge Device Connection String](./media/how-to-visual-studio-develop-csharp-module/copy-edge-conn-string.png)
119118

120-
1. Go to **Tools** > **Azure IoT Edge Tools** > **Setup IoT Edge Simulator**, paste the connection string and click **OK**.
119+
1. From the **Tools** menu, select **Azure IoT Edge Tools** > **Setup IoT Edge Simulator**, paste the connection string and click **OK**.
121120

122121
![Open Set Edge Connection String Window](./media/how-to-visual-studio-develop-csharp-module/set-edge-conn-string.png)
123122

@@ -130,7 +129,7 @@ When you're ready to customize the module template with your own code, use the [
130129

131130
Typically, you'll want to test and debug each module before running it within an entire solution with multiple modules.
132131

133-
1. Right-click **IotEdgeModule1** and select **Set as StartUp Project** from the context menu.
132+
1. In **Solution Explorer**, right-click **IotEdgeModule1** and select **Set as StartUp Project** from the context menu.
134133

135134
![Set Start-up Project](./media/how-to-visual-studio-develop-csharp-module/module-start-up-project.png)
136135

@@ -161,7 +160,7 @@ Typically, you'll want to test and debug each module before running it within an
161160

162161
After you're done developing a single module, you might want to run and debug an entire solution with multiple modules.
163162
164-
1. Add a second module to the solution by right-clicking **AzureIoTEdgeApp1** and selecting **Add** > **New IoT Edge Module**. The default name of the second module is **IotEdgeModule2** and will act as another pipe module.
163+
1. In **Solution Explorer**, add a second module to the solution by right-clicking **AzureIoTEdgeApp1** and selecting **Add** > **New IoT Edge Module**. The default name of the second module is **IotEdgeModule2** and will act as another pipe module.
165164
166165
1. Open the file `deployment.template.json` and you'll see **IotEdgeModule2** has been added in the **modules** section. Replace the **routes** section with the following. If you have customized your module names, make sure you update these names to match.
167166

@@ -189,7 +188,7 @@ After you're done developing a single module, you might want to run and debug an
189188
> [!NOTE]
190189
> When choosing **Debug**, Visual Studio uses `Dockerfile.(amd64|windows-amd64).debug` to build Docker images. This includes the .NET Core command-line debugger VSDBG in your container image while building it. For production-ready IoT Edge modules, we recommend that you use the **Release** configuration, which uses `Dockerfile.(amd64|windows-amd64)` without VSDBG.
191190

192-
1. If you're using a private registry like Azure Container Registry, use the following Docker command to sign in to it. If you're using local registry, you can [run a local registry](https://docs.docker.com/registry/deploying/#run-a-local-registry).
191+
1. If you're using a private registry like Azure Container Registry (ACR), use the following Docker command to sign in to it. You can get the username and password from the **Access keys** page of your registry in the Azure portal. If you're using local registry, you can [run a local registry](https://docs.docker.com/registry/deploying/#run-a-local-registry).
193192

194193
```cmd
195194
docker login -u <ACR username> -p <ACR password> <ACR login server>
@@ -211,9 +210,7 @@ After you're done developing a single module, you might want to run and debug an
211210
}
212211
```
213212
214-
1. Right-click **AzureIoTEdgeApp1** and select **Build and Push Edge Solution** to build and push the Docker image for each module.
215-
216-
![Build and Push Images](./media/how-to-visual-studio-develop-csharp-module/build-and-push.png)
213+
1. In **Solution Explorer**, right-click **AzureIoTEdgeApp1** and select **Build and Push IoT Edge Modules** to build and push the Docker image for each module.
217214
218215
## Deploy the solution
219216
@@ -223,18 +220,15 @@ In the quickstart article that you used to set up your IoT Edge device, you depl
223220

224221
1. In **Cloud Explorer**, expand your subscription, find your Azure IoT Hub and the Azure IoT Edge device you want to deploy.
225222

226-
1. Right-click on the IoT Edge device to create a deployment for it, you need to select the deployment manifest file under the `$AzureIoTEdgeAppSolutionDir\config\deployment.(amd64|amd64.debug|windows-amd64).json`.
227-
228-
> [!NOTE]
229-
> You must not select `$AzureIoTEdgeAppSolutionDir\config\deployment_for_local_debug.json`
223+
1. Right-click on the IoT Edge device to create a deployment for it. Navigate to the deployment manifest configured for your platform located in the **config** folder in your Visual Studio solution, such as `deployment.arm32v7.json`.
230224

231225
1. Click the refresh button to see the new modules running along with the **SimulatedTemperatureSensor** module and **$edgeAgent** and **$edgeHub**.
232226

233227
## View generated data
234228

235-
1. To monitor the D2C message for a specific device, select the device in the list and then click **Start Monitoring Built-in Event Endpoint** in the **Action** window.
229+
1. To monitor the D2C message for a specific IoT-Edge device, select it in your IoT hub in **Cloud Explorer** and then click **Start Monitoring Built-in Event Endpoint** in the **Action** window.
236230

237-
1. To stop monitoring data, select the device in the list and then select **Stop Monitoring Built-in Event Endpoint** in the **Action** window.
231+
1. To stop monitoring data, select **Stop Monitoring Built-in Event Endpoint** in the **Action** window.
238232

239233
## Next steps
240234

0 commit comments

Comments
 (0)