Skip to content

Commit 87a65db

Browse files
committed
Documentor passes
1 parent 6cd0a6f commit 87a65db

8 files changed

Lines changed: 109 additions & 109 deletions

articles/iot-edge/how-to-provision-single-device-linux-symmetric.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ms.custom:
1919

2020
This article provides end-to-end instructions for registering and provisioning a Linux IoT Edge device that includes installing IoT Edge.
2121

22-
Each device that connects to an [IoT hub](../iot-hub/index.yml) has a device ID that's used to track [cloud-to-device](../iot-hub/iot-hub-devguide-c2d-guidance.md) or [device-to-cloud](../iot-hub/iot-hub-devguide-d2c-guidance.md) communications. You configure a device with its connection information, which includes:
22+
Each device that connects to an [IoT hub](../iot-hub/index.yml) has a device ID that tracks [cloud-to-device](../iot-hub/iot-hub-devguide-c2d-guidance.md) or [device-to-cloud](../iot-hub/iot-hub-devguide-d2c-guidance.md) communications. You configure a device with its connection information, which includes:
2323

2424
* IoT hub hostname
2525
* Device ID
@@ -29,7 +29,7 @@ The steps in this article walk through a process called *manual provisioning*, w
2929

3030
* **Symmetric keys**: When you create a new device identity in IoT Hub, the service creates two keys. You place one of the keys on the device, and it presents the key to IoT Hub when authenticating.
3131

32-
This authentication method is faster to get started, but not as secure.
32+
This authentication method is faster to get started, but isn't as secure.
3333

3434
* **X.509 self-signed**: You create two X.509 identity certificates and place them on the device. When you create a new device identity in IoT Hub, you provide thumbprints from both certificates. When the device authenticates to IoT Hub, it presents one certificate and IoT Hub verifies that the certificate matches its thumbprint.
3535

@@ -46,7 +46,7 @@ This article covers using symmetric keys as your authentication method. If you w
4646
4747
## Prerequisites
4848

49-
This article shows how to register your IoT Edge device and install IoT Edge (also called IoT Edge runtime) on your device. Make sure you have the device management tool of your choice; for example Azure CLI, and review device requirements before you register and install your device.
49+
This article shows how to register your IoT Edge device and install IoT Edge (also called IoT Edge runtime) on your device. Make sure you have the device management tool of your choice, such as Azure CLI, and review device requirements before you register and install your device.
5050

5151
<!-- Device registration prerequisites H3 and content -->
5252
[!INCLUDE [iot-edge-prerequisites-register-device.md](includes/iot-edge-prerequisites-register-device.md)]
@@ -57,7 +57,7 @@ This article shows how to register your IoT Edge device and install IoT Edge (al
5757
<!-- Azure IoT extensions for Visual Studio Code-->
5858
### Visual Studio Code extensions
5959

60-
If you're using Visual Studio Code, there are helpful Azure IoT extensions that make the device creation and management process easier.
60+
If you're using Visual Studio Code, helpful Azure IoT extensions make the device creation and management process easier.
6161

6262
Install both the Azure IoT Edge and Azure IoT Hub extensions:
6363

@@ -74,11 +74,11 @@ Install both the Azure IoT Edge and Azure IoT Hub extensions:
7474

7575
## Provision the device with its cloud identity
7676

77-
Now that the container engine and the IoT Edge runtime are installed on your device, you're ready to set up the device with its cloud identity and authentication information.
77+
After you install the container engine and the IoT Edge runtime on your device, set up the device with its cloud identity and authentication information.
7878

7979
# [Ubuntu / Debian / RHEL](#tab/ubuntu+debian+rhel)
8080

81-
You can configure your IoT Edge device with symmetric key authentication using the following command:
81+
You can configure your IoT Edge device with symmetric key authentication by using the following command:
8282

8383
```bash
8484
sudo iotedge config mp --connection-string 'PASTE_DEVICE_CONNECTION_STRING_HERE'

articles/iot-edge/includes/iot-edge-install-linux.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Run the following commands to add the package repository and then add the Micros
1717
> [!IMPORTANT]
1818
> On June 30, 2022, Raspberry Pi OS Stretch was retired from the Tier 1 OS support list. To avoid potential security vulnerabilities, update your host OS to Bullseye.
1919
>
20-
> For [tier 2 supported platform operating systems](../support.md#tier-2), installation packages are made available at [Azure IoT Edge releases](https://github.com/Azure/azure-iotedge/releases). See the installation steps in [Offline or specific version installation (optional)](../how-to-provision-single-device-linux-symmetric.md#offline-or-specific-version-installation-optional).
20+
> For [tier 2 supported platform operating systems](../support.md#tier-2), installation packages are available at [Azure IoT Edge releases](https://github.com/Azure/azure-iotedge/releases). See the installation steps in [Offline or specific version installation (optional)](../how-to-provision-single-device-linux-symmetric.md#offline-or-specific-version-installation-optional).
2121
2222

2323
# [Ubuntu](#tab/ubuntu)
2424

25-
Installing can be done with a few commands. Open a terminal and run the following commands:
25+
You can install IoT Edge by using a few commands. Open a terminal and run the following commands:
2626

2727
* **24.04**:
2828

@@ -50,7 +50,7 @@ Installing can be done with a few commands. Open a terminal and run the followin
5050

5151
# [Debian](#tab/debian)
5252

53-
Installing with APT can be done with a few commands. Open a terminal and run the following commands:
53+
You can install it by using APT and running a few commands. Open a terminal and run the following commands:
5454

5555
* **12 - Bookworm (arm32v7)**:
5656

@@ -67,11 +67,11 @@ Installing with APT can be done with a few commands. Open a terminal and run the
6767
```
6868

6969
> [!TIP]
70-
> If you gave the "root" account a password during the OS install, you don't need `sudo`, and can run the previous command by starting with `apt`.
70+
> If you set a password for the "root" account during the OS installation, you don't need `sudo`. You can run the previous command by starting with `apt`.
7171
7272
# [Red Hat Enterprise Linux](#tab/rhel)
7373
74-
Installing can be done with a few commands. Open a terminal and run the following commands:
74+
You can install IoT Edge by using a few commands. Open a terminal and run the following commands:
7575
7676
* **9.x (amd64)**:
7777
@@ -91,7 +91,7 @@ Installing can be done with a few commands. Open a terminal and run the followin
9191
9292
# [Ubuntu Core snaps](#tab/snaps)
9393
94-
You install IoT Edge runtime from the snap store in a later step. Continue to the next section.
94+
You install the IoT Edge runtime from the snap store in a later step. Continue to the next section.
9595
9696
---
9797
@@ -102,7 +102,7 @@ For more information about operating system versions, see [Azure IoT Edge suppor
102102
103103
### Install a container engine
104104
105-
Azure IoT Edge relies on an [OCI](https://opencontainers.org/)-compatible container runtime. For production scenarios, we recommend that you use the Moby engine. The Moby engine is the container engine officially supported with IoT Edge. Docker CE/EE container images are compatible with the Moby runtime. If you're using Ubuntu Core snaps, the Docker snap is serviced by Canonical and supported for production scenarios.
105+
Azure IoT Edge relies on an [OCI](https://opencontainers.org/)-compatible container runtime. For production scenarios, use the Moby engine. The Moby engine is the container engine officially supported with IoT Edge. Docker CE and Docker EE container images work with the Moby runtime. If you're using Ubuntu Core snaps, Canonical services the Docker snap and supports it for production scenarios.
106106

107107
# [Ubuntu](#tab/ubuntu)
108108

@@ -139,11 +139,11 @@ Install the Moby engine and CLI.
139139
> ./check-config.sh
140140
> ```
141141
>
142-
> In the output of the script, check that all items under `Generally Necessary` and `Network Drivers` are enabled. If you're missing features, enable them by rebuilding your kernel from source and selecting the associated modules for inclusion in the appropriate kernel .config. Similarly, if you're using a kernel configuration generator like `defconfig` or `menuconfig`, find and enable the respective features and rebuild your kernel accordingly. After you deploy your newly modified kernel, run the check-config script again to verify that all the required features were successfully enabled.
142+
> In the output of the script, check that all items under `Generally Necessary` and `Network Drivers` are enabled. If you're missing features, enable them by rebuilding your kernel from source and selecting the associated modules for inclusion in the appropriate kernel .config. Similarly, if you're using a kernel configuration generator like `defconfig` or `menuconfig`, find and enable the respective features and rebuild your kernel accordingly. After you deploy your newly modified kernel, run the check-config script again to verify that all the required features are successfully enabled.
143143

144144
# [Ubuntu Core snaps](#tab/snaps)
145145

146-
IoT Edge has dependencies on Docker and IoT Identity Service. Install the dependencies using the following commands:
146+
IoT Edge has dependencies on Docker and IoT Identity Service. Install the dependencies by using the following commands:
147147

148148
```bash
149149
sudo snap install docker
@@ -182,7 +182,7 @@ The following steps show you how to configure your container to use the [`local`
182182
183183
# [Ubuntu Core snaps](#tab/snaps)
184184
185-
Currently, the `local` logging driver setting isn't supported for the Docker snap.
185+
Currently, the Docker snap doesn't support the `local` logging driver setting.
186186

187187
---
188188

@@ -241,7 +241,7 @@ sudo snap install azure-iot-edge
241241
242242
### Connect snaps
243243
244-
By default, snaps are dependency-free, untrusted, and strictly confined. Hence, snaps must be connected to other snaps and system resources after installation. Use the following commands to connect the IoT Identity Service and IoT Edge snaps to each other and to system resources. To get started, snaps need to be manually connected. For production deployments, they can be configured to automatically connect to reduce the provisioning workload.
244+
By default, snaps are dependency-free, untrusted, and strictly confined. Hence, you must connect snaps to other snaps and system resources after installation. Use the following commands to connect the IoT Identity Service and IoT Edge snaps to each other and to system resources. To get started, manually connect the snaps. For production deployments, you can configure them to automatically connect to reduce the provisioning workload.
245245
246246
```bash
247247
#------------------------

articles/iot-edge/includes/iot-edge-prerequisites-device-requirements-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ services: iot-edge
1010

1111
### Device requirements
1212

13-
An X64, ARM32, or ARM64 Linux device.
13+
An x64, ARM32, or ARM64 Linux device.
1414

1515
Microsoft publishes installation packages for various operating systems.
1616

articles/iot-edge/includes/iot-edge-register-device-symmetric.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ You can use the Azure portal, Visual Studio Code, or Azure CLI to register your
1414

1515
# [Portal](#tab/azure-portal)
1616

17-
In your IoT hub in the Azure portal, IoT Edge devices are created and managed separately from IoT devices that aren't edge enabled.
17+
In your IoT hub in the Azure portal, you create and manage IoT Edge devices separately from IoT devices that aren't edge enabled.
1818

19-
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your IoT hub.
19+
1. Sign in to the [Azure portal](https://portal.azure.com) and go to your IoT hub.
2020

21-
1. In the left pane, select **Devices** from the menu, then select **Add Device**.
21+
1. In the left pane, select **Devices** from the menu, and then select **Add Device**.
2222

23-
1. On the **Create a device** page, provide the following information:
23+
1. On **Create a device**, provide the following information:
2424

25-
* Create a descriptive Device ID, for example `my-edge-device-1` (all lowercase). Copy this Device ID, as you use it later.
26-
* Check the **IoT Edge Device** checkbox.
25+
* Create a descriptive Device ID, such as `my-edge-device-1` (all lowercase). Copy this Device ID, as you use it later.
26+
* Select the **IoT Edge Device** checkbox.
2727
* Select **Symmetric key** as the authentication type.
2828
* Use the default settings to autogenerate authentication keys, which connect the new device to your hub.
2929

@@ -35,9 +35,9 @@ You should see your new device listed in your IoT hub.
3535

3636
### Sign in to Azure
3737

38-
You can use the Azure IoT extensions for Visual Studio Code to perform operations with your IoT hub. Make sure you install the Azure IoT extension prerequisites.
38+
Use the Azure IoT extensions for Visual Studio Code to perform operations with your IoT hub. Make sure you install the Azure IoT extension prerequisites.
3939

40-
Once Azure IoT Edge and Azure IoT Hub extensions are installed, you notice an Azure icon gets added to the left icon menu. You can sign in to your Azure account through Visual Studio Code by selecting the Azure icon and then select **Sign in to Azure**.
40+
After you install the Azure IoT Edge and Azure IoT Hub extensions, you see an Azure icon in the left icon menu. Sign in to your Azure account through Visual Studio Code by selecting the Azure icon and then selecting **Sign in to Azure**.
4141

4242
### Register a new device with Visual Studio Code
4343

@@ -46,7 +46,7 @@ Registering a new device is similar to creating an IoT Edge device in the Azure
4646
1. In the Visual Studio Code Explorer menu, expand the **Azure IoT Hub** section.
4747
1. Select the **...** ellipsis in the **Azure IoT Hub** section header. If you don't see the ellipsis, select or hover over the header.
4848
1. Select **Create IoT Edge Device**.
49-
1. In the text box that opens, give your device an ID; for example, `my-edge-device-1` (all lowercase), then press **Enter**.
49+
1. In the text box that opens, give your device an ID, such as `my-edge-device-1` (all lowercase), and press **Enter**.
5050

5151
In the output console of Visual Studio Code, you see the result of the command: a JSON printout. The device information includes the **deviceId** that you provided and generates a **connectionString** value that you can use to connect your physical device to your IoT hub. The output console also shows your keys and other device identifying information.
5252

@@ -57,7 +57,7 @@ You can now see your device listed under the **Azure IoT Hub > Devices** section
5757
5858
# [Azure CLI](#tab/azure-cli)
5959

60-
Use the [`az iot hub device-identity create`](/cli/azure/iot/hub/device-identity) command to create a new device identity in your IoT hub. Replace `device_id_here` with your own new and unique device ID; for example, `my-edge-device-1` (all lowercase). Replace `hub_name_here` with your existing IoT hub.
60+
Use the [`az iot hub device-identity create`](/cli/azure/iot/hub/device-identity) command to create a new device identity in your IoT hub. Replace `device_id_here` with your own new and unique device ID, such as `my-edge-device-1` (all lowercase). Replace `hub_name_here` with your existing IoT hub.
6161

6262
This command includes three parameters:
6363

@@ -86,11 +86,11 @@ The edge-enabled devices that connect to your IoT hub are listed on the **Device
8686
When you're ready to set up your device, you need the connection string that links your physical device with its identity in the IoT hub. Devices that authenticate with symmetric keys have their connection strings available to copy in the portal. To find your connection string in the portal, perform the following steps:
8787

8888
1. From the **Devices** page, select the IoT Edge device ID from the list.
89-
2. Copy the value of either **Primary Connection String** or **Secondary Connection String**. Either key works.
89+
1. Copy the value of either **Primary Connection String** or **Secondary Connection String**. Either key works.
9090

9191
# [Visual Studio Code](#tab/visual-studio-code)
9292

93-
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 because they have a different icon, and you can see that the **$edgeAgent** and **$edgeHub** modules are deployed to each IoT Edge device.
93+
The **Azure IoT Hub** section of the Visual Studio Code Explorer lists all the devices that connect to your IoT hub. IoT Edge devices have a different icon, so you can easily distinguish them from non-edge devices. You can see that the **$edgeAgent** and **$edgeHub** modules are deployed to each IoT Edge device.
9494

9595
When you're ready to set up your device, you need the connection string that links your physical device with its identity in the IoT hub. Here's how to get your connection string from Visual Studio Code:
9696

@@ -107,7 +107,7 @@ To see all devices in your IoT hub, use the [`az iot hub device-identity list`](
107107
az iot hub device-identity list --hub-name hub_name_here
108108
```
109109

110-
Any device that is registered as an IoT Edge device has the property **capabilities.iotEdge** set to **true**. You can see a lot of other metadata as JSON output as well, including your device IDs.
110+
Any device that you register as an IoT Edge device has the property **capabilities.iotEdge** set to **true**. You can see a lot of other metadata as JSON output as well, including your device IDs.
111111

112112
When you're ready to set up your device, you need its connection string that links your physical device with its identity in the IoT hub. Use the following [`az iot hub device-identity connection-string show`](/cli/azure/iot/hub/device-identity/connection-string) command to return the connection string for a single device. Replace `[device_id]` and `[hub_name]` with your own values. The value for the `device-identity` parameter is case-sensitive.
113113

@@ -126,6 +126,6 @@ You should see JSON output in the console, similar to the following example:
126126
>[!TIP]
127127
>The `connection-string show` command was introduced in version 0.9.8 of the Azure IoT extension, replacing the deprecated `show-connection-string` command. If you get an error running this command, make sure your extension version is updated to 0.9.8 or later. For more information and the latest updates, see [Microsoft Azure IoT extension for Azure CLI](https://github.com/Azure/azure-iot-cli-extension).
128128
129-
When copying the connection string to use on a device, don't include the quotation marks around the connection string.
129+
When you copy the connection string to use on a device, don't include the quotation marks around the connection string.
130130

131131
---

articles/iot-edge/iot-edge-as-gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ All gateway patterns provide the following benefits:
3535

3636
## Transparent gateways
3737

38-
In the transparent gateway pattern, devices that theoretically can connect to IoT Hub can connect to a gateway device instead. These devices, called *downstream devices* or *child devices*, have their own IoT Hub identities and connect by using either MQTT or AMQP protocols. The gateway simply passes communications between the devices and IoT Hub. Both the devices and the users interacting with them through IoT Hub are unaware that a gateway is mediating their communications. This lack of awareness means the gateway is considered *transparent*.
38+
In the transparent gateway pattern, devices that can connect to IoT Hub can connect to a gateway device instead. These devices, called *downstream devices* or *child devices*, have their own IoT Hub identities and connect by using either MQTT or AMQP protocols. The gateway simply passes communications between the devices and IoT Hub. Both the devices and the users interacting with them through IoT Hub are unaware that a gateway is mediating their communications. This lack of awareness means the gateway is considered *transparent*.
3939

4040
For more information about how the IoT Edge hub manages communication between downstream devices and the cloud, see the [Azure IoT Edge runtime and architecture overview](iot-edge-runtime.md).
4141

0 commit comments

Comments
 (0)