Skip to content

Commit 67edcdb

Browse files
committed
Minor Acrolinx fixes to improve score
1 parent e58377f commit 67edcdb

File tree

4 files changed

+44
-39
lines changed

4 files changed

+44
-39
lines changed

articles/iot-dps/quick-create-simulated-device-symm-key.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ services: iot-dps
1010
manager: lizross
1111
ms.custom: mvc, mode-other
1212
zone_pivot_groups: iot-dps-set1
13-
#Customer intent: As a new IoT developer, I want to connect a device to an IoT Hub using the SDK, to learn how secure provisioning works with symmetric keys.
13+
#Customer intent: As a new IoT developer, I want to connect a device to an IoT hub using the SDK, to learn how secure provisioning works with symmetric keys.
1414
---
1515

1616
# Quickstart: Provision a simulated symmetric key device
1717

18-
In this quickstart, you'll create a simulated device on your Windows machine. The simulated device will be configured to use the [symmetric key attestation](concepts-symmetric-key-attestation.md) mechanism for authentication. After you've configured your device, you'll then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
18+
In this quickstart, you create a simulated device on your Windows machine. The simulated device is configured to use the [symmetric key attestation](concepts-symmetric-key-attestation.md) mechanism for authentication. After you've configured your device, you then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
1919

2020
If you're unfamiliar with the process of provisioning, review the [provisioning](about-iot-dps.md#provisioning-process) overview.
2121

22-
This quickstart demonstrates a solution for a Windows-based workstation. However, you can also perform the procedures on Linux. For a Linux example, see [Tutorial: provision for geolatency](how-to-provision-multitenant.md).
22+
This quickstart demonstrates a solution for a Windows-based workstation. However, you can also perform the procedures on Linux. For a Linux example, see [Tutorial: provision for geo latency](how-to-provision-multitenant.md).
2323

2424
## Prerequisites
2525

@@ -253,7 +253,7 @@ To update and run the provisioning sample with your device information:
253253
static const char* id_scope = "0ne00002193";
254254
```
255255
256-
6. Find the definition for the `main()` function in the same file. Make sure the `hsm_type` variable is set to `SECURE_DEVICE_TYPE_SYMMETRIC_KEY` as shown below:
256+
6. Find the definition for the `main()` function in the same file. Make sure the `hsm_type` variable is set to `SECURE_DEVICE_TYPE_SYMMETRIC_KEY` as shown in the following example:
257257
258258
```c
259259
SECURE_DEVICE_TYPE hsm_type;
@@ -327,7 +327,7 @@ To update and run the provisioning sample with your device information:
327327
cd '.\azure-iot-sdk-csharp\provisioning\device\samples\how to guides\SymmetricKeySample\'
328328
```
329329
330-
4. In the *SymmetricKeySample* folder, open *Parameters.cs* in a text editor. This file shows the parameters that are supported by the sample. Only the first three required parameters are used in this article when running the sample. Review the code in this file. No changes are needed.
330+
4. In the *SymmetricKeySample* folder, open *Parameters.cs* in a text editor. This file shows the available parameters for the sample. Only the first three required parameters are used in this article when running the sample. Review the code in this file. No changes are needed.
331331
332332
| Parameter | Required | Description |
333333
| :-------------------------------- | :------- | :-------------- |
@@ -402,7 +402,7 @@ To update and run the provisioning sample with your device information:
402402
provisioningClient.setProvisioningPayload({a: 'b'});
403403
```
404404
405-
You may comment out this code, as it is not needed with for this quick start. A custom payload would be required you wanted to use a custom allocation function to assign your device to an IoT Hub. For more information, see [Tutorial: Use custom allocation policies](tutorial-custom-allocation-policies.md).
405+
You may comment out this code, as it's not needed with for this quickstart. A custom payload would be required you wanted to use a custom allocation function to assign your device to an IoT hub. For more information, see [Tutorial: Use custom allocation policies](tutorial-custom-allocation-policies.md).
406406
407407
The `provisioningClient.register()` method attempts the registration of your device.
408408
@@ -573,7 +573,7 @@ To update and run the provisioning sample with your device information:
573573
574574
1. In the main menu of your Device Provisioning Service, select **Overview**.
575575
576-
2. Copy the **ID Scope** and **Global device endpoint** values. These are your `SCOPE_ID` and `GLOBAL_ENDPOINT` respectively.
576+
2. Copy the **ID Scope** and **Global device endpoint** values. These values are your `SCOPE_ID` and `GLOBAL_ENDPOINT` parameters, respectively.
577577
578578
:::image type="content" source="./media/quick-create-simulated-device-symm-key/copy-id-scope-and-global-device-endpoint.png" alt-text="Extract Device Provisioning Service endpoint information":::
579579

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

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ zone_pivot_groups: iot-dps-set1
1515

1616
# Quickstart: Provision an X.509 certificate simulated device
1717

18-
In this quickstart, you'll create a simulated device on your Windows machine. The simulated device will be configured to use the [X.509 certificate attestation](concepts-x509-attestation.md) mechanism for authentication. After you've configured your device, you'll then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
18+
In this quickstart, you create a simulated device on your Windows machine. The simulated device is configured to use the [X.509 certificate attestation](concepts-x509-attestation.md) mechanism for authentication. After you've configured your device, you then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
1919

2020
If you're unfamiliar with the process of provisioning, review the [provisioning](about-iot-dps.md#provisioning-process) overview. Also make sure you've completed the steps in [Set up IoT Hub Device Provisioning Service with the Azure portal](./quick-setup-auto-provision.md) before continuing.
2121

22-
This quickstart demonstrates a solution for a Windows-based workstation. However, you can also perform the procedures on Linux. For a Linux example, see [Tutorial: Provision for geolatency](how-to-provision-multitenant.md).
22+
This quickstart demonstrates a solution for a Windows-based workstation. However, you can also perform the procedures on Linux. For a Linux example, see [Tutorial: Provision for geo latency](how-to-provision-multitenant.md).
2323

2424
## Prerequisites
2525

@@ -87,13 +87,13 @@ The following prerequisites are for a Windows development environment. For Linux
8787
8888
* Open both a Windows command prompt and a Git Bash prompt.
8989
90-
The steps in this quickstart assume that you're using a Windows machine and the OpenSSL installation that is installed as part of Git. You'll use the Git Bash prompt to issue OpenSSL commands and the Windows command prompt for everything else. If you're using Linux, you can issue all commands from a Bash shell.
90+
The steps in this quickstart assume that you're using a Windows machine and the OpenSSL installation that is installed as part of Git. You use the Git Bash prompt to issue OpenSSL commands and the Windows command prompt for everything else. If you're using Linux, you can issue all commands from a Bash shell.
9191
9292
## Prepare your development environment
9393
9494
::: zone pivot="programming-language-ansi-c"
9595
96-
In this section, you'll prepare a development environment that's used to build the [Azure IoT C SDK](https://github.com/Azure/azure-iot-sdk-c). The sample code attempts to provision the device, during the device's boot sequence.
96+
In this section, you prepare a development environment that's used to build the [Azure IoT C SDK](https://github.com/Azure/azure-iot-sdk-c). The sample code attempts to provision the device, during the device's boot sequence.
9797
9898
1. Open a web browser, and go to the [Release page of the Azure IoT C SDK](https://github.com/Azure/azure-iot-sdk-c/releases/latest).
9999
@@ -199,7 +199,7 @@ git clone -b v2 https://github.com/Azure/azure-iot-sdk-python.git --recursive
199199

200200
## Create a self-signed X.509 device certificate
201201

202-
In this section, you'll use OpenSSL to create a self-signed X.509 certificate and a private key. This certificate will be uploaded to your provisioning service instance and verified by the service.
202+
In this section, you use OpenSSL to create a self-signed X.509 certificate and a private key. This certificate is uploaded to your provisioning service instance and verified by the service.
203203

204204
> [!CAUTION]
205205
> Use certificates created with OpenSSL in this quickstart for development testing only.
@@ -318,13 +318,13 @@ Perform the steps in this section in your Git Bash prompt.
318318
319319
7. When asked to **Enter pass phrase for device-key.pem:**, use the same pass phrase you did previously, `1234`.
320320
321-
Keep the Git Bash prompt open. You'll need it later in this quickstart.
321+
Keep the Git Bash prompt open. You need it later in this quickstart.
322322
323323
::: zone-end
324324
325325
::: zone pivot="programming-language-csharp"
326326
327-
The C# sample code is set up to use X.509 certificates that are stored in a password-protected PKCS#12 formatted file (`certificate.pfx`). You'll still need the PEM formatted public key certificate file (`device-cert.pem`) that you just created to create an individual enrollment entry later in this quickstart.
327+
The C# sample code is set up to use X.509 certificates that are stored in a password-protected PKCS#12 formatted file (`certificate.pfx`). You still need the PEM formatted public key certificate file (`device-cert.pem`) that you just created to create an individual enrollment entry later in this quickstart.
328328
329329
1. To generate the PKCS12 formatted file expected by the sample, enter the following command:
330330
@@ -356,7 +356,7 @@ The C# sample code is set up to use X.509 certificates that are stored in a pass
356356
cp certificate.pfx ./azure-iot-sdk-csharp/provisioning/device/samples/"Getting Started"/X509Sample
357357
```
358358
359-
You won't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
359+
You don't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
360360

361361
::: zone-end
362362

@@ -387,7 +387,7 @@ You won't need the Git Bash prompt for the rest of this quickstart. However, you
387387
cp unencrypted-device-key.pem ./azure-iot-sdk-node/provisioning/device/samples
388388
```
389389
390-
You won't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
390+
You don't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
391391

392392
::: zone-end
393393

@@ -400,7 +400,7 @@ You won't need the Git Bash prompt for the rest of this quickstart. However, you
400400
cp device-key.pem ./azure-iot-sdk-python/samples/async-hub-scenarios
401401
```
402402

403-
You won't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
403+
You don't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
404404
405405
::: zone-end
406406
::: zone pivot="programming-language-java"
@@ -423,7 +423,7 @@ You won't need the Git Bash prompt for the rest of this quickstart. However, you
423423

424424
7. When asked to **Enter pass phrase for device-key.pem:**, use the same pass phrase you did previously, `1234`.
425425

426-
Keep the Git Bash prompt open. You'll need it later in this quickstart.
426+
Keep the Git Bash prompt open. You need it later in this quickstart.
427427

428428
::: zone-end
429429

@@ -482,7 +482,7 @@ In this section, you update the sample code with your Device Provisioning Servic
482482
483483
### Configure the custom HSM stub code
484484
485-
The specifics of interacting with actual secure hardware-based storage vary depending on the hardware. As a result, the certificate and private key used by the simulated device in this quickstart will be hardcoded in the custom Hardware Security Module (HSM) stub code.
485+
The specifics of interacting with actual secure hardware-based storage vary depending on the hardware. As a result, the certificate and private key used by the simulated device in this quickstart is hardcoded in the custom Hardware Security Module (HSM) stub code.
486486
487487
To update the custom HSM stub code to simulate the identity of the device with ID `my-x509-device`:
488488
@@ -506,7 +506,7 @@ To update the custom HSM stub code to simulate the identity of the device with I
506506
"-----END CERTIFICATE-----";
507507
```
508508
509-
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command will generate the syntax for the `CERTIFICATE` string constant value and write it to the output.
509+
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command generates the syntax for the `CERTIFICATE` string constant value and writes it to the output.
510510
511511
```Bash
512512
sed -e 's/^/"/;$ !s/$/""\\n"/;$ s/$/"/' device-cert.pem
@@ -526,7 +526,7 @@ To update the custom HSM stub code to simulate the identity of the device with I
526526
"-----END RSA PRIVATE KEY-----";
527527
```
528528
529-
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command will generate the syntax for the `PRIVATE_KEY` string constant value and write it to the output.
529+
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command generates the syntax for the `PRIVATE_KEY` string constant value and writes it to the output.
530530
531531
```Bash
532532
sed -e 's/^/"/;$ !s/$/""\\n"/;$ s/$/"/' unencrypted-device-key.pem
@@ -563,7 +563,7 @@ To update the custom HSM stub code to simulate the identity of the device with I
563563

564564
::: zone pivot="programming-language-csharp"
565565

566-
In this section, you'll use your Windows command prompt.
566+
In this section, you use your Windows command prompt.
567567

568568
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
569569

@@ -573,7 +573,7 @@ In this section, you'll use your Windows command prompt.
573573

574574
3. In your Windows command prompt, change to the X509Sample directory. This directory is located in the *.\azure-iot-sdk-csharp\provisioning\device\samples\getting started\X509Sample* directory off the directory where you cloned the samples on your computer.
575575

576-
4. Enter the following command to build and run the X.509 device provisioning sample (replace the `<IDScope>` value with the ID Scope that you copied in the previous section. The certificate file will default to *./certificate.pfx* and prompt for the .pfx password.
576+
4. Enter the following command to build and run the X.509 device provisioning sample (replace the `<IDScope>` value with the ID Scope that you copied in the previous section. The certificate file defaults to *./certificate.pfx* and prompts for the .pfx password.
577577

578578
```cmd
579579
dotnet run -- -s <IDScope>
@@ -588,7 +588,7 @@ In this section, you'll use your Windows command prompt.
588588
dotnet run -- -s 0ne00000A0A -c certificate.pfx -p 1234
589589
```
590590

591-
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.
591+
5. The device connects to DPS and is assigned to an IoT hub. Then, the device sends a telemetry message to the IoT hub.
592592

593593
```output
594594
Loading the certificate...
@@ -611,7 +611,7 @@ In this section, you'll use your Windows command prompt.
611611

612612
::: zone pivot="programming-language-nodejs"
613613

614-
In this section, you'll use your Windows command prompt.
614+
In this section, you use your Windows command prompt.
615615

616616
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
617617

@@ -676,7 +676,7 @@ In this section, you'll use your Windows command prompt.
676676

677677
::: zone pivot="programming-language-python"
678678

679-
In this section, you'll use your Windows command prompt.
679+
In this section, you use your Windows command prompt.
680680

681681
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
682682

@@ -724,7 +724,7 @@ In this section, you'll use your Windows command prompt.
724724

725725
1. Review the code for [provision_x509.py](https://github.com/Azure/azure-iot-sdk-python/blob/v2/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/v2/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.
726726
727-
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.
727+
1. Run the sample. The sample connects to DPS, which provisions the device to an IoT hub. After the device is provisioned, the sample sends some test messages to the IoT hub.
728728
729729
```cmd
730730
$ python azure-iot-sdk-python/samples/async-hub-scenarios/provision_x509.py
@@ -798,7 +798,7 @@ In this section, you use both your Windows command prompt and your Git Bash prom
798798
"-----END CERTIFICATE-----";
799799
```
800800
801-
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command will generate the syntax for the `leafPublicPem` string constant value and write it to the output.
801+
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command generates the syntax for the `leafPublicPem` string constant value and write it to the output.
802802
803803
```Bash
804804
sed 's/^/"/;$ !s/$/\\n" +/;$ s/$/"/' device-cert.pem
@@ -818,7 +818,7 @@ In this section, you use both your Windows command prompt and your Git Bash prom
818818
"-----END PRIVATE KEY-----";
819819
```
820820
821-
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command will generate the syntax for the `leafPrivateKey` string constant value and write it to the output.
821+
Updating this string value manually can be prone to error. To generate the proper syntax, you can copy and paste the following command into your **Git Bash prompt**, and press **ENTER**. This command generates the syntax for the `leafPrivateKey` string constant value and write it to the output.
822822
823823
```Bash
824824
sed 's/^/"/;$ !s/$/\\n" +/;$ s/$/"/' unencrypted-device-key.pem
@@ -841,7 +841,7 @@ In this section, you use both your Windows command prompt and your Git Bash prom
841841
java -jar ./provisioning-x509-sample-1.8.1-with-deps.jar
842842
```
843843
844-
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.
844+
The sample connects to DPS, which provisions the device to an IoT hub. After the device is provisioned, the sample sends some test messages to the IoT hub.
845845
846846
```output
847847
Starting...

0 commit comments

Comments
 (0)