You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: articles/iot-dps/how-to-manage-enrollments-sdks.md
+5-4
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ ms.custom: mvc
18
18
# How to manage device enrollments with Azure Device Provisioning Service SDKs
19
19
A *device enrollment* creates a record of a single device or a group of devices that may at some point register with the Device Provisioning Service. The enrollment record contains the initial desired configuration for the device(s) as part of that enrollment, including the desired IoT hub. This article shows you how to manage device enrollments for your provisioning service programmatically using the Azure IoT Provisioning Service SDKs. The SDKs are available on GitHub in the same repository as Azure IoT SDKs.
20
20
21
+
## Samples
21
22
This article reviews the high level concepts for managing device enrollments for your provisioning service programmatically using the Azure IoT Provisioning Service SDKs. Exact API calls may be different due to language differences. Please review the samples we provide on GitHub for details:
22
23
*[Java Provisioning Service Client samples](https://github.com/Azure/azure-iot-sdk-java/tree/master/provisioning/provisioning-samples)
23
24
*[Node.js Provisioning Service Client samples](https://github.com/Azure/azure-iot-sdk-node/tree/master/provisioning/service/samples)
@@ -56,7 +57,7 @@ There are two ways you can enroll your devices with the provisioning service:
56
57
57
58
After you have successfully created an enrollment, the Device Provisioning Service would return an enrollment result.
58
59
59
-
This workflow is demonstrated in our samples in detail.
60
+
This workflow is demonstrated in the [samples](#samples).
60
61
61
62
## Update an enrollment entry
62
63
@@ -72,14 +73,14 @@ You can update an enrollment entry following this workflow:
72
73
2. Modify the parameter of the latest enrollment as necessary.
73
74
3. Using the latest enrollment, call Service SDK API ```createOrUpdateEnrollmentGroup``` to update your enrollment entry.
74
75
75
-
This workflow is demonstrated in our samples in detail.
76
+
This workflow is demonstrated in the [samples](#samples).
76
77
77
78
## Remove an enrollment entry
78
79
79
80
***Individual enrollment** can be deleted by calling Service SDK API ```deleteIndividualEnrollment``` using ```registrationId```.
80
81
***Group enrollment** can be deleted by calling Service SDK API ```deleteEnrollmentGroup``` using ```enrollmentGroupId```.
81
82
82
-
This workflow is demonstrated in our samples in detail.
83
+
This workflow is demonstrated in the [samples](#samples).
83
84
84
85
## Bulk operation on individual enrollments
85
86
@@ -90,4 +91,4 @@ You can perform bulk operation to create, update, or remove multiple individual
90
91
91
92
After you have successfully performed an operation, the Device Provisioning Service would return a bulk operation result.
92
93
93
-
This workflow is demonstrated in our samples in detail.
94
+
This workflow is demonstrated in the [samples](#samples).
Copy file name to clipboardexpand all lines: articles/iot-dps/how-to-manage-enrollments.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -27,9 +27,9 @@ There are two ways you can enroll your devices with the provisioning service:
27
27
28
28
* An **Enrollment group** is an entry for a group of devices that share a common attestation mechanism of X.509 certificates, signed by the same signing certificate, which can be the [root certificate](https://docs.microsoft.com/en-us/azure/iot-dps/concepts-security#root-certificate) or the [intermediate certificate](https://docs.microsoft.com/en-us/azure/iot-dps/concepts-security#intermediate-certificate), used to produce device certificate on physical device. We recommend using an enrollment group for a large number of devices which share a desired initial configuration, or for devices all going to the same tenant. Note that you can only enroll devices that use the X.509 attestation mechanism as *enrollment groups*.
29
29
30
-
You can create an enrollment group in the portal for a group of devices using the following steps.
30
+
You can create an enrollment group in the portal for a group of devices using the following steps:
31
31
32
-
1. Log in to the Azure portal and click **All resources** from the lefthand menu.
32
+
1. Log in to the Azure portal and click **All resources** from the left-hand menu.
33
33
2. Click the Device Provisioning service you want to enroll your device to from the list of resources.
34
34
3. In your provisioning service, click **Manage enrollments**, then select **Enrollment Groups** tab.
35
35
4. Click the **Add** button at the top, and enter the information required for the enrollment list entry. Upload the root certificate for the group of devices.
@@ -40,9 +40,9 @@ There are two ways you can enroll your devices with the provisioning service:
40
40
41
41
* An **Individual enrollment** is an entry for a single device that may register. Individual enrollments may use either x509 certificates or SAS tokens (in a real or virtual TPM) as attestation mechanisms. We recommend using individual enrollments for devices which require unique initial configurations, or for devices which can only use SAS tokens via TPM or virtual TPM as the attestation mechanism. Individual enrollments may have the desired IoT hub device ID specified.
42
42
43
-
You can create an individual enrollment in the portal using the following steps.
43
+
You can create an individual enrollment in the portal using the following steps:
44
44
45
-
1. Log in to the Azure portal and click **All resources** from the lefthand menu.
45
+
1. Log in to the Azure portal and click **All resources** from the left-hand menu.
46
46
2. Click the Device Provisioning service you want to enroll your device to from the list of resources.
47
47
3. In your provisioning service, click **Manage enrollments**, then select **Individual Enrollments** tab.
48
48
4. Click the **Add** button at the top.
@@ -53,7 +53,7 @@ There are two ways you can enroll your devices with the provisioning service:
53
53
54
54
55
55
## Update an enrollment entry
56
-
You can update an existing enrollment entry in the portal using the following steps.
56
+
You can update an existing enrollment entry in the portal using the following steps:
57
57
58
58
1. Open your Device Provisioning service in the Azure portal and click **Manage Enrollments**.
59
59
2. Navigate to the enrollment entry you want to modify. Click the entry, which opens a summary information about your device enrollment.
@@ -64,7 +64,7 @@ You can update an existing enrollment entry in the portal using the following st
64
64
65
65
66
66
## Remove a device enrollment
67
-
In cases where your device(s) do not need to be provisioned to any IoT hub, you can remove the related enrollment entry in the portal using the following steps.
67
+
In cases where your device(s) do not need to be provisioned to any IoT hub, you can remove the related enrollment entry in the portal using the following steps:
68
68
69
69
1. Open your Device Provisioning service in the Azure portal and click **Manage Enrollments**.
70
70
2. Navigate to and select the enrollment entry you want to remove.
0 commit comments