Skip to content

Commit bc9b0d5

Browse files
committed
Freshness review
1 parent 3f4b1a5 commit bc9b0d5

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/iot-edge/how-to-authenticate-downstream-device.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ services: iot-edge
1414

1515
[!INCLUDE [iot-edge-version-all-supported](includes/iot-edge-version-all-supported.md)]
1616

17-
In a transparent gateway scenario, downstream devices, sometimes called child devices, need identities in IoT Hub like any other device. This article explains the options for authenticating a downstream device to IoT Hub, and shows how to declare the gateway connection.
17+
In a transparent gateway scenario, downstream devices, sometimes called child devices, need identities in IoT Hub like any other device. This article explains the options for authenticating a downstream device to IoT Hub and shows how to declare the gateway connection.
1818

1919
>[!NOTE]
2020
>A downstream device sends data directly to the internet or to gateway devices, whether they're IoT Edge-enabled or not. A child device can be a downstream device or a gateway device in a nested topology.
@@ -27,15 +27,15 @@ There are three general steps to set up a successful transparent gateway connect
2727

2828
Downstream devices can authenticate with IoT Hub using one of three methods: symmetric keys (sometimes called shared access keys), X.509 self-signed certificates, or X.509 certificate authority (CA) signed certificates. The authentication steps are similar to those for setting up any non-IoT Edge device with IoT Hub, with small differences to declare the gateway relationship.
2929

30-
Automatic provisioning of downstream devices with the Azure IoT Hub Device Provisioning Service (DPS) isn't supported.
30+
Automatic provisioning of downstream devices with Azure IoT Hub Device Provisioning Service (DPS) isn't supported.
3131

3232
## Prerequisites
3333

3434
Finish the steps in [Configure an IoT Edge device to act as a transparent gateway](how-to-create-transparent-gateway.md).
3535

36-
If you're using X.509 authentication, you generate certificates for your downstream device. Make sure you have the same root CA certificate and the certificate generating script you used for the transparent gateway article available to use again.
36+
If you're using X.509 authentication, generate certificates for your downstream device. Make sure you have the same root CA certificate and the certificate generating script you used in the transparent gateway article.
3737

38-
This article refers to the *gateway hostname* at several points. The gateway hostname is set in the **hostname** parameter of the config file on the IoT Edge gateway device. It's also used in the connection string of the downstream device. The gateway hostname must resolve to an IP address, either by using DNS or a host file entry on the downstream device.
38+
This article refers to the *gateway hostname* at several points. The gateway hostname is set in the **hostname** parameter of the config file on the IoT Edge gateway device. It's also used in the connection string of the downstream device. The gateway hostname must resolve to an IP address by using DNS or a host file entry on the downstream device.
3939

4040
## Register device with IoT Hub
4141

@@ -65,7 +65,7 @@ When you create the new device identity, provide the following information:
6565

6666
* Select **Symmetric key** as the authentication type.
6767

68-
* Select **Set a parent device** and select the IoT Edge gateway device that this downstream device will connect through. You can always change the parent later.
68+
* Select **Set a parent device** and select the IoT Edge gateway device that this downstream device connects through. You can always change the parent later.
6969

7070
:::image type="content" source="./media/how-to-authenticate-downstream-device/symmetric-key-portal.png" alt-text="Screenshot of how to create a device ID with symmetric key authorization in the Azure portal.":::
7171

@@ -116,7 +116,7 @@ For X.509 self-signed authentication, sometimes referred to as thumbprint authen
116116
* Provide the **Device ID** that matches the subject name of your device certificates.
117117
* Select **X.509 Self-Signed** as the authentication type.
118118
* Paste the hexadecimal strings that you copied from your device's primary and secondary certificates.
119-
* Select **Set a parent device** and choose the IoT Edge gateway device that this downstream device will connect through. You can always change the parent later.
119+
* Select **Set a parent device** and choose the IoT Edge gateway device that this downstream device connects through. You can always change the parent later.
120120
121121
:::image type="content" source="./media/how-to-authenticate-downstream-device/x509-self-signed-portal.png" alt-text="Screenshot that shows how to create a device ID with an X.509 self-signed authorization in the Azure portal.":::
122122
@@ -166,18 +166,18 @@ To set up X.509 CA-signed authentication for a downstream device, follow these s
166166

167167
## Retrieve and modify connection string
168168

169-
After you create an IoT device identity in the portal, retrieve its primary or secondary key. Include one of these keys in the connection string that applications use to communicate with IoT Hub. For symmetric key authentication, IoT Hub shows the complete connection string in the device details. Add information about the gateway device to the connection string.
169+
After you create an IoT device identity in the portal, get its primary or secondary key. Add one of these keys to the connection string that applications use to talk to IoT Hub. For symmetric key authentication, IoT Hub shows the complete connection string in the device details. Add the gateway device information to the connection string.
170170

171-
A connection string for a downstream device needs these components:
171+
A connection string for a downstream device needs these parts:
172172

173173
* The IoT Hub the device connects to: `Hostname=<Iot-Hub-Name>.azure-devices.net`
174174
* The device ID registered with the hub: `DeviceID=<Device-ID>`
175-
* The authentication method, either symmetric key or X.509 certificate
175+
* The authentication method, either symmetric key or X.509 certificate.
176176
* For symmetric key authentication, enter either the primary or secondary key: `SharedAccessKey=<Key>`
177177
* For X.509 certificate authentication, provide a flag: `x509=true`
178-
* The gateway device the device connects through. Enter the **hostname** value from the IoT Edge gateway device's config file: `GatewayHostName={gateway hostname}`
178+
* The gateway device the device connects through. Enter the **hostname** value from the IoT Edge gateway device's config file: `GatewayHostName=<Gateway-Hostname>`
179179

180-
A complete connection string looks like this:
180+
A complete connection string looks like this example:
181181

182182
```console
183183
HostName=myiothub.azure-devices.net;DeviceId=myDownstreamDevice;SharedAccessKey=xxxyyyzzz;GatewayHostName=myGatewayDevice
@@ -189,7 +189,7 @@ Or, for X.509 certificate authentication:
189189
HostName=myiothub.azure-devices.net;DeviceId=myDownstreamDevice;x509=true;GatewayHostName=myGatewayDevice
190190
```
191191

192-
Because of the parent and child relationship, simplify the connection string by using the gateway directly as the connection host. For example:
192+
Because of the parent and child relationship, you can simplify the connection string by using the gateway directly as the connection host. For example:
193193

194194
```console
195195
HostName=myGatewayDevice;DeviceId=myDownstreamDevice;SharedAccessKey=xxxyyyzzz
@@ -201,4 +201,4 @@ Use this modified connection string in the next article in the transparent gatew
201201

202202
At this point, you have an IoT Edge device registered with your IoT Hub and set it up as a transparent gateway. You also have a downstream device registered with your IoT Hub and pointing to its gateway device.
203203

204-
Next, set up your downstream device to trust the gateway device and connect to it securely. Continue to the next article in the transparent gateway series: [Connect a downstream device to an Azure IoT Edge gateway](how-to-connect-downstream-device.md).
204+
Next, set up your downstream device to trust the gateway device and connect to it securely. Continue with the next article in the transparent gateway series: [Connect a downstream device to an Azure IoT Edge gateway](how-to-connect-downstream-device.md).

0 commit comments

Comments
 (0)