Skip to content

Commit 3d18474

Browse files
committed
Updated metadata, screenshots, includes, and links, minor updates to improve Acrolinx score
1 parent 94cffe8 commit 3d18474

File tree

6 files changed

+29
-29
lines changed

6 files changed

+29
-29
lines changed
-77.9 KB
Loading
11.9 KB
Loading
12 KB
Loading
4.37 KB
Loading

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

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Quickstart - Provision an X.509 certificate simulated device to Microsoft
33
description: Learn how to provision a simulated device that authenticates with an X.509 certificate in the Azure IoT Hub Device Provisioning Service
44
author: SoniaLopezBravo
55
ms.author: sonialopez
6-
ms.date: 04/06/2023
6+
ms.date: 07/25/2025
77
ms.topic: quickstart
88
ms.service: azure-iot-hub
99
services: iot-dps
@@ -18,15 +18,15 @@ ms.subservice: azure-iot-hub-dps
1818

1919
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 that you complete 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 [Quickstart: 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

2525
## Prerequisites
2626

2727
* If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) before you begin.
2828

29-
* Complete the steps in [Set up IoT Hub Device Provisioning Service with the Azure portal](./quick-setup-auto-provision.md).
29+
* Complete the steps in [Quickstart: Set up IoT Hub Device Provisioning Service with the Azure portal](./quick-setup-auto-provision.md).
3030

3131
::: zone pivot="programming-language-ansi-c"
3232

@@ -37,7 +37,7 @@ The following prerequisites are for a Windows development environment. For Linux
3737
* Install the latest [CMake build system](https://cmake.org/download/). Make sure you check the option that adds the CMake executable to your path.
3838

3939
>[!IMPORTANT]
40-
>Confirm that the Visual Studio prerequisites (Visual Studio and the 'Desktop development with C++' workload) are installed on your machine, **before** starting the `CMake` installation. Once the prerequisites are in place, and the download is verified, install the CMake build system. Also, be aware that older versions of the CMake build system fail to generate the solution file used in this article. Make sure to use the latest version of CMake.
40+
>Confirm that the Visual Studio prerequisites (Visual Studio and the 'Desktop development with C++' workload) are installed on your machine, **before** starting the `CMake` installation. Once the prerequisites are in place, and the download is verified, install the CMake build system. Also, older versions of the CMake build system fail to generate the solution file used in this article. Make sure to use the latest version of CMake.
4141
4242
::: zone-end
4343

@@ -84,7 +84,7 @@ The following prerequisites are for a Windows development environment. For Linux
8484
* Make sure [OpenSSL](https://www.openssl.org/) is installed on your machine. On Windows, your installation of Git includes an installation of OpenSSL. You can access OpenSSL from the Git Bash prompt. To verify that OpenSSL is installed, open a Git Bash prompt and enter `openssl version`.
8585
8686
>[!NOTE]
87-
> Unless you're familiar with OpenSSL and already have it installed on your Windows machine, we recommend using OpenSSL from the Git Bash prompt. Alternatively, you can choose to download the source code and build OpenSSL. To learn more, see the [OpenSSL Downloads](https://www.openssl.org/source/) page. Or, you can download OpenSSL pre-built from a third-party. To learn more, see the [OpenSSL wiki](https://wiki.openssl.org/index.php/Binaries). Microsoft makes no guarantees about the validity of packages downloaded from third-parties. If you do choose to build or download OpenSSL make sure that the OpenSSL binary is accessible in your path and that the `OPENSSL_CNF` environment variable is set to the path of your *openssl.cnf* file.
87+
> Unless you're familiar with OpenSSL and it's already installed on your Windows machine, we recommend using OpenSSL from the Git Bash prompt. Alternatively, you can choose to download the source code and build OpenSSL. To learn more, see the [OpenSSL Downloads](https://www.openssl.org/source/) page. Or, you can download OpenSSL prebuilt from a non-Microsoft provider. To learn more, see the [OpenSSL wiki](https://wiki.openssl.org/index.php/Binaries). Microsoft makes no guarantees about the validity of packages downloaded from non-Microsoft providers. If you do choose to build or download OpenSSL make sure that the OpenSSL binary is accessible in your path and that the `OPENSSL_CNF` environment variable is set to the path of your *openssl.cnf* file.
8888
8989
* Open both a Windows command prompt and a Git Bash prompt.
9090
@@ -138,7 +138,7 @@ In this section, you prepare a development environment that's used to build the
138138
---
139139

140140
>[!TIP]
141-
>If `cmake` doesn't 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).
141+
>If `cmake` doesn't find your C++ compiler, you might encounter build errors while running the previous command. If that happens, try running the command in the [Visual Studio Developer Command Prompt](/dotnet/framework/tools/developer-command-prompt-for-vs).
142142
143143
7. When the build succeeds, the last few output lines look similar to the following output:
144144

@@ -159,7 +159,7 @@ In this section, you prepare a development environment that's used to build the
159159

160160
::: zone pivot="programming-language-csharp"
161161

162-
In your Windows command prompt, clone the [Azure IoT SDK for C#](https://github.com/Azure/azure-iot-sdk-csharp) GitHub repository using the following command:
162+
In your Windows command prompt, clone the [Azure IoT SDK for .NET](https://github.com/Azure/azure-iot-sdk-csharp) GitHub repository using the following command:
163163

164164
```cmd
165165
git clone https://github.com/Azure/azure-iot-sdk-csharp.git
@@ -169,7 +169,7 @@ git clone https://github.com/Azure/azure-iot-sdk-csharp.git
169169

170170
::: zone pivot="programming-language-nodejs"
171171

172-
In your Windows command prompt, clone the [Azure IoT SDK for Node.js](https://github.com/Azure/azure-iot-sdk-node) GitHub repository using the following command:
172+
In your Windows command prompt, clone the [Azure IoT Node.js SDK](https://github.com/Azure/azure-iot-sdk-node) GitHub repository using the following command:
173173

174174
```cmd
175175
git clone https://github.com/Azure/azure-iot-sdk-node.git
@@ -179,7 +179,7 @@ git clone https://github.com/Azure/azure-iot-sdk-node.git
179179

180180
::: zone pivot="programming-language-python"
181181

182-
In your Windows command prompt, clone the [Azure IoT Device SDK for Python](https://github.com/Azure/azure-iot-sdk-python/tree/v2) GitHub repository using the following command:
182+
In your Windows command prompt, clone the [Azure IoT Python SDK](https://github.com/Azure/azure-iot-sdk-python/tree/v2) GitHub repository using the following command:
183183

184184
```cmd
185185
git clone -b v2 https://github.com/Azure/azure-iot-sdk-python.git --recursive
@@ -192,7 +192,7 @@ git clone -b v2 https://github.com/Azure/azure-iot-sdk-python.git --recursive
192192

193193
::: zone pivot="programming-language-java"
194194

195-
1. In your Windows command prompt, clone the [Azure IoT Samples for Java](https://github.com/Azure/azure-iot-sdk-java) GitHub repository using the following command:
195+
1. In your Windows command prompt, clone the [Azure IoT SDKs for Java](https://github.com/Azure/azure-iot-sdk-java) GitHub repository using the following command:
196196

197197
```cmd
198198
git clone https://github.com/Azure/azure-iot-sdk-java.git --recursive
@@ -213,8 +213,8 @@ In this section, you use OpenSSL to create a self-signed X.509 certificate and a
213213

214214
> [!CAUTION]
215215
> Use certificates created with OpenSSL in this quickstart for development testing only.
216-
> Do not use these certificates in production.
217-
> These certificates expire after 30 days and may contain hard-coded passwords, such as *1234*.
216+
> Don't use these certificates in production.
217+
> These certificates expire after 30 days and might contain hard-coded passwords, such as *1234*.
218218
> To learn about obtaining certificates suitable for use in production, see [How to get an X.509 CA certificate](../iot-hub/iot-hub-x509ca-overview.md#get-an-x509-ca-certificate) in the Azure IoT Hub documentation.
219219
>
220220
@@ -461,7 +461,7 @@ In this section, you use your Git Bash prompt and the Visual Studio IDE.
461461
462462
In this section, you update the sample code with your Device Provisioning Service instance information.
463463
464-
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
464+
1. In the Azure portal, select the **Overview** tab from the resource menu for your Device Provisioning Service instance.
465465
466466
1. Copy the **ID Scope** value.
467467
@@ -575,7 +575,7 @@ To update the custom HSM stub code to simulate the identity of the device with I
575575

576576
In this section, you use your Windows command prompt.
577577

578-
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
578+
1. In the Azure portal, select the **Overview** tab from the resource menu for your Device Provisioning Service instance.
579579

580580
2. Copy the **ID Scope** value.
581581

@@ -592,7 +592,7 @@ In this section, you use your Windows command prompt.
592592
If you want to pass the certificate and password as a parameter, you can use the following format.
593593

594594
>[!NOTE]
595-
>Additional parameters can be passed along while running the application to change the TransportType (-t) and the GlobalDeviceEndpoint (-g).
595+
>Extra parameters can be passed along while running the application to change the TransportType (-t) and the GlobalDeviceEndpoint (-g).
596596

597597
```cmd
598598
dotnet run -- -s 0ne00000A0A -c certificate.pfx -p 1234
@@ -623,7 +623,7 @@ In this section, you use your Windows command prompt.
623623

624624
In this section, you use your Windows command prompt.
625625

626-
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
626+
1. In the Azure portal, select the **Overview** tab from the resource menu for your Device Provisioning Service instance.
627627

628628
1. Copy the **ID Scope** value.
629629

@@ -688,7 +688,7 @@ In this section, you use your Windows command prompt.
688688

689689
In this section, you use your Windows command prompt.
690690

691-
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
691+
1. In the Azure portal, select the **Overview** tab from the resource menu for your Device Provisioning Service instance.
692692

693693
1. Copy the **ID Scope** and **Global device endpoint** values.
694694

@@ -711,7 +711,7 @@ In this section, you use your Windows command prompt.
711711
| `X509_KEY_FILE` | The path to your device certificate private key file. |
712712
| `PASS_PHRASE` | The pass phrase you used to encrypt the certificate and private key file (`1234`). |
713713

714-
1. Add the environment variables for the global device endpoint and ID Scope.
714+
1. Add the environment variables for the global device endpoint and ID scope.
715715

716716
```cmd
717717
set PROVISIONING_HOST=global.azure-devices-provisioning.net
@@ -773,7 +773,7 @@ In this section, you use your Windows command prompt.
773773
774774
In this section, you use both your Windows command prompt and your Git Bash prompt.
775775
776-
1. In the Azure portal, select the **Overview** tab for your Device Provisioning Service.
776+
1. In the Azure portal, select the **Overview** tab from the resource menu for your Device Provisioning Service instance.
777777
778778
1. Copy the **ID Scope** and **Global device endpoint** values.
779779
@@ -785,7 +785,7 @@ In this section, you use both your Windows command prompt and your Git Bash prom
785785
cd .\azure-iot-sdk-java\provisioning\provisioning-device-client-samples\provisioning-X509-sample
786786
```
787787
788-
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.
788+
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, before device registration.
789789
790790
1. Open the file `.\src\main\java\samples\com\microsoft\azure\sdk\iot\ProvisioningX509Sample.java` in your favorite editor.
791791
@@ -899,9 +899,9 @@ In this section, you use both your Windows command prompt and your Git Bash prom
899899
900900
To see which IoT hub your device was provisioned to, examine the registration details of the individual enrollment you created previously:
901901
902-
1. In Azure portal, go to your Device Provisioning Service.
902+
1. In Azure portal, navigate to your Device Provisioning Service instance.
903903
904-
1. In the **Settings** menu, select **Manage enrollments**.
904+
1. In the resource menu, under **Settings**, select **Manage enrollments**.
905905
906906
1. Select **Individual Enrollments**. The X.509 enrollment entry that you created previously, *my-x509-device*, should appear in the list.
907907
@@ -911,7 +911,7 @@ To verify the device in your IoT hub:
911911
912912
1. In Azure portal, go to the IoT hub that your device was assigned to.
913913
914-
1. In the **Device management** menu, select **Devices**.
914+
1. In the resource menu, under **Device management**, select **Devices**.
915915
916916
1. If your device was provisioned successfully, its device ID, *my-x509-device*, should appear in the list, with **Status** set as *enabled*. If you don't see your device, select **Refresh**.
917917

@@ -934,9 +934,9 @@ If you plan to continue working on and exploring the device client sample, don't
934934

935935
2. From the left-hand menu in the Azure portal, select **All resources**.
936936

937-
3. Select your Device Provisioning Service.
937+
3. Select your Device Provisioning Service instance.
938938

939-
4. In the **Settings** menu, select **Manage enrollments**.
939+
4. In the resource menu, under **Settings**, select **Manage enrollments**.
940940

941941
5. Select the **Individual enrollments** tab.
942942

@@ -950,7 +950,7 @@ If you plan to continue working on and exploring the device client sample, don't
950950

951951
2. Select your IoT hub.
952952

953-
3. In the **Device management** menu, select **Devices**.
953+
3. In the resource menu, under **Device management**, select **Devices**.
954954

955955
4. Select the check box next to the device ID of the device you registered in this quickstart.
956956

@@ -961,4 +961,4 @@ If you plan to continue working on and exploring the device client sample, don't
961961
In this quickstart, you provisioned a single device to your IoT hub using an individual enrollment. Next, learn how to provision multiple devices across multiple hubs.
962962

963963
> [!div class="nextstepaction"]
964-
> [Tutorial: Manage IoT hub assignment with custom allocation policies](tutorial-custom-allocation-policies.md)
964+
> [Tutorial: Use custom allocation policies with Device Provisioning Service (DPS)](tutorial-custom-allocation-policies.md)

includes/iot-dps-individual-enrollment-x509.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
author: SoniaLopezBravo
33
ms.service: azure-iot-hub
44
ms.topic: include
5-
ms.date: 03/09/2023
5+
ms.date: 07/25/2025
66
ms.author: sonialopez
77
ms.subservice: azure-iot-hub-dps
88
---
99

1010
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Device Provisioning Service instance.
1111

12-
1. Select **Manage enrollments** from the **Settings** section of the navigation menu.
12+
1. Select **Manage enrollments** from the **Settings** section of the resource menu.
1313

1414
1. Select the **Individual enrollments** tab, then select **Add individual enrollment**.
1515

0 commit comments

Comments
 (0)