Skip to content

Commit 3885e9a

Browse files
committed
acrolinx and formatting
1 parent 7753bb3 commit 3885e9a

5 files changed

+34
-59
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ms.subservice: azure-iot-hub-dps
1616

1717
# Quickstart: Provision a simulated symmetric key device
1818

19-
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.
19+
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 configure your device, you then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
2020

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

@@ -109,7 +109,7 @@ In this section, you prepare a development environment that's used to build the
109109
```
110110
111111
>[!TIP]
112-
>If `cmake` does not find your C++ compiler, you may get build errors while running the above command. If that happens, try running the command in the [Visual Studio command prompt](/dotnet/framework/tools/developer-command-prompt-for-vs).
112+
>If `cmake` does not find your C++ compiler, you may get build errors while running the previous command. If that happens, try running the command in the [Visual Studio command prompt](/dotnet/framework/tools/developer-command-prompt-for-vs).
113113
114114
8. When the build completes successfully, the last few output lines look similar to the following output:
115115
@@ -312,7 +312,7 @@ The sample provisioning code accomplishes the following tasks:
312312
313313
2. Assigns the device to the IoT hub already linked to your Device Provisioning Service instance.
314314
315-
3. Sends a test telemetry message to the IoT hub.
315+
3. Sends a test message to the IoT hub.
316316
317317
To update and run the provisioning sample with your device information:
318318
@@ -338,7 +338,7 @@ To update and run the provisioning sample with your device information:
338338
| `--g` or `--GlobalDeviceEndpoint` | False | The global endpoint for devices to connect to. Defaults to `global.azure-devices-provisioning.net` |
339339
| `--t` or `--TransportType` | False | The transport to use to communicate with the device provisioning instance. Defaults to `Mqtt`. Possible values include `Mqtt`, `Mqtt_WebSocket_Only`, `Mqtt_Tcp_Only`, `Amqp`, `Amqp_WebSocket_Only`, `Amqp_Tcp_only`, and `Http1`.|
340340
341-
5. In the *SymmetricKeySample* folder, open *ProvisioningDeviceClientSample.cs* in a text editor. This file shows how the [SecurityProviderSymmetricKey](/dotnet/api/microsoft.azure.devices.shared.securityprovidersymmetrickey?view=azure-dotnet&preserve-view=true) class is used along with the [ProvisioningDeviceClient](/dotnet/api/microsoft.azure.devices.provisioning.client.provisioningdeviceclient?view=azure-dotnet&preserve-view=true) class to provision your simulated symmetric key device. Review the code in this file. No changes are needed.
341+
5. In the *SymmetricKeySample* folder, open *ProvisioningDeviceClientSample.cs* in a text editor. This file shows how the [SecurityProviderSymmetricKey](/dotnet/api/microsoft.azure.devices.shared.securityprovidersymmetrickey?view=azure-dotnet&preserve-view=true) class is used along with the [ProvisioningDeviceClient](/dotnet/api/microsoft.azure.devices.provisioning.client.provisioningdeviceclient?view=azure-dotnet&preserve-view=true) class to provision your simulated symmetric key device. Review the code in this file. No changes are needed.
342342
343343
6. Build and run the sample code using the following command:
344344
@@ -381,7 +381,7 @@ The sample provisioning code accomplishes the following tasks, in order:
381381
382382
2. Assigns the device to the IoT hub already linked to your Device Provisioning Service instance.
383383
384-
3. Sends a test telemetry message to the IoT hub.
384+
3. Sends a test message to the IoT hub.
385385
386386
To update and run the provisioning sample with your device information:
387387
@@ -403,9 +403,9 @@ To update and run the provisioning sample with your device information:
403403
provisioningClient.setProvisioningPayload({a: 'b'});
404404
```
405405
406-
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).
406+
You can comment out this payload code for this quickstart. A custom payload would be required if 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).
407407
408-
The `provisioningClient.register()` method attempts the registration of your device.
408+
The `provisioningClient.register()` method attempts the registration of your device.
409409
410410
No further changes are needed.
411411
@@ -469,7 +469,7 @@ The sample provisioning code accomplishes the following tasks, in order:
469469
470470
2. Assigns the device to the IoT hub already linked to your Device Provisioning Service instance.
471471
472-
3. Sends a test telemetry message to the IoT hub.
472+
3. Sends a test message to the IoT hub.
473473
474474
To update and run the provisioning sample with your device information:
475475
@@ -568,7 +568,7 @@ The sample provisioning code accomplishes the following tasks, in order:
568568
569569
2. Assigns the device to the IoT hub already linked to your Device Provisioning Service instance.
570570
571-
3. Sends a test telemetry message to the IoT hub.
571+
3. Sends a test message to the IoT hub.
572572
573573
To update and run the provisioning sample with your device information:
574574

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

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ ms.subservice: azure-iot-hub-dps
1616
# Quickstart: Provision a simulated TPM device
1717

1818
::: zone pivot="programming-language-csharp, programming-language-ansi-c, programming-language-nodejs, programming-language-java"
19-
In this quickstart, you'll create a simulated device on your Windows machine. The simulated device will be configured to use a [Trusted Platform Module (TPM) attestation](concepts-tpm-attestation.md) mechanism for authentication. After you've configured your device, you'll provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service. Sample code will then be used to help enroll the device with a Device Provisioning Service instance.
19+
In this quickstart, you'll create a simulated device on your Windows machine. The simulated device will be configured to use a [Trusted Platform Module (TPM) attestation](concepts-tpm-attestation.md) mechanism for authentication. After you configure your device, you'll provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service. Sample code will then be used to help enroll the device with a Device Provisioning Service instance.
2020

21-
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.
21+
If you're unfamiliar with the process of provisioning, review the [provisioning](about-iot-dps.md#provisioning-process) overview. Also make sure that you complete the steps in [Set up IoT Hub Device Provisioning Service with the Azure portal](./quick-setup-auto-provision.md) before continuing.
2222

2323
The Azure IoT Device Provisioning Service supports two types of enrollments:
2424

@@ -377,7 +377,7 @@ In this section, you'll build and execute a sample that reads the endorsement ke
377377
java -jar ./provisioning-tpm-sample-{version}-with-deps.jar
378378
```
379379
380-
5. When the program begins running, it will display the *_Endorsement key_* and *_Registration ID_*. Copy these values for the next section. Make sure to leave the program running.
380+
5. When the program begins running, it will display the *_Endorsement key_* and *_Registration ID_*. Copy these values for the next section. Make sure to leave the program running.
381381
382382
::: zone-end
383383
@@ -640,34 +640,9 @@ In this section, you'll configure sample code to use the [Advanced Message Queui
640640
641641
4. In the **Device management** section, select **Devices**.
642642
643-
:::zone-end
644-
:::zone pivot="programming-language-ansi-c"
645643
5. If your device was provisioned successfully, the device ID should appear in the list, with **Status** set as *enabled*. If you don't see your device, select **Refresh** at the top of the page.
646644
647-
![Device is registered with the IoT hub for C](./media/quick-create-simulated-device-tpm/hub-registration.png)
648-
649-
:::zone-end
650-
651-
:::zone pivot="programming-language-csharp"
652-
5. If your device was provisioned successfully, the device ID should appear in the list, with **Status** set as *enabled*. If you don't see your device, select **Refresh** at the top of the page.
653-
654-
![Device is registered with the IoT hub for C#](./media/quick-create-simulated-device-tpm/hub-registration.png)
655-
656-
::: zone-end
657-
658-
::: zone pivot="programming-language-nodejs"
659-
5. If your device was provisioned successfully, the device ID should appear in the list, with **Status** set as *enabled*. If you don't see your device, select **Refresh** at the top of the page.
660-
661-
![Device is registered with the IoT hub for Node.js](./media/quick-create-simulated-device-tpm/hub-registration.png)
662-
663-
::: zone-end
664-
665-
::: zone pivot="programming-language-java"
666-
5. If your device was provisioned successfully, the device ID should appear in the list, with **Status** set as *enabled*. If you don't see your device, select **Refresh** at the top of the page.
667-
668-
![Device is registered with the IoT hub](./media/quick-create-simulated-device-tpm/hub-registration.png)
669-
670-
::: zone-end
645+
![Screenshot that shows that the provisioned device is registered with the IoT hub.](./media/quick-create-simulated-device-tpm/hub-registration.png)
671646
672647
> [!NOTE]
673648
> If you changed the *initial device twin state* from the default value in the enrollment entry for your device, it can pull the desired twin state from the hub and act accordingly. For more information, see [Understand and use device twins in IoT Hub](../iot-hub/iot-hub-devguide-device-twins.md).

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ ms.subservice: azure-iot-hub-dps
1616

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

19-
In this quickstart, you create a simulated device on your Windows machine. The simulated device is configured to use X.509 certificate attestation for authentication. After you've configured your device, you then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
19+
In this quickstart, you create a simulated device on your Windows machine. The simulated device is configured to use X.509 certificate attestation for authentication. After you configure your device, you then provision it to your IoT hub using the Azure IoT Hub Device Provisioning Service.
2020

21-
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.
21+
If you're unfamiliar with the process of provisioning, review the [provisioning](about-iot-dps.md#provisioning-process) overview. Also make sure that you complete the steps in [Set up IoT Hub Device Provisioning Service with the Azure portal](./quick-setup-auto-provision.md) before continuing.
2222

2323
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).
2424

@@ -366,7 +366,7 @@ The C# sample code is set up to use X.509 certificates that are stored in a pass
366366
cp certificate.pfx ./azure-iot-sdk-csharp/provisioning/device/samples/"Getting Started"/X509Sample
367367
```
368368
369-
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.
369+
You don't need the Git Bash prompt for the rest of this quickstart. However, you might want to keep it open to check your certificate if you have problems in later steps.
370370

371371
::: zone-end
372372

@@ -397,7 +397,7 @@ You don't need the Git Bash prompt for the rest of this quickstart. However, you
397397
cp unencrypted-device-key.pem ./azure-iot-sdk-node/provisioning/device/samples
398398
```
399399
400-
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.
400+
You don't need the Git Bash prompt for the rest of this quickstart. However, you might want to keep it open to check your certificate if you have problems in later steps.
401401

402402
::: zone-end
403403

@@ -410,7 +410,7 @@ You don't need the Git Bash prompt for the rest of this quickstart. However, you
410410
cp device-key.pem ./azure-iot-sdk-python/samples/async-hub-scenarios
411411
```
412412

413-
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.
413+
You don't need the Git Bash prompt for the rest of this quickstart. However, you might want to keep it open to check your certificate if you have problems in later steps.
414414
415415
::: zone-end
416416
::: zone pivot="programming-language-java"
@@ -598,7 +598,7 @@ In this section, you use your Windows command prompt.
598598
dotnet run -- -s 0ne00000A0A -c certificate.pfx -p 1234
599599
```
600600

601-
5. The device connects to DPS and is assigned to an IoT hub. Then, the device sends a telemetry message to the IoT hub.
601+
5. The device connects to DPS and is assigned to an IoT hub. Then, the device sends a message to the IoT hub.
602602

603603
```output
604604
Loading the certificate...
@@ -845,7 +845,7 @@ In this section, you use both your Windows command prompt and your Git Bash prom
845845
cd target
846846
```
847847
848-
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.
848+
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 might need to replace the version in the following command.
849849
850850
```cmd
851851
java -jar ./provisioning-x509-sample-1.8.1-with-deps.jar

0 commit comments

Comments
 (0)