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-cli.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,7 @@ Here's a basic deployment manifest with one module as an example:
115
115
116
116
You deploy modules to your device by applying the deployment manifest that you configured with the module information.
117
117
118
-
Change directories into the folder where your deployment manifest is saved. If you used one of the VS Code IoT Edge templates, use the `deployment.json` file in the **config** folder of your solution directory and not the `deployment.template.json` file.
118
+
Change directories into the folder where your deployment manifest is saved. If you used one of the Visual Studio Code IoT Edge templates, use the `deployment.json` file in the **config** folder of your solution directory and not the `deployment.template.json` file.
119
119
120
120
Use the following command to apply the configuration to an IoT Edge device:
The results of your deployment are printed in the VS Code output. Successful deployments are applied within a few minutes if the target device is running and connected to the internet.
144
+
The results of your deployment are printed in the Visual Studio Code output. Successful deployments are applied within a few minutes if the target device is running and connected to the internet.
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-vs-code-develop-module.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Develop and debug modules Azure IoT Edge modules using VS Code
2
+
title: Develop and debug modules Azure IoT Edge modules using Visual Studio Code
3
3
description: Use Visual Studio Code to develop, build, and debug a module for Azure IoT Edge using C#, Python, Node.js, Java, or C
4
4
services: iot-edge
5
5
author: PatAltimore
@@ -17,7 +17,7 @@ zone_pivot_groups: iotedge-dev
17
17
18
18
This article shows you how to use Visual Studio Code to develop and debug IoT Edge modules in multiple languages and multiple architectures. On your development computer, you can use Visual Studio Code to attach and debug your module in a local or remote module container.
19
19
20
-
You can choose either the **Azure IoT Edge Dev Tool** CLI or the **Azure IoT Edge tools for VS Code** extension as your IoT Edge development tool. Use the tool selector button at the beginning to choose your tool option for this article.
20
+
You can choose either the **Azure IoT Edge Dev Tool** CLI or the **Azure IoT Edge tools for Visual Studio Code** extension as your IoT Edge development tool. Use the tool selector button at the beginning to choose your tool option for this article.
21
21
22
22
Visual Studio Code supports writing IoT Edge modules in the following programming languages:
23
23
@@ -93,11 +93,11 @@ Install prerequisites specific to the language you're developing in:
- Install [C# VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
96
+
- Install [C# Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
97
97
98
98
# [C](#tab/c)
99
99
100
-
- Install [C/C++ VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
100
+
- Install [C/C++ Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
101
101
102
102
# [Java](#tab/java)
103
103
@@ -111,7 +111,7 @@ Install prerequisites specific to the language you're developing in:
111
111
# [Python](#tab/python)
112
112
113
113
- Install [Python](https://www.python.org/downloads/) and [Pip](https://pip.pypa.io/en/stable/installation/)
114
-
- Install [Python VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
114
+
- Install [Python Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
115
115
- Install the Python-based [Azure IoT Edge Dev Tool](https://pypi.org/project/iotedgedev/) to debug, run, and test your IoT Edge solution. You can alternatively install the Azure IoT Edge Dev Tool using the CLI:
116
116
117
117
```cmd
@@ -709,25 +709,25 @@ Add your breakpoint to the file `main.py`in the callback method where you added
709
709
710
710
---
711
711
712
-
To debug modules on a remote device, you can use Remote SSH debugging in VS Code.
712
+
To debug modules on a remote device, you can use Remote SSH debugging in Visual Studio Code.
713
713
714
-
To enable VS Code remote debugging, install the [Remote Development extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack). For more information about VS Code remote debugging, see [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).
714
+
To enable Visual Studio Code remote debugging, install the [Remote Development extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack). For more information about Visual Studio Code remote debugging, see [Visual Studio Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).
715
715
716
-
For details on how to use Remote SSH debugging in VS Code, see [Remote Development using SSH](https://code.visualstudio.com/docs/remote/ssh)
716
+
For details on how to use Remote SSH debugging in Visual Studio Code, see [Remote Development using SSH](https://code.visualstudio.com/docs/remote/ssh)
717
717
718
718
In the Visual Studio Code Debug view, select the debug configuration file for your module. By default, the **.debug** Dockerfile, module's container `createOptions` settings, and `launch.json` file are configured to use *localhost*.
719
719
720
720
Select **Start Debugging** or select**F5**. Select the process to attach to. In the Visual Studio Code Debug view, you'll see the variables in the left panel.
721
721
722
722
## Debug using Docker Remote SSH
723
723
724
-
The Docker and Moby engines support SSH connections to containers allowing you to debug in VS Code connected to a remote device. You need to meet the following prerequisites before you can use this feature.
724
+
The Docker and Moby engines support SSH connections to containers allowing you to debug in Visual Studio Code connected to a remote device. You need to meet the following prerequisites before you can use this feature.
725
725
726
726
### Configure Docker SSH tunneling
727
727
728
728
1. Follow the steps in [Docker SSH tunneling](https://code.visualstudio.com/docs/containers/ssh#_set-up-ssh-tunneling) to configure SSH tunneling on your development computer. SSH tunneling requires public/private key pair authentication and a Docker context defining the remote device endpoint.
729
729
1. Connecting to Docker requires root-level privileges. Follow the steps in [Manage docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall) to allow connection to the Docker daemon on the remote device. When you're finished debugging, you may want to remove your user from the Docker group.
730
-
1. In Visual Studio Code, use the Command Palette (Ctrl+Shift+P) to issue the *Docker Context: Use*command to activate the Docker context pointing to the remote machine. This command causes both VS Code and Docker CLI to use the remote machine context.
730
+
1. In Visual Studio Code, use the Command Palette (Ctrl+Shift+P) to issue the *Docker Context: Use*command to activate the Docker context pointing to the remote machine. This command causes both Visual Studio Code and Docker CLI to use the remote machine context.
731
731
732
732
> [!TIP]
733
733
> All Docker commands use the current context. Remember to change context back to *default* when you are done debugging.
@@ -751,7 +751,7 @@ The Docker and Moby engines support SSH connections to containers allowing you t
751
751
edgeAgent
752
752
```
753
753
754
-
1. In the *.vscode* directory, add a new configuration to **launch.json** by opening the file inVS Code. Select **Add configuration**then choose the matching remote attach template foryour module. For example, the following configuration is for .NET Core. Change the value for the *-H* parameterin*PipeArgs* to your device DNS name or IP address.
754
+
1. In the *.vscode* directory, add a new configuration to **launch.json** by opening the file inVisual Studio Code. Select **Add configuration**then choose the matching remote attach template foryour module. For example, the following configuration is for .NET Core. Change the value for the *-H* parameterin*PipeArgs* to your device DNS name or IP address.
755
755
756
756
```json
757
757
"configurations": [
@@ -785,13 +785,13 @@ The Docker and Moby engines support SSH connections to containers allowing you t
785
785
786
786
### Remotely debug your module
787
787
788
-
1. In VS Code Debug view, selectthe debug configuration *Remote Debug IoT Edge Module (.NET Core)*.
788
+
1. In Visual Studio Code Debug view, selectthe debug configuration *Remote Debug IoT Edge Module (.NET Core)*.
789
789
1. Select **Start Debugging** or select**F5**. Select the process to attach to.
790
790
1. In the Visual Studio Code Debug view, you'll see the variables in the left panel.
791
-
1. In VS Code, set breakpoints in your custom module.
791
+
1. In Visual Studio Code, set breakpoints in your custom module.
792
792
1. When a breakpoint is hit, you can inspect variables, step through code, and debug your module.
793
793
794
-
:::image type="content" source="media/how-to-vs-code-develop-module/vs-code-breakpoint.png" alt-text="Screenshot of VS Code attached to a Docker container on a remote device paused at a breakpoint.":::
794
+
:::image type="content" source="media/how-to-vs-code-develop-module/vs-code-breakpoint.png" alt-text="Screenshot of Visual Studio Code attached to a Docker container on a remote device paused at a breakpoint.":::
795
795
> [!NOTE]
796
796
> The preceding example shows how to debug IoT Edge modules on remote containers. It added a remote Docker context and changes to the Docker privileges on the remote device. After you finish debugging your modules, set your Docker context to *default* and remove privileges from your user account.
Copy file name to clipboardExpand all lines: articles/iot-edge/includes/debug-without-container-setup.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ IoT Edge modules need an IoT Edge environment to run and debug. You can use an I
31
31
32
32
You can use the Docker Explorer view in Visual Studio Code to see the module's running status.
33
33
34
-
:::image type="content" source="media/simulator-status.png" alt-text="Screenshot showing simulator module status in the Docker Explorer pane of VS Code.":::
34
+
:::image type="content" source="media/simulator-status.png" alt-text="Screenshot showing simulator module status in the Docker Explorer pane of Visual Studio Code.":::
35
35
36
36
The **edgeHubDev** container is the core of the local IoT Edge simulator. It can run on your development machine without the IoT Edge security daemon and provides environment settings for your native module app or module containers. The **input** container exposes REST APIs to help bridge messages to the target input channel on your module.
Copy file name to clipboardExpand all lines: articles/iot-edge/includes/iot-edge-create-release-pipeline-for-continuous-deployment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ Create a new pipeline, and add a new stage:
52
52
| Default platform | Select the appropriate operating system for your modules based on your targeted IoT Edge device. |
53
53
| Output path| Put the path `$(System.DefaultWorkingDirectory)/Drop/drop/configs/deployment.json`. This path is the final IoT Edge deployment manifest file. |
54
54
55
-
These configurations help replace the module image URLs in the `deployment.template.json` file. The **Generate deployment manifest** also helps replace the variables with the exact value you defined in the `deployment.template.json` file. In VS/VS Code, you are specifying the actual value in a `.env` file. In Azure Pipelines, you set the value in **Release Pipeline Variables** tab. Move to **Variables** tab and configure the name and value as following:
55
+
These configurations help replace the module image URLs in the `deployment.template.json` file. The **Generate deployment manifest** also helps replace the variables with the exact value you defined in the `deployment.template.json` file. In Visual Studio/Visual Studio Code, you are specifying the actual value in a `.env` file. In Azure Pipelines, you set the value in **Release Pipeline Variables** tab. Move to **Variables** tab and configure the name and value as following:
56
56
57
57
***ACR_ADDRESS**: Your Azure Container Registry **Login server** value. You can retrieve the Login server from the Overview page of your container registry in the Azure portal.
58
58
***ACR_PASSWORD**: Your Azure Container Registry password.
Copy file name to clipboardExpand all lines: articles/iot-edge/includes/iot-edge-register-device-x509.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ While there is no support for device registration with X.509 certificates throug
69
69
70
70
All the devices that connect to your IoT hub are listed in the **Azure IoT Hub** section of the Visual Studio Code Explorer. IoT Edge devices are distinguishable from non-Edge devices with a different icon, and the fact that the **$edgeAgent** and **$edgeHub** modules are deployed to each IoT Edge device.
71
71
72
-

72
+

Copy file name to clipboardExpand all lines: articles/iot-edge/tutorial-c-module.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,9 @@ Use the following table to understand your options for developing and deploying
41
41
42
42
| C | Visual Studio Code | Visual Studio |
43
43
| - | ------------------ | ------------- |
44
-
|**Linux AMD64**|||
45
-
|**Linux ARM32**|||
46
-
|**Linux ARM64**|||
44
+
|**Linux AMD64**|||
45
+
|**Linux ARM32**|||
46
+
|**Linux ARM64**|||
47
47
48
48
Before beginning this tutorial, you should have gone through the previous tutorial to set up your development environment for Linux container development: [Develop IoT Edge modules using Linux containers](tutorial-develop-for-linux.md). By completing that tutorial, you should have the following prerequisites in place:
49
49
@@ -67,15 +67,15 @@ The following steps create an IoT Edge module project for C by using Visual Stud
67
67
68
68
Create a C solution template that you can customize with your own code.
69
69
70
-
1. Select **View** > **Command Palette** to open the VS Code command palette.
70
+
1. Select **View** > **Command Palette** to open the Visual Studio Code command palette.
71
71
72
72
2. In the command palette, type and run the command **Azure: Sign in** and follow the instructions to sign in your Azure account. If you've already signed in, you can skip this step.
73
73
74
74
3. In the command palette, type and run the command **Azure IoT Edge: New IoT Edge solution**. Follow the prompts in the command palette to create your solution.
75
75
76
76
| Field | Value |
77
77
| ----- | ----- |
78
-
| Select folder | Choose the location on your development machine for VS Code to create the solution files. |
78
+
| Select folder | Choose the location on your development machine for Visual Studio Code to create the solution files. |
79
79
| Provide a solution name | Enter a descriptive name for your solution or accept the default **EdgeSolution**. |
80
80
| Select module template | Choose **C Module**. |
81
81
| Provide a module name | Name your module **CModule**. |
@@ -89,7 +89,7 @@ The environment file stores the credentials for your container registry and shar
89
89
90
90
The IoT Edge extension tries to pull your container registry credentials from Azure and populate them in the environment file. Check to see if your credentials are already included. If not, add them now:
91
91
92
-
1. In the VS Code explorer, open the .env file.
92
+
1. In the Visual Studio Code explorer, open the .env file.
93
93
2. Update the fields with the **username** and **password** values that you copied from your Azure container registry.
94
94
3. Save this file.
95
95
@@ -278,7 +278,7 @@ The default module code receives messages on an input queue and passes them alon
278
278
279
279
1. Save the main.c file.
280
280
281
-
1. In the VS Code explorer, open the **deployment.template.json** file in your IoT Edge solution workspace.
281
+
1. In the Visual Studio Code explorer, open the **deployment.template.json** file in your IoT Edge solution workspace.
282
282
283
283
1. Add the CModule module twin to the deployment manifest. Insert the following JSON content at the bottom of the `moduleContent` section, after the `$edgeHub` module twin:
284
284
@@ -298,7 +298,7 @@ The default module code receives messages on an input queue and passes them alon
298
298
299
299
In the previous section, you created an IoT Edge solution and added code to the CModule that will filter out messages where the reported machine temperature is within the acceptable limits. Now you need to build the solution as a container image and push it to your container registry.
300
300
301
-
1. Open the VS Code terminal by selecting **View** > **Terminal**.
301
+
1. Open the Visual Studio Code terminal by selecting **View** > **Terminal**.
302
302
303
303
2. Sign in to Docker by entering the following command in the terminal. Sign in with the username, password, and login server from your Azure container registry. You can retrieve these values from the **Access keys** section of your registry in the Azure portal.
304
304
@@ -308,7 +308,7 @@ In the previous section, you created an IoT Edge solution and added code to the
308
308
309
309
You may receive a security warning recommending the use of `--password-stdin`. While that best practice is recommended for production scenarios, it's outside the scope of this tutorial. For more information, see the [docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin) reference.
310
310
311
-
3. In the VS Code explorer, right-click the **deployment.template.json** file and select **Build and Push IoT Edge Solution**.
311
+
3. In the Visual Studio Code explorer, right-click the **deployment.template.json** file and select **Build and Push IoT Edge Solution**.
312
312
313
313
The build and push command starts three operations. First, it creates a new folder in the solution called **config** that holds the full deployment manifest, built out of information in the deployment template and other solution files. Second, it runs `docker build` to build the container image based on the appropriate dockerfile for your target architecture. Then, it runs `docker push` to push the image repository to your container registry.
0 commit comments