Skip to content

Commit 6a796b8

Browse files
authored
Merge pull request #96038 from Ja-Dunn/three-iot-central-articles
edit pass: three-iot-central-articles
2 parents d34914a + 60c037f commit 6a796b8

File tree

3 files changed

+333
-342
lines changed

3 files changed

+333
-342
lines changed
Lines changed: 78 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Add an Azure IoT Edge device to Azure IoT Central | Microsoft Docs
3-
description: As an operator, add an Azure IoT Edge device to your Azure IoT Central
3+
description: As an operator, add an Azure IoT Edge device to your Azure IoT Central application
44
author: rangv
55
ms.author: rangv
66
ms.date: 10/22/2019
@@ -11,181 +11,171 @@ ms.custom: mvc
1111
manager: peterpr
1212
---
1313

14-
# Tutorial: Add an Azure IoT Edge device to your Azure IoT Central application (preview features)
14+
# Tutorial: Add an Azure IoT Edge device to your Azure IoT Central application
1515

1616
[!INCLUDE [iot-central-pnp-original](../../../includes/iot-central-pnp-original-note.md)]
1717

18-
This tutorial shows you how to add and configure a *Azure IoI Edge device* to your Microsoft Azure IoT Central application. In this tutorial, we chose an Azure IoT Edge enabled Linux VM from Azure Marketplace.
18+
This tutorial shows you how to add and configure an Azure IoT Edge device to your Azure IoT Central application. In this tutorial, we chose an IoT Edge-enabled Linux VM from Azure Marketplace.
1919

2020
This tutorial is made up of two parts:
2121

22-
* First, as an operator, you learn how to do cloud first provisioning of an Azure IoT Edge device.
23-
* Then, you will learn how to do device first provisioning of an Azure IoT Edge device.
22+
* First, as an operator, you learn how to do cloud first provisioning of an IoT Edge device.
23+
* Then, you learn how to do "device first" provisioning of an IoT Edge device.
2424

2525
In this tutorial, you learn how to:
2626

2727
> [!div class="checklist"]
28-
> * Add a new Azure IoT Edge device
29-
> * Configure the Azure IoT Edge device to help provision using SAS Key
30-
> * View Dashboards, Module Health in IoT Central
31-
> * Send commands to a module running on the Azure IoT Edge device
32-
> * Set properties on a module running on the Azure IoT Edge device
28+
> * Add a new IoT Edge device
29+
> * Configure the IoT Edge device to help provision by using a shared access signature (SAS) key
30+
> * View dashboards and module health in IoT Central
31+
> * Send commands to a module running on the IoT Edge device
32+
> * Set properties on a module running on the IoT Edge device
3333
3434
## Prerequisites
3535

36-
To complete this tutorial, you need an Azure IoT Central application. Follow this quickstart to [Create an Azure IoT Central application](./quick-deploy-iot-central.md).
36+
To complete this tutorial, you need an Azure IoT Central application. Follow [this quickstart to create an Azure IoT Central application](./quick-deploy-iot-central.md).
3737

38-
## Enable Azure IoT Edge Enrollment Group
39-
Enable SAS keys for Azure IoT Edge enrollment group from the Administration page.
38+
## Enable Azure IoT Edge enrollment group
39+
From the **Administration** page, enable SAS keys for Azure IoT Edge enrollment group.
4040

41-
![Device Template - Azure IoT Edge](./media/tutorial-add-edge-as-leaf-device/groupenrollment.png)
41+
![Screenshot of Administration page, with Device connection highlighted](./media/tutorial-add-edge-as-leaf-device/groupenrollment.png)
4242

43-
## Cloud first Azure IoT Edge device provisioning
44-
In this section, you will create a new Azure IoT Edge device using the **environment sensor template** and provision a device.
45-
Click on Devices on the left navigation and click on Environment Sensor Template.
43+
## Provision a "cloud first" Azure IoT Edge device
44+
In this section, you create a new IoT Edge device by using the environment sensor template, and you provision a device.
45+
Select **Devices** > **Environment Sensor Template**.
4646

47-
![Device Template - Azure IoT Edge](./media/tutorial-add-edge-as-leaf-device/deviceexplorer.png)
47+
![Screenshot of Devices page, with Environment Sensor Template highlighted](./media/tutorial-add-edge-as-leaf-device/deviceexplorer.png)
4848

49-
Click **+ New** and enter a device ID and name, which suits you.
49+
Select **+ New**, and enter a device ID and name of your choosing. Select **Create**.
5050

51-
![Device Template - Azure IoT Edge](./media/tutorial-add-edge-as-leaf-device/cfdevicecredentials.png)
51+
![Screenshot of Create new device dialog box, with Device ID and Create highlighted](./media/tutorial-add-edge-as-leaf-device/cfdevicecredentials.png)
5252

53-
Device goes into **Registered** mode.
53+
The device goes into **Registered** mode.
5454

55-
![Device Template - Azure IoT Edge](./media/tutorial-add-edge-as-leaf-device/cfregistered.png)
55+
![Screenshot of Environment Sensor Template page, with Device status highlighted](./media/tutorial-add-edge-as-leaf-device/cfregistered.png)
5656

57-
## Deploy an Azure IoT Edge enabled Linux VM
57+
## Deploy an IoT Edge enabled Linux VM
5858

59-
>Note: You can choose to use any machine or device. OS: Linux or Windows)
59+
> [!NOTE]
60+
> You can choose to use any machine or device. The operating system can be Linux or Windows.
6061
61-
For this tutorial, we chose an Azure IoT enabled Linux VM, which can be create on Azure. You will be taken to [Azure marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/microsoft_iot_edge.iot_edge_vm_ubuntu?tab=Overview)
62-
and click on **Get IT NOW** button.
62+
For this tutorial, we're using an Azure IoT enabled Linux VM, created on Azure. In [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/microsoft_iot_edge.iot_edge_vm_ubuntu?tab=Overview), select **GET IT NOW**.
6363

64-
![Azure Marketplace](./media/tutorial-add-edge-as-leaf-device/cfmarketplace.png)
64+
![Screenshot of Azure Marketplace, with GET IT NOW highlighted](./media/tutorial-add-edge-as-leaf-device/cfmarketplace.png)
6565

66-
Click **Continue**
66+
Select **Continue**.
6767

68-
![Azure Marketplace](./media/tutorial-add-edge-as-leaf-device/cfmarketplacecontinue.png)
68+
![Screenshot of Create this app in Azure dialog box, with Continue highlighted](./media/tutorial-add-edge-as-leaf-device/cfmarketplacecontinue.png)
6969

7070

71-
You will be taken to Azure portal. Click **Create** button
71+
You're taken to the Azure portal. Select **Create**.
7272

73-
![Azure Marketplace](./media/tutorial-add-edge-as-leaf-device/cfubuntu.png)
73+
![Screenshot of the Azure portal, with Create highlighted](./media/tutorial-add-edge-as-leaf-device/cfubuntu.png)
7474

75-
Select Subscription, create a new resource group preferably, Select US West 2 for VM availability, enter User and password. Remember User, password will be required for future steps. Click **Review + Create**
75+
Select **Subscription**, create a new resource group, and select **(US) West US 2** for VM availability. Then, enter user and password information. These will be required for future steps, so remember them. Select **Review + create**.
7676

77-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfvm.png)
77+
![Screenshot of Create a virtual machine details page, with various options highlighted](./media/tutorial-add-edge-as-leaf-device/cfvm.png)
7878

79-
Once validated click **Create**
79+
After validation, select **Create**.
8080

81-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfvmvalidated.png)
81+
![Screenshot of Create a virtual machine page, with Validation passed and Create highlighted](./media/tutorial-add-edge-as-leaf-device/cfvmvalidated.png)
8282

83-
Takes a few minutes to create the resources. Click on Go to **Resource**
83+
It takes a few minutes to create the resources. Select **Go to resource**.
8484

85-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfvmdeploymentcomplete.png)
85+
![Screenshot of deployment completion page, with Go to resource highlighted](./media/tutorial-add-edge-as-leaf-device/cfvmdeploymentcomplete.png)
8686

87-
### Provision VM as Azure IoT Edge device
87+
### Provision VM as an IoT Edge device
8888

89-
Under Support + troubleshooting in the left navigation, click on Serial console
89+
Under **Support + troubleshooting**, select **Serial console**.
9090

91-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfserialconsole.png)
91+
![Screenshot of Support + troubleshooting options, with Serial console highlighted](./media/tutorial-add-edge-as-leaf-device/cfserialconsole.png)
9292

93-
You will see a screen like below
93+
You'll see a screen similar to the following:
9494

95-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsole.png)
95+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsole.png)
9696

97-
Press enter and provide Username and password as prompted and press enter.
97+
Press Enter, provide the user name and password as prompted, and then press Enter again.
9898

99-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsolelogin.png)
99+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsolelogin.png)
100100

101-
To run a command as administrator/root run the command: **sudo su –**
101+
To run a command as administrator (user "root"), enter: **sudo su –**
102102

103-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfsudo.png)
103+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfsudo.png)
104104

105-
Check Azure IoT Edge runtime version. Current GA version is 1.0.8
105+
Check the IoT Edge runtime version. At the time of this writing, the current GA version is 1.0.8.
106106

107-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsoleversion.png)
107+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsoleversion.png)
108108

109-
Install vim editor or use nano if it’s your preference.
109+
Install the vim editor, or use nano if you prefer.
110110

111-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsolevim.png)
111+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsolevim.png)
112112

113-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfvim.png)
113+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfvim.png)
114114

115-
Edit Azure IoT Edge config.yaml file
115+
Edit the IoT Edge config.yaml file.
116116

117-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsoleconfig.png)
117+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsoleconfig.png)
118118

119-
Scroll down and comment out connection string portion of the yaml file.
119+
Scroll down, and comment out the connection string portion of the yaml file.
120120

121121
**Before**
122122

123-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfmanualprovisioning.png)
123+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfmanualprovisioning.png)
124124

125-
**After** (Press Esc and Press lower case a, to start editing)
125+
**After** (Press Esc, and press lowercase a, to start editing.)
126126

127-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfmanualprovisioningcomments.png)
127+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfmanualprovisioningcomments.png)
128128

129-
Uncomment Symmetric key portion of the yaml file.
129+
Uncomment the symmetric key portion of the yaml file.
130130

131131
**Before**
132132

133-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsolesymmcomments.png)
133+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsolesymmcomments.png)
134134

135135
**After**
136136

137-
![Ubuntu VM](./media/tutorial-add-edge-as-leaf-device/cfconsolesymmuncomments.png)
137+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsolesymmuncomments.png)
138138

139-
Go to IoT Central and get scope ID, device ID and symmetric key of the Azure IoT Edge device
140-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/cfdeviceconnect.png)
139+
Go to IoT Central. Get the scope ID, device ID, and symmetric key of the IoT Edge device.
140+
![Screenshot of IoT Central, with various device connection options highlighted](./media/tutorial-add-edge-as-leaf-device/cfdeviceconnect.png)
141141

142-
Go To the Linux box and replace Scope ID, Registration ID with device ID and symmetric key
142+
Go to the Linux computer, and replace the scope ID and registration ID with the device ID and symmetric key.
143143

144-
Press **Esc** and type **:wq!** and press **enter** to save your changes
144+
Press Esc, and type **:wq!**. Press Enter to save your changes.
145145

146-
Restart Azure IoT Edge to process your changes and press **Enter**
146+
Restart IoT Edge to process your changes, and press Enter.
147147

148-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/cfrestart.png)
148+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfrestart.png)
149149

150-
Type: **iotedge list**, it will take few minutes, you will see three modules deployed
150+
Type **iotedge list**. After a few minutes, you'll see three modules deployed.
151151

152-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/cfconsolemodulelist.png)
152+
![Screenshot of console](./media/tutorial-add-edge-as-leaf-device/cfconsolemodulelist.png)
153153

154154

155155
## IoT Central device explorer
156156

157-
In IoT Central your device will move into provisioned state
157+
In IoT Central, your device moves into provisioned state.
158158

159-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/cfprovisioned.png)
159+
![Screenshot of IoT Central Devices options, with Device status highlighted](./media/tutorial-add-edge-as-leaf-device/cfprovisioned.png)
160160

161-
Modules tab will show the status of the device and module on IoT Central
161+
The **Modules** tab shows the status of the device and module on IoT Central.
162162

163-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/cfiotcmodulestatus.png)
163+
![Screenshot of IoT Central Modules tab](./media/tutorial-add-edge-as-leaf-device/cfiotcmodulestatus.png)
164164

165165

166-
Cloud properties will show up in a Form (from the device template you created in the previous steps). Enter values and click **Save**.
166+
You'll see cloud properties in a form, from the device template you created in the previous steps. Enter values, and select **Save**.
167167

168-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/deviceinfo.png)
168+
![Screenshot of My Linux Edge Device form](./media/tutorial-add-edge-as-leaf-device/deviceinfo.png)
169169

170-
Dashboard tile
170+
Here's a view presented in the form of a dashboard tile.
171171

172-
![Device Connect](./media/tutorial-add-edge-as-leaf-device/dashboard.png)
173-
174-
In this tutorial, you learned how to:
175-
176-
* Add a new Azure IoT Edge device
177-
* Configure the Azure IoT Edge device to help provision using SAS Key
178-
* View Dashboards, Module Health in IoT Central
179-
* Send commands to a module running on the Azure IoT Edge device
180-
* Set properties on a module running on the Azure IoT Edge device
172+
![Screenshot of My Linux Edge Device dashboard tiles](./media/tutorial-add-edge-as-leaf-device/dashboard.png)
181173

182174
## Next steps
183175

184-
Now that you've learned how to work with manage Azure IoT Edge devices in IoT Central, here is the suggested next step:
176+
Now that you've learned how to work with and manage IoT Edge devices in IoT Central, here's the suggested next step:
185177

186178
<!-- Next how-tos in the sequence -->
187179

188-
How To Configure a transparent gateway, follow this tutorial
189-
190180
> [!div class="nextstepaction"]
191-
> [Configure Transparent Gateway](../../iot-edge/how-to-create-transparent-gateway.md)
181+
> [Configure transparent gateway](../../iot-edge/how-to-create-transparent-gateway.md)

0 commit comments

Comments
 (0)