Skip to content

Commit 816c3a0

Browse files
kgrembankgremban
committed
Enrollments includes
1 parent 7e14b12 commit 816c3a0

File tree

4 files changed

+204
-0
lines changed

4 files changed

+204
-0
lines changed

‎includes/iot-dps-enrollment-group-x509

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
author: kgremban
3+
ms.service: iot-dps
4+
ms.topic: include
5+
ms.date: 03/09/2023
6+
ms.author: kgremban
7+
---
8+
9+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Device Provisioning Service instance.
10+
11+
1. Select **Manage enrollments** from the **Settings** section of the navigation menu.
12+
13+
1. At the top of the page, select **Add enrollment group**.
14+
15+
1. On the **Registration + provisioning** tab of the **Add enrollment group** page, provide the following information to configure the enrollment group details:
16+
17+
| Field | Description |
18+
| :--- | :--- |
19+
| **Attestation** |Select **X.509 intermediate certificates** as the **Attestation mechanism** if you want to upload intermediate certificates to be used for just this enrollment group, or select **X.509 certificates uploaded to this Device Provisioning Service** if you already have uploaded intermediate certificates.|
20+
| **X.509 certificate settings** |Depending on the attestation method that you chose, either upload or select the primary and secondary intermediate certificates for this enrollment group. |
21+
| **Group name** | Provide a name for the group of devices. The enrollment group name is a case-insensitive string (up to 128 characters long) of alphanumeric characters plus the special characters: `'-'`, `'.'`, `'_'`, `':'`. The last character must be alphanumeric or dash (`'-'`).|
22+
| **Provisioning status** | Check the **Enable this enrollment** box if you want this enrollment group to be available to provision devices. Uncheck this box if you want the group to be disabled. You can change this setting later. |
23+
| **Reprovision policy** | Choose a reprovision policy that reflects how you want DPS to handle devices that request reprovisioning. For more information, see [Reprovision policies](../articles/iot-dps/concepts-device-reprovision.md#reprovision-policies) |
24+
25+
:::image type="content" source="../articles/iot-dps/media/how-to-manage-enrollments/add-enrollment-group-cert.png" alt-text="Screenshot that shows adding an enrollment group for X.509 certificate attestation.":::
26+
27+
1. Select **Next: IoT hubs**.
28+
29+
1. On the **IoT hubs** tab of the **Add enrollment group** page, provide the following information to determine which IoT hubs the enrollment group can provision devices to:
30+
31+
| Field | Description |
32+
| :---- | :---------- |
33+
| **Target IoT hubs** |Select one or more of your linked IoT hubs, or add a new link to an IoT hub. To learn more about linking IoT hubs to your DPS instance, see [How to link and manage IoT hubs](../articles/iot-dps/how-to-manage-linked-iot-hubs.md).|
34+
| **Allocation policy** | If you selected more than one linked IoT hub, select how you want to assign devices to the different hubs. To learn more about allocation policies, see [How to use allocation policies](../articles/iot-dps/how-to-use-allocation-policies.md).<br><br>If you selected only one linked IoT hub, we recommend using the **Evenly weighted distribution** policy.|
35+
36+
:::image type="content" source="../articles/iot-dps/media/how-to-manage-enrollments/add-enrollment-group-key-linked-hub.png" alt-text="Screenshot that shows connecting IoT hubs to the new enrollment group.":::
37+
38+
1. Select **Next: Device settings**
39+
40+
1. On the **Device settings** tab of the **Add enrollment group** page, provide the following information to define how newly provisioned devices will be configured:
41+
42+
| Field | Description |
43+
| :---- | :---------- |
44+
| **IoT Edge** | Check the **Enable IoT Edge on provisioned devices** if all the devices provisioned through this group will run [Azure IoT Edge](../articles/iot-edge/about-iot-edge.md). Uncheck this box if this group is for non-IoT Edge-enabled devices only. Either all devices in a group will be IoT Edge-enabled or none can be. |
45+
| **Device tags** | Use this text box to provide any tags that you want to apply to the device twins of provisioned devices. |
46+
| **Desired properties** | Use this text box to provide any desired properties that you want to apply to the device twins of provisioned devices. |
47+
48+
For more information, see [Understand and use device twins in IoT Hub](../articles/iot-hub/iot-hub-devguide-device-twins.md).
49+
50+
1. Select **Next: Review + create**.
51+
52+
1. On the **Review + create** tab, verify all of your values then select **Create**.

‎includes/iot-dps-individual-enrollment-key.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
author: kgremban
3+
ms.service: iot-dps
4+
ms.topic: include
5+
ms.date: 03/09/2023
6+
ms.author: kgremban
7+
---
8+
9+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Device Provisioning Service instance.
10+
11+
1. Select **Manage enrollments** from the **Settings** section of the navigation menu.
12+
13+
1. Select the **Individual enrollments** tab, then select **Add individual enrollment**.
14+
15+
:::image type="content" source="../articles/iot-dps/media/how-to-manage-enrollments/add-individual-enrollment.png" alt-text="Screenshot that shows the add individual enrollment option.":::
16+
17+
1. On the **Registration + provisioning** of the **Add enrollment** page, provide the following information to configure the enrollment details:
18+
19+
| Field | Description |
20+
| :--- | :--- |
21+
| **Attestation** | Select **Symmetric key** as the **Attestation mechanism**. |
22+
| **Symmetric key settings** | Check the **Generate symmetric keys automatically** box if you want to use randomly generated keys. Uncheck this box if you want to provide your own keys. |
23+
| **Registration ID** | Provide a unique registration ID for the device.|
24+
| **Provisioning status** | Check the **Enable this enrollment** box if you want this enrollment to be available to provision its device. Uncheck this box if you want the enrollment to be disabled. You can change this setting later. |
25+
| **Reprovision policy** | Choose a reprovision policy that reflects how you want DPS to handle devices that request reprovisioning. For more information, see [Reprovision policies](../articles/iot-dps/concepts-device-reprovision.md#reprovision-policies). |
26+
27+
1. Select **Next: IoT hubs**.
28+
29+
1. On the **IoT hubs** tab of the **Add enrollment** page, provide the following information to determine which IoT hubs the enrollment can provision devices to:
30+
31+
| Field | Description |
32+
| :---- | :---------- |
33+
| **Target IoT hubs** |Select one or more of your linked IoT hubs, or add a new link to an IoT hub. To learn more about linking IoT hubs to your DPS instance, see [How to link and manage IoT hubs](../articles/iot-dps/how-to-manage-linked-iot-hubs.md).|
34+
| **Allocation policy** | If you selected more than one linked IoT hub, select how you want to assign devices to the different hubs. To learn more about allocation policies, see [How to use allocation policies](../articles/iot-dps/how-to-use-allocation-policies.md).<br><br>If you selected only one linked IoT hub, we recommend using the **Evenly weighted distribution** policy.|
35+
36+
1. Select **Next: Device settings**
37+
38+
1. On the **Device settings** tab of the **Add enrollment** page, provide the following information to define how newly provisioned devices will be configured:
39+
40+
| Field | Description |
41+
| :---- | :---------- |
42+
| **Device ID** | Provide a device ID that will be assigned to the provisioned device in IoT Hub. If you don't provide a device ID, the registration ID will be used. |
43+
| **IoT Edge** | Check the **Enable IoT Edge on provisioned devices** if the provisioned device will run [Azure IoT Edge](../articles/iot-edge/about-iot-edge.md). Uncheck this box if this enrollment is for a non-IoT Edge-enabled device. |
44+
| **Device tags** | Use this text box to provide any tags that you want to apply to the device twin of the provisioned device. |
45+
| **Desired properties** | Use this text box to provide any desired properties that you want to apply to the device twin of the provisioned device. |
46+
47+
For more information, see [Understand and use device twins in IoT Hub](../articles/iot-hub/iot-hub-devguide-device-twins.md).
48+
49+
1. Select **Next: Review + create**.
50+
51+
1. On the **Review + create** tab, verify all of your values then select **Create**.

‎includes/iot-dps-individual-enrollment-tpm.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
author: kgremban
3+
ms.service: iot-dps
4+
ms.topic: include
5+
ms.date: 03/09/2023
6+
ms.author: kgremban
7+
---
8+
9+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Device Provisioning Service instance.
10+
11+
1. Select **Manage enrollments** from the **Settings** section of the navigation menu.
12+
13+
1. Select the **Individual enrollments** tab, then select **Add individual enrollment**.
14+
15+
:::image type="content" source="../articles/iot-dps/media/how-to-manage-enrollments/add-individual-enrollment.png" alt-text="Screenshot that shows the add individual enrollment option.":::
16+
17+
1. On the **Registration + provisioning** of the **Add enrollment** page, provide the following information to configure the enrollment details:
18+
19+
| Field | Description |
20+
| :--- | :--- |
21+
| **Attestation** | Select **Trusted Platform Module (TPM)** as the **Attestation mechanism**. |
22+
| **Trusted Platform Module (TPM) settings** | Provide the endorsement key that will be used to verify the device for this enrollment. You can retrieve the endorsement key from your device's TPM.|
23+
| **Registration ID** | Provide the unique registration ID for the device. You can retrieve the registration ID from your device's TPM. |
24+
| **Provisioning status** | Check the **Enable this enrollment** box if you want this enrollment to be available to provision its device. Uncheck this box if you want the enrollment to be disabled. You can change this setting later. |
25+
| **Reprovision policy** | Choose a reprovision policy that reflects how you want DPS to handle devices that request reprovisioning. For more information, see [Reprovision policies](../articles/iot-dps/concepts-device-reprovision.md#reprovision-policies). |
26+
27+
1. Select **Next: IoT hubs**.
28+
29+
1. On the **IoT hubs** tab of the **Add enrollment** page, provide the following information to determine which IoT hubs the enrollment can provision devices to:
30+
31+
| Field | Description |
32+
| :---- | :---------- |
33+
| **Target IoT hubs** |Select one or more of your linked IoT hubs, or add a new link to an IoT hub. To learn more about linking IoT hubs to your DPS instance, see [How to link and manage IoT hubs](../articles/iot-dps/how-to-manage-linked-iot-hubs.md).|
34+
| **Allocation policy** | If you selected more than one linked IoT hub, select how you want to assign devices to the different hubs. To learn more about allocation policies, see [How to use allocation policies](../articles/iot-dps/how-to-use-allocation-policies.md).<br><br>If you selected only one linked IoT hub, we recommend using the **Evenly weighted distribution** policy.|
35+
36+
1. Select **Next: Device settings**
37+
38+
1. On the **Device settings** tab of the **Add enrollment** page, provide the following information to define how newly provisioned devices will be configured:
39+
40+
| Field | Description |
41+
| :---- | :---------- |
42+
| **Device ID** | Provide a device ID that will be assigned to the provisioned device in IoT Hub. If you don't provide a device ID, the registration ID will be used. |
43+
| **IoT Edge** | Check the **Enable IoT Edge on provisioned devices** if the provisioned device will run [Azure IoT Edge](../articles/iot-edge/about-iot-edge.md). Uncheck this box if this enrollment is for a non-IoT Edge-enabled device. |
44+
| **Device tags** | Use this text box to provide any tags that you want to apply to the device twin of the provisioned device. |
45+
| **Desired properties** | Use this text box to provide any desired properties that you want to apply to the device twin of the provisioned device. |
46+
47+
For more information, see [Understand and use device twins in IoT Hub](../articles/iot-hub/iot-hub-devguide-device-twins.md).
48+
49+
1. Select **Next: Review + create**.
50+
51+
1. On the **Review + create** tab, verify all of your values then select **Create**.

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
author: kgremban
3+
ms.service: iot-dps
4+
ms.topic: include
5+
ms.date: 03/09/2023
6+
ms.author: kgremban
7+
---
8+
9+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Device Provisioning Service instance.
10+
11+
1. Select **Manage enrollments** from the **Settings** section of the navigation menu.
12+
13+
1. Select the **Individual enrollments** tab, then select **Add individual enrollment**.
14+
15+
:::image type="content" source="../articles/iot-dps/media/how-to-manage-enrollments/add-individual-enrollment.png" alt-text="Screenshot that shows the add individual enrollment option.":::
16+
17+
1. On the **Registration + provisioning** of the **Add enrollment** page, provide the following information to configure the enrollment details:
18+
19+
| Field | Description |
20+
| :--- | :--- |
21+
| **Attestation** | Select **X.509 client certificates** as the **Attestation mechanism**. |
22+
| **X.509 certificate settings** | Upload one or two certificates that will be used to verify the device for this enrollment. |
23+
| **Provisioning status** | Check the **Enable this enrollment** box if you want this enrollment to be available to provision its device. Uncheck this box if you want the enrollment to be disabled. You can change this setting later. |
24+
| **Reprovision policy** | Choose a reprovision policy that reflects how you want DPS to handle devices that request reprovisioning. For more information, see [Reprovision policies](../articles/iot-dps/concepts-device-reprovision.md#reprovision-policies). |
25+
26+
1. Select **Next: IoT hubs**.
27+
28+
1. On the **IoT hubs** tab of the **Add enrollment** page, provide the following information to determine which IoT hubs the enrollment can provision devices to:
29+
30+
| Field | Description |
31+
| :---- | :---------- |
32+
| **Target IoT hubs** |Select one or more of your linked IoT hubs, or add a new link to an IoT hub. To learn more about linking IoT hubs to your DPS instance, see [How to link and manage IoT hubs](how-to-manage-linked-iot-hubs.md).|
33+
| **Allocation policy** | If you selected more than one linked IoT hub, select how you want to assign devices to the different hubs. To learn more about allocation policies, see [How to use allocation policies](how-to-use-allocation-policies.md).<br><br>If you selected only one linked IoT hub, we recommend using the **Evenly weighted distribution** policy.|
34+
35+
1. Select **Next: Device settings**
36+
37+
1. On the **Device settings** tab of the **Add enrollment** page, provide the following information to define how newly provisioned devices will be configured:
38+
39+
| Field | Description |
40+
| :---- | :---------- |
41+
| **Device ID** | Provide a device ID that will be assigned to the provisioned device in IoT Hub. If you don't provide a device ID, the registration ID will be used. |
42+
| **IoT Edge** | Check the **Enable IoT Edge on provisioned devices** if the provisioned device will run [Azure IoT Edge](../articles/iot-edge/about-iot-edge.md). Uncheck this box if this enrollment is for a non-IoT Edge-enabled device. |
43+
| **Device tags** | Use this text box to provide any tags that you want to apply to the device twin of the provisioned device. |
44+
| **Desired properties** | Use this text box to provide any desired properties that you want to apply to the device twin of the provisioned device. |
45+
46+
For more information, see [Understand and use device twins in IoT Hub](../articles/iot-hub/iot-hub-devguide-device-twins.md).
47+
48+
1. Select **Next: Review + create**.
49+
50+
1. On the **Review + create** tab, verify all of your values then select **Create**.

0 commit comments

Comments
 (0)