Skip to content

Commit 3f94488

Browse files
committed
Review and acrolinx
1 parent 26d33b7 commit 3f94488

File tree

7 files changed

+44
-45
lines changed

7 files changed

+44
-45
lines changed

articles/iot-dps/how-to-manage-enrollments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Manage device enrollments in the Azure portal
33
titleSuffix: Azure IoT Hub Device Provisioning Service
4-
description: How to manage group and individual device enrollments for your Device Provisioning Service (DPS) in the Azure portal
4+
description: How to manage group and individual device enrollments for your Device Provisioning Service (DPS) in the Azure portal.
55
author: kgremban
66
ms.author: kgremban
77
ms.date: 03/09/2023

articles/iot-dps/how-to-provision-multitenant.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,15 @@ For simplicity, this tutorial uses [Symmetric key attestation](concepts-symmetri
105105
106106
1. On the **Review + create** tab, verify all of your values then select **Create**.
107107
108-
1. Once your enrollment group is creted, select its name *contoso-us-devices* from the enrollment groups list.
108+
1. Once your enrollment group is created, select its name *contoso-us-devices* from the enrollment groups list.
109109
110110
1. Copy the *Primary key*. This key will be used later to generate unique device keys for both simulated devices.
111111
112112
## Create regional Linux VMs
113113
114-
In this section, you'll create two regional Linux virtual machines (VMs). These VMs will run a device simulation sample from each region to demonstrate device provisioning for devices from both regions.
114+
In this section, you create two regional Linux virtual machines (VMs), one in **West US 2** and one in **East US 2**. These VMs run a device simulation sample from each region to demonstrate device provisioning for devices from both regions.
115115
116-
To make clean-up easier, these VMs will be added to the same resource group that contains the IoT hubs that were created, *contoso-us-resource-group*. However, the VMs will run in separate regions (**West US 2** and **East US**).
116+
To make clean-up easier, add these VMs to the same resource group that contains the IoT hubs that were created, *contoso-us-resource-group*.
117117
118118
1. In the Azure Cloud Shell, run the following command to create an **East US** region VM after making the following parameter changes in the command:
119119
@@ -135,7 +135,7 @@ To make clean-up easier, these VMs will be added to the same resource group that
135135
--public-ip-sku Standard
136136
```
137137
138-
This command will take a few minutes to complete.
138+
This command will take a few minutes to complete.
139139
140140
2. Once the command has completed, copy the **publicIpAddress** value for your East US region VM.
141141

articles/iot-dps/how-to-roll-certificates.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,13 @@ If you are rolling certificates to handle certificate expirations, you should us
9898

9999
:::image type="content" source="./media/how-to-roll-certificates/manage-certificates.png" alt-text="Screenshot that shows the certificates page.":::
100100

101-
1. Select the compromised or expired certificate from the list, and then select **Delete**. Confirm the delete by entering the certificate name and click **OK**.
101+
1. Select the compromised or expired certificate from the list, and then select **Delete**. Confirm the delete by entering the certificate name and select **OK**.
102102

103103
1. Follow steps outlined in [Configure verified CA certificates](how-to-verify-certificates.md) to add and verify new root CA certificates.
104104

105105
1. Select **Manage enrollments** from the **Settings** section of the navigation menu for your Device Provisioning Service instance, and select the **Enrollment groups** tab.
106106

107-
1. Click your enrollment group name from the list.
107+
1. Select your enrollment group name from the list.
108108

109109
1. In the **X.509 certificate settings** section, and select your new root CA certificate to either replace the compromised or expired certificate, or to add as a secondary certificate.
110110

@@ -122,7 +122,7 @@ If you are rolling certificates to handle certificate expirations, you should us
122122

123123
1. Select **Manage enrollments** from the **Settings** section of the navigation menu for your Device Provisioning Service instance, and select the **Enrollment groups** tab.
124124

125-
1. Select the group name grom the list.
125+
1. Select the group name from the list.
126126

127127
1. Check the **Remove or replace primary/secondary certificate** checkboxes if you want to delete an existing certificate. Select the file folder icon to browse for and upload the new certificates.
128128

@@ -146,9 +146,9 @@ Once the certificate is rolled on both the device and the Device Provisioning Se
146146

147147
One easy way of programming devices to reprovision is to program the device to contact the provisioning service to go through the provisioning flow if the device receives an “unauthorized” error from attempting to connect to the IoT hub.
148148

149-
Another way is for both the old and the new certificates to be valid for a short overlap, and use the IoT hub to send a command to devices to have them re-register via the provisioning service to update their IoT Hub connection information. Because each device can process commands differently, you will have to program your device to know what to do when the command is invoked. There are several ways you can command your device via IoT Hub, and we recommend using [direct methods](../iot-hub/iot-hub-devguide-direct-methods.md) or [jobs](../iot-hub/iot-hub-devguide-jobs.md) to initiate the process.
149+
Another way is for both the old and the new certificates to be valid for a short overlap, and use the IoT hub to send a command to devices to have them re-register via the provisioning service to update their IoT Hub connection information. Because each device can process commands differently, you have to program your device to know what to do when the command is invoked. There are several ways you can command your device via IoT Hub, and we recommend using [direct methods](../iot-hub/iot-hub-devguide-direct-methods.md) or [jobs](../iot-hub/iot-hub-devguide-jobs.md) to initiate the process.
150150

151-
Once reprovisioning is complete, devices will be able to connect to IoT Hub using their new certificates.
151+
Once reprovisioning is complete, devices are able to connect to IoT Hub using their new certificates.
152152

153153
## Disallow certificates
154154

articles/iot-dps/quick-create-simulated-device-x509.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ In this section, you'll prepare a development environment that's used to build t
120120
121121
6. The code sample uses an X.509 certificate to provide attestation via X.509 authentication. Run the following command to build a version of the SDK specific to your development platform that includes the device provisioning client. A Visual Studio solution for the simulated device is generated in the `cmake` directory.
122122
123-
When specifying the path used with `-Dhsm_custom_lib` in the command below, make sure to use the absolute path to the library in the `cmake` directory you previously created. The path shown below assumes that you cloned the C SDK in the root directory of the C drive. If you used another directory, adjust the path accordingly.
123+
When specifying the path used with `-Dhsm_custom_lib` in the following command, make sure to use the absolute path to the library in the `cmake` directory you previously created. The path shown assumes that you cloned the C SDK in the root directory of the C drive. If you used another directory, adjust the path accordingly.
124124
125125
```cmd
126126
cmake -Duse_prov_client:BOOL=ON -Dhsm_custom_lib=c:/azure-iot-sdk-c/cmake/provisioning_client/samples/custom_hsm_example/Debug/custom_hsm_example.lib ..
@@ -377,7 +377,7 @@ You won't need the Git Bash prompt for the rest of this quickstart. However, you
377377
378378
7. When asked to **Enter pass phrase for device-key.pem:**, use the same pass phrase you did previously, `1234`.
379379
380-
8. Copy the device certificate and unencrytped private key to the project directory for the X.509 device provisioning sample. The path given is relative to the location where you downloaded the SDK.
380+
8. Copy the device certificate and unencrypted private key to the project directory for the X.509 device provisioning sample. The path given is relative to the location where you downloaded the SDK.
381381
382382
```bash
383383
cp device-cert.pem ./azure-iot-sdk-node/provisioning/device/samples
@@ -438,11 +438,11 @@ This article demonstrates an individual enrollment for a single device to be pro
438438
439439
## Prepare and run the device provisioning code
440440
441-
In this section, you'll update the sample code to send the device's boot sequence to your Device Provisioning Service instance. This boot sequence will cause the device to be recognized and assigned to an IoT hub linked to the DPS instance.
441+
In this section, you update the sample code to send the device's boot sequence to your Device Provisioning Service instance. This boot sequence causes the device to be recognized and assigned to an IoT hub linked to the DPS instance.
442442

443443
::: zone pivot="programming-language-ansi-c"
444444

445-
In this section, you'll use your Git Bash prompt and the Visual Studio IDE.
445+
In this section, you use your Git Bash prompt and the Visual Studio IDE.
446446

447447
### Configure the provisioning device code
448448

@@ -464,7 +464,7 @@ In this section, you update the sample code with your Device Provisioning Servic
464464
static const char* id_scope = "0ne00000A0A";
465465
```
466466

467-
1. Find the definition for the `main()` function in the same file. Make sure the `hsm_type` variable is set to `SECURE_DEVICE_TYPE_X509` as shown below.
467+
1. Find the definition for the `main()` function in the same file. Make sure the `hsm_type` variable is set to `SECURE_DEVICE_TYPE_X509`.
468468

469469
```c
470470
SECURE_DEVICE_TYPE hsm_type;
@@ -493,7 +493,7 @@ To update the custom HSM stub code to simulate the identity of the device with I
493493

494494
1. Update the string value of the `CERTIFICATE` constant string using the device certificate, *device-cert.pem*, that you generated previously.
495495

496-
The syntax of certificate text in the sample must follow the pattern below with no extra spaces or parsing done by Visual Studio.
496+
The syntax of certificate text in the sample must follow the following pattern with no extra spaces or parsing done by Visual Studio.
497497

498498
```c
499499
static const char* const CERTIFICATE = "-----BEGIN CERTIFICATE-----\n"
@@ -513,7 +513,7 @@ To update the custom HSM stub code to simulate the identity of the device with I
513513

514514
1. Update the string value of the `PRIVATE_KEY` constant with the unencrypted private key for your device certificate, *unencrypted-device-key.pem*.
515515

516-
The syntax of the private key text must follow the pattern below with no extra spaces or parsing done by Visual Studio.
516+
The syntax of the private key text must follow the following pattern with no extra spaces or parsing done by Visual Studio.
517517

518518
```c
519519
static const char* const PRIVATE_KEY = "-----BEGIN RSA PRIVATE KEY-----\n"
@@ -580,13 +580,12 @@ In this section, you'll use your Windows command prompt.
580580

581581
>[!NOTE]
582582
>Additional parameters can be passed along while running the application to change the TransportType (-t) and the GlobalDeviceEndpoint (-g).
583-
584583

585584
```cmd
586585
dotnet run -- -s 0ne00000A0A -c certificate.pfx -p 1234
587586
```
588587

589-
5. The device will connect to DPS and be assigned to an IoT hub. Then, the device will send a telemetry message to the IoT hub.
588+
5. The device connects to DPS and is assigned to an IoT hub. Then, the device will send a telemetry message to the IoT hub.
590589

591590
```output
592591
Loading the certificate...
@@ -660,7 +659,7 @@ In this section, you'll use your Windows command prompt.
660659
node register_x509.js
661660
```
662661
663-
You should see output similar to the following:
662+
You should see output similar to the following example:
664663
665664
```output
666665
registration succeeded
@@ -722,7 +721,7 @@ In this section, you'll use your Windows command prompt.
722721

723722
1. Review the code for [provision_x509.py](https://github.com/Azure/azure-iot-sdk-python/blob/main/samples/async-hub-scenarios/provision_x509.py). If you're not using **Python version 3.7** or later, make the [code change mentioned here](https://github.com/Azure/azure-iot-sdk-python/tree/main/samples/async-hub-scenarios#advanced-iot-hub-scenario-samples-for-the-azure-iot-hub-device-sdk) to replace `asyncio.run(main())` and save your changes.
724723
725-
1. Run the sample. The sample will connect to DPS, which will provision the device to an IoT hub. After the device is provisioned, the sample will send some test messages to the IoT hub.
724+
1. Run the sample. The sample connects to DPS, which will provision the device to an IoT hub. After the device is provisioned, the sample will send some test messages to the IoT hub.
726725
727726
```cmd
728727
$ python azure-iot-sdk-python/samples/async-hub-scenarios/provision_x509.py
@@ -759,7 +758,7 @@ In this section, you'll use your Windows command prompt.
759758
760759
::: zone pivot="programming-language-java"
761760
762-
In this section, you'll use both your Windows command prompt and your Git Bash prompt.
761+
In this section, you use both your Windows command prompt and your Git Bash prompt.
763762
764763
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
765764
@@ -773,7 +772,7 @@ In this section, you'll use both your Windows command prompt and your Git Bash p
773772
cd .\azure-iot-sdk-java\provisioning\provisioning-samples\provisioning-X509-sample
774773
```
775774
776-
1. Enter the provisioning service and X.509 identity information in the sample code. This is used during provisioning, for attestation of the simulated device, prior to device registration.
775+
1. Enter the provisioning service and X.509 identity information in the sample code. This information is used during provisioning, for attestation of the simulated device, prior to device registration.
777776
778777
1. Open the file `.\src\main\java\samples\com/microsoft\azure\sdk\iot\ProvisioningX509Sample.java` in your favorite editor.
779778
@@ -786,7 +785,7 @@ In this section, you'll use both your Windows command prompt and your Git Bash p
786785
787786
1. Update the value of the `leafPublicPem` constant string with the value of your certificate, *device-cert.pem*.
788787
789-
The syntax of certificate text must follow the pattern below with no extra spaces or characters.
788+
The syntax of certificate text must follow the following pattern with no extra spaces or characters.
790789
791790
```java
792791
private static final String leafPublicPem = "-----BEGIN CERTIFICATE-----\n" +
@@ -806,7 +805,7 @@ In this section, you'll use both your Windows command prompt and your Git Bash p
806805
807806
1. Update the string value of the `leafPrivateKey` constant with the unencrypted private key for your device certificate, *unencrypted-device-key.pem*.
808807
809-
The syntax of the private key text must follow the pattern below with no extra spaces or characters.
808+
The syntax of the private key text must follow the following pattern with no extra spaces or characters.
810809
811810
```java
812811
private static final String leafPrivateKey = "-----BEGIN PRIVATE KEY-----\n" +
@@ -833,13 +832,13 @@ In this section, you'll use both your Windows command prompt and your Git Bash p
833832
cd target
834833
```
835834
836-
1. The build outputs .jar file in the `target` folder with the following file format: `provisioning-x509-sample-{version}-with-deps.jar`; for example: `provisioning-x509-sample-1.8.1-with-deps.jar`. Execute the .jar file. You may need to replace the version in the command below.
835+
1. The build outputs .jar file in the `target` folder with the following file format: `provisioning-x509-sample-{version}-with-deps.jar`; for example: `provisioning-x509-sample-1.8.1-with-deps.jar`. Execute the .jar file. You may need to replace the version in the following command.
837836
838837
```cmd
839838
java -jar ./provisioning-x509-sample-1.8.1-with-deps.jar
840839
```
841840
842-
The sample will connect to DPS, which will provision the device to an IoT hub. After the device is provisioned, the sample will send some test messages to the IoT hub.
841+
The sample connects to DPS, which will provision the device to an IoT hub. After the device is provisioned, the sample will send some test messages to the IoT hub.
843842
844843
```output
845844
Starting...

0 commit comments

Comments
 (0)