Skip to content

Commit 555595b

Browse files
authored
Merge pull request #86967 from rezasherafat/twinimprovements_docupdate
Updated doc for twin nesting/key/value increase improvements.
2 parents d73a68e + af8142b commit 555595b

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

articles/iot-hub/iot-hub-devguide-device-twins.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,11 +240,11 @@ The [Azure IoT device SDKs](iot-hub-devguide-sdks.md) make it easy to use the pr
240240

241241
Tags, desired properties, and reported properties are JSON objects with the following restrictions:
242242

243-
* All keys in JSON objects are case-sensitive 64 bytes UTF-8 UNICODE strings. Allowed characters exclude UNICODE control characters (segments C0 and C1), and `.`, `$`, and SP.
243+
* All keys in JSON objects are UTF-8 encoded, case-sensitive, and up-to 1 KB in length. Allowed characters exclude UNICODE control characters (segments C0 and C1), and `.`, `$`, and SP.
244244

245245
* All values in JSON objects can be of the following JSON types: boolean, number, string, object. Arrays are not allowed. The maximum value for integers is 4503599627370495 and the minimum value for integers is -4503599627370496.
246246

247-
* All JSON objects in tags, desired, and reported properties can have a maximum depth of 5. For instance, the following object is valid:
247+
* All JSON objects in tags, desired, and reported properties can have a maximum depth of 10. For instance, the following object is valid:
248248

249249
```json
250250
{
@@ -255,7 +255,17 @@ Tags, desired properties, and reported properties are JSON objects with the foll
255255
"three": {
256256
"four": {
257257
"five": {
258-
"property": "value"
258+
"six": {
259+
"seven": {
260+
"eight": {
261+
"nine": {
262+
"ten": {
263+
"property": "value"
264+
}
265+
}
266+
}
267+
}
268+
}
259269
}
260270
}
261271
}
@@ -266,7 +276,7 @@ Tags, desired properties, and reported properties are JSON objects with the foll
266276
}
267277
```
268278

269-
* All string values can be at most 512 bytes in length.
279+
* All string values can be at most 4 KB in length.
270280

271281
## Device twin size
272282

articles/iot-hub/iot-hub-devguide-quotas-throttling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ IoT Hub enforces other operational limits:
101101
| Direct method<sup>1</sup> | Maximum direct method payload size is 128 KB. |
102102
| Automatic device configurations<sup>1</sup> | 100 configurations per paid SKU hub. 20 configurations per free SKU hub. |
103103
| IoT Edge automatic deployments<sup>1</sup> | 20 modules per deployment. 100 deployments per paid SKU hub. 10 deployments per free SKU hub. |
104-
| Twins<sup>1</sup> | Maximum size per twin section (tags, desired properties, reported properties) is 8 KB |
104+
| Twins<sup>1</sup> | Maximum size of desired properties and reported properties sections are 32 KB each. Maximum size of tags section is 8 KB. |
105105

106106
<sup>1</sup>This feature is not available in the basic tier of IoT Hub. For more information, see [How to choose the right IoT Hub](iot-hub-scaling.md).
107107

includes/iot-hub-limits.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@ The following table lists the limits that apply to IoT Hub resources.
3535
| Maximum cloud-to-device queue depth per device |50 |
3636
| Maximum delivery count for feedback messages <br/> in response to a cloud-to-device message |100 |
3737
| Maximum TTL for feedback messages in <br/> response to a cloud-to-device message |2 days |
38-
| [Maximum size of device twin](../articles/iot-hub/iot-hub-devguide-device-twins.md#device-twin-size) <br/> (tags, reported properties, and desired properties) | 8 KB |
39-
| Maximum size of device twin string value | 4 KB |
40-
| [Maximum depth of object in device twin](../articles/iot-hub/iot-hub-devguide-device-twins.md#tags-and-properties-format) | 5 |
38+
| [Maximum size of device twin](../articles/iot-hub/iot-hub-devguide-device-twins.md#device-twin-size) | 8 KB for tags section, and 32 KB for desired and reported properties sections each |
39+
| Maximum length of device twin string key | 1 KB |
40+
| Maximum length of device twin string value | 4 KB |
41+
| [Maximum depth of object in device twin](../articles/iot-hub/iot-hub-devguide-device-twins.md#tags-and-properties-format) | 10 |
4142
| Maximum size of direct method payload | 128 KB |
4243
| Job history maximum retention | 30 days |
4344
| Maximum concurrent jobs | 10 (for S3), 5 for (S2), 1 (for S1) |

0 commit comments

Comments
 (0)