Skip to content

Commit a0b5076

Browse files
authored
Merge pull request #134382 from dominicbetts/central-names
Update device name rules
2 parents c29a935 + 7248035 commit a0b5076

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

articles/iot-central/core/concepts-get-connected.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ If you have a security breach or your primary certificate is set to expire, use
106106

107107
### Register and connect devices
108108

109-
To bulk connect devices using X.509 certificates, first register the devices in your application by using a CSV file to [import the device IDs and device names](howto-manage-devices.md#import-devices). The device IDs should all be in lower case.
109+
To bulk connect devices using X.509 certificates, first register the devices in your application by using a CSV file to [import the device IDs and device names](howto-manage-devices.md#import-devices). A device ID can contain letters, numbers, and the `-` character.
110110

111111
Generate X.509 leaf certificates for your devices using the root or intermediate certificate you uploaded to your X.509 enrollment group. Use the **Device ID** as the `CNAME` value in the leaf certificates. Your device code needs the **ID scope** value for your application, the **device ID**, and the corresponding device certificate.
112112

@@ -142,7 +142,7 @@ The flow is slightly different depending on whether the devices use SAS tokens o
142142

143143
:::image type="content" source="media/concepts-get-connected/group-primary-key.png" alt-text="Group primary key from SAS-IoT-Devices enrollment group":::
144144

145-
1. Use the `az iot central device compute-device-key` command to generate the device SAS keys. Use the group primary key from the previous step. The device IDs must be lower-case:
145+
1. Use the `az iot central device compute-device-key` command to generate the device SAS keys. Use the group primary key from the previous step. The device ID can contain letters, numbers, and the `-` character:
146146

147147
```azurecli
148148
az iot central device compute-device-key --primary-key <enrollment group primary key> --device-id <device ID>
@@ -163,7 +163,7 @@ The flow is slightly different depending on whether the devices use SAS tokens o
163163
164164
1. [Create an enrollment group](#create-an-enrollment-group) and then [Add and verify a root or intermediate X.509 certificate](#add-and-verify-a-root-or-intermediate-x509-certificate) to your IoT Central application.
165165
166-
1. Generate the leaf-certificates for your devices using the root or intermediate certificate you added to your IoT Central application. Use lower-case device IDs as the `CNAME` in the leaf certificates.
166+
1. Generate the leaf-certificates for your devices using the root or intermediate certificate you added to your IoT Central application. Use the device IDs as the `CNAME` in the leaf certificates. A device ID can contain letters, numbers, and the `-` character.
167167
168168
1. The OEM flashes each device with a device ID, a generated leaf X.509 certificate, and the application **ID scope** value.
169169
@@ -178,7 +178,7 @@ The flow is slightly different depending on whether the devices use SAS tokens o
178178
179179
## Individual enrollment-based device connectivity
180180
181-
For customers connecting devices that each have their own authentication credentials, use individual enrollments. An individual enrollment is an entry for a single device that is allowed to connect. Individual enrollments can use either X.509 leaf certificates or SAS tokens (from a physical or virtual trusted platform module) as attestation mechanisms. The device ID (also known as registration ID) in an individual enrollment is alphanumeric, lowercase, and may contain hyphens. For more information, see [DPS individual enrollment](../../iot-dps/concepts-service.md#individual-enrollment).
181+
For customers connecting devices that each have their own authentication credentials, use individual enrollments. An individual enrollment is an entry for a single device that is allowed to connect. Individual enrollments can use either X.509 leaf certificates or SAS tokens (from a physical or virtual trusted platform module) as attestation mechanisms. The device ID (also known as registration ID) in an individual enrollment A device ID can contain letters, numbers, and the `-` character. For more information, see [DPS individual enrollment](../../iot-dps/concepts-service.md#individual-enrollment).
182182
183183
> [!NOTE]
184184
> When you create an individual enrollment for a device, it takes precedence over the default group enrollment options in your IoT Central application.

articles/iot-central/core/how-to-connect-devices-x509.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,16 @@ In this section, you use an X.509 certificate to connect a device with a cert de
4646
npm install
4747
```
4848
49-
1. Create a root certificate and then derive a device certificate by running the script. Be sure to only use lower-case alphanumerics and hyphens for certificate name:
49+
1. Create a root certificate and then derive a device certificate by running the script:
5050
5151
```cmd/sh
5252
node create_test_cert.js root mytestrootcert
5353
node create_test_cert.js device mytestdevice mytestrootcert
5454
```
5555
56+
> [!TIP]
57+
> A device ID can contain letters, numbers, and the `-` character.
58+
5659
These commands produce three files each for the root and the device certificate
5760
5861
filename | contents

articles/iot-central/core/howto-manage-devices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ To add a device to your Azure IoT Central application:
5555

5656
To connect large number of devices to your application, you can bulk import devices from a CSV file. The CSV file should have the following columns and headers:
5757

58-
* **IOTC_DeviceID** - the device ID should be all lowercase.
58+
* **IOTC_DeviceID** - the device ID can contain letters, numbers, and the `-` character.
5959
* **IOTC_DeviceName** - this column is optional.
6060

6161
To bulk-register devices in your application:

articles/iot-central/core/quick-create-simulated-device.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ To add a simulated device to your application, you use the **MXChip IoT DevKit**
125125

126126
1. To add a new device as an operator choose **Devices** in the left pane. The **Devices** tab shows **All devices** and the **MXChip IoT DevKit** device template. Select **MXChip IoT DevKit**.
127127

128-
1. To add a simulated DevKit device, select **+**. Use the suggested **Device ID** or enter your own lowercase **Device ID**. You can also enter a name for your new device. Make sure the **Simulated** toggle is **On** and then select **Create**.
128+
1. To add a simulated DevKit device, select **+**. Use the suggested **Device ID** or enter your own. A device ID can contain letters, numbers, and the `-` character. You can also enter a name for your new device. Make sure the **Simulated** toggle is **On** and then select **Create**.
129129

130130
![Simulated device](./media/quick-create-simulated-device/simulated-device.png)
131131

0 commit comments

Comments
 (0)