Skip to content

Commit 7613229

Browse files
v-regandownerv-regandowner
authored
Merge pull request #235620 from timlt/mqttwork
Consolidate mqtt
2 parents e48b621 + cecb258 commit 7613229

11 files changed

+154
-121
lines changed

‎articles/iot-dps/.openpublishing.redirection.iot-dps.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,11 @@
174174
"source_path_from_root": "/articles/iot-dps/tutorial-provision-multiple-hubs.md",
175175
"redirect_url": "/azure/iot-dps/how-to-use-allocation-policies",
176176
"redirect_document_id": false
177+
},
178+
{
179+
"source_path_from_root": "/articles/iot-dps/iot-dps-mqtt-support.md",
180+
"redirect_url": "/azure/iot/iot-mqtt-connect-to-iot-dps",
181+
"redirect_document_id": false
177182
}
178183
]
179184
}

‎articles/iot-dps/toc.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,12 @@ items:
8484
href: iot-dps-ha-dr.md
8585
- name: Understanding DPS IP addresses
8686
href: iot-dps-understand-ip-address.md
87-
- name: TLS support
88-
href: tls-support.md
87+
- name: Protocols
88+
items:
89+
- name: MQTT support
90+
href: ../iot/iot-mqtt-connect-to-iot-dps.md?toc=/azure/iot-dps/toc.json&bc=/azure/iot-dps/breadcrumb/toc.json
91+
- name: TLS support
92+
href: tls-support.md
8993
- name: Security practices for device manufacturers
9094
href: concepts-device-oem-security-practices.md
9195
- name: How-to guides
@@ -98,8 +102,6 @@ items:
98102
href: quick-enroll-device-x509.md
99103
- name: Create a TPM individual enrollment with DPS service SDK
100104
href: quick-enroll-device-tpm.md
101-
- name: Communicate with your DPS using MQTT protocol
102-
href: iot-dps-mqtt-support.md
103105
- name: Provision devices using HTTPS protocol
104106
items:
105107
- name: Use HTTPS protocol with symmetric keys

‎articles/iot-hub/.openpublishing.redirection.iot-hub.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1317,6 +1317,21 @@
13171317
"source_path_from_root": "/articles/iot-hub/quickstart-control-device-android.md",
13181318
"redirect_url": "/azure/iot-develop/about-iot-sdks",
13191319
"redirect_document_id": false
1320+
},
1321+
{
1322+
"source_path_from_root": "/articles/iot-hub/iot-hub-mqtt-5-reference.md",
1323+
"redirect_url": "/azure/iot/iot-mqtt-5-preview-reference",
1324+
"redirect_document_id": true
1325+
},
1326+
{
1327+
"source_path_from_root": "/articles/iot-hub/iot-hub-mqtt-5.md",
1328+
"redirect_url": "/azure/iot/iot-mqtt-5-preview",
1329+
"redirect_document_id": true
1330+
},
1331+
{
1332+
"source_path_from_root": "/articles/iot-hub/iot-hub-mqtt-support.md",
1333+
"redirect_url": "/azure/iot/iot-mqtt-connect-to-iot-hub",
1334+
"redirect_document_id": true
13201335
}
13211336
]
13221337
}

‎articles/iot-hub/TOC.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -186,13 +186,7 @@
186186
- name: Protocol support
187187
items:
188188
- name: MQTT support
189-
href: iot-hub-mqtt-support.md
190-
- name: MQTT 5 support (preview)
191-
items:
192-
- name: MQTT 5 overview
193-
href: iot-hub-mqtt-5.md
194-
- name: MQTT 5 API reference
195-
href: iot-hub-mqtt-5-reference.md
189+
href: ../iot/iot-mqtt-connect-to-iot-hub.md?toc=/azure/iot-hub/toc.json&bc=/azure/iot-hub/breadcrumb/toc.json
196190
- name: AMQP support
197191
href: iot-hub-amqp-support.md
198192
- name: Supporting additional protocols

‎articles/iot-hub/iot-hub-preview-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,6 @@ Do *not* use an IoT hub in preview mode for production. Preview mode is intended
7070
7171
## Next steps
7272

73-
- To preview the MQTT 5 support, see [IoT Hub MQTT 5 support overview (preview)](iot-hub-mqtt-5.md)
73+
- To preview the MQTT 5 support, see [IoT Hub MQTT 5 support overview (preview)](../iot/iot-mqtt-5-preview.md)
7474
- To preview the ECC server certificate, see [Elliptic Curve Cryptography (ECC) server TLS certificate (preview)](iot-hub-tls-support.md#elliptic-curve-cryptography-ecc-server-tls-certificate-preview)
7575
- To preview TLS fragment size negotiation, see [TLS maximum fragment length negotiation (preview)](iot-hub-tls-support.md#tls-maximum-fragment-length-negotiation-preview)

‎articles/iot-hub/iot-hub-mqtt-5-reference.md renamed to ‎articles/iot/iot-mqtt-5-preview-reference.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
title: Azure IoT Hub MQTT 5 API reference (preview)
3-
description: Learn about IoT Hub's MQTT 5 API reference
4-
services: iot-hub
3+
description: Learn about the IoT Hub MQTT 5 preview API
4+
services: iot
5+
ms.service: iot
56
author: kgremban
6-
ms.service: iot-hub
7-
ms.topic: reference
8-
ms.date: 11/19/2020
97
ms.author: kgremban
8+
ms.topic: reference
9+
ms.date: 04/24/2023
10+
1011
---
1112

12-
# IoT Hub data plane MQTT 5 API reference
13+
# IoT Hub data plane MQTT 5 API reference (preview)
1314

1415
This document defines operations available in version 2.0 (api-version: `2020-10-01-preview`) of IoT Hub data plane API.
1516

@@ -39,9 +40,9 @@ Get Twin state
3940

4041
| Status | Name | Description |
4142
| :----- | :--- | :---------- |
42-
| 0100 | Bad Request | Operation message is malformed and cannot be processed. |
43-
| 0101 | Not Authorized | Client is not authorized to perform the operation. |
44-
| 0102 | Not Allowed | Operation is not allowed. |
43+
| 0100 | Bad Request | Operation message is malformed and can't be processed. |
44+
| 0101 | Not Authorized | Client isn't authorized to perform the operation. |
45+
| 0102 | Not Allowed | Operation isn't allowed. |
4546
| 0501 | Throttled | request rate is too high per SKU |
4647
| 0502 | Quota Exceeded | daily quota per current SKU is exceeded |
4748
| 0601 | Server Error | internal server error |
@@ -91,10 +92,10 @@ Patch Twin's reported state
9192

9293
| Status | Name | Description |
9394
| :----- | :--- | :---------- |
94-
| 0104 | Precondition Failed | precondition was not met resulting in request being canceled |
95-
| 0100 | Bad Request | Operation message is malformed and cannot be processed. |
96-
| 0101 | Not Authorized | Client is not authorized to perform the operation. |
97-
| 0102 | Not Allowed | Operation is not allowed. |
95+
| 0104 | Precondition Failed | precondition wasn't met resulting in request being canceled |
96+
| 0100 | Bad Request | Operation message is malformed and can't be processed. |
97+
| 0101 | Not Authorized | Client isn't authorized to perform the operation. |
98+
| 0102 | Not Allowed | Operation isn't allowed. |
9899
| 0501 | Throttled | request rate is too high per SKU |
99100
| 0502 | Quota Exceeded | daily quota per current SKU is exceeded |
100101
| 0601 | Server Error | internal server error |
@@ -152,8 +153,8 @@ Indicates command was accepted for handling by the client
152153

153154
| Reason Code | Status | Name | Description |
154155
| :---------- | :----- | :--- | :---------- |
155-
| 131 | 0603 | Abandon | Indicates command will not be processed at this time and should be redelivered in the future. |
156-
| 131 | 0100 | Reject | Indicates command is rejected by the client and should not be attempted again. |
156+
| 131 | 0603 | Abandon | Indicates command won't be processed at this time and should be redelivered in the future. |
157+
| 131 | 0100 | Reject | Indicates the client rejected the command and it shouldn't be attempted again. |
157158

158159
#### Pseudo-code Sample
159160

@@ -199,7 +200,7 @@ Receive and handle Direct Method calls
199200

200201
| Status | Name | Description |
201202
| :----- | :--- | :---------- |
202-
| 06A0 | Unavailable | Indicates that client is not reachable through this connection. |
203+
| 06A0 | Unavailable | Indicates that client isn't reachable through this connection. |
203204

204205
#### Pseudo-code Sample
205206

@@ -251,7 +252,7 @@ Receive updates to Twin's desired state
251252

252253
### Send Telemetry
253254

254-
Post message to telemetry channel - EventHubs by default or other endpoint via routing configuration.
255+
Post message to telemetry channel - Event Hubs by default or other endpoint via routing configuration.
255256

256257
#### Message
257258

@@ -286,9 +287,9 @@ Message has been successfully posted to telemetry channel
286287

287288
| Reason Code | Status | Name | Description |
288289
| :---------- | :----- | :--- | :---------- |
289-
| 131 | 0100 | Bad Request | Operation message is malformed and cannot be processed. |
290-
| 135 | 0101 | Not Authorized | Client is not authorized to perform the operation. |
291-
| 131 | 0102 | Not Allowed | Operation is not allowed. |
290+
| 131 | 0100 | Bad Request | Operation message is malformed and can't be processed. |
291+
| 135 | 0101 | Not Authorized | Client isn't authorized to perform the operation. |
292+
| 131 | 0102 | Not Allowed | Operation isn't allowed. |
292293
| 131 | 0601 | Server Error | internal server error |
293294
| 151 | 0501 | Throttled | request rate is too high per SKU |
294295
| 151 | 0502 | Quota Exceeded | daily quota per current SKU is exceeded |
@@ -316,7 +317,7 @@ Message has been successfully posted to telemetry channel
316317

317318
### Bad Request
318319

319-
Operation message is malformed and cannot be processed.
320+
Operation message is malformed and can't be processed.
320321

321322
**Reason Code:** `131`
322323

@@ -326,7 +327,7 @@ Operation message is malformed and cannot be processed.
326327

327328
| Name | Type | Required | Description |
328329
| :--- | :--- | :------- | :---------- |
329-
| reason | string | no | contains information on what specifically is not valid about the message |
330+
| reason | string | no | contains information on what specifically isn't valid about the message |
330331

331332
**Payload**: empty
332333

@@ -342,14 +343,14 @@ Operation is in conflict with another ongoing operation.
342343

343344
| Name | Type | Required | Description |
344345
| :--- | :--- | :------- | :---------- |
345-
| trace-id | string | no | trace ID for correlation with additional diagnostics for the error |
346-
| reason | string | no | contains information on what specifically is not valid about the message |
346+
| trace-id | string | no | trace ID for correlation with other diagnostics for the error |
347+
| reason | string | no | contains information on what specifically isn't valid about the message |
347348

348349
**Payload**: empty
349350

350351
### Not Allowed
351352

352-
Operation is not allowed.
353+
Operation isn't allowed.
353354

354355
**Reason Code:** `131`
355356

@@ -359,13 +360,13 @@ Operation is not allowed.
359360

360361
| Name | Type | Required | Description |
361362
| :--- | :--- | :------- | :---------- |
362-
| reason | string | no | contains information on what specifically is not valid about the message |
363+
| reason | string | no | contains information on what specifically isn't valid about the message |
363364

364365
**Payload**: empty
365366

366367
### Not Authorized
367368

368-
Client is not authorized to perform the operation.
369+
Client isn't authorized to perform the operation.
369370

370371
**Reason Code:** `135`
371372

@@ -375,13 +376,13 @@ Client is not authorized to perform the operation.
375376

376377
| Name | Type | Required | Description |
377378
| :--- | :--- | :------- | :---------- |
378-
| trace-id | string | no | trace ID for correlation with additional diagnostics for the error |
379+
| trace-id | string | no | trace ID for correlation with other diagnostics for the error |
379380

380381
**Payload**: empty
381382

382383
### Not Found
383384

384-
requested resource does not exist
385+
requested resource doesn't exist
385386

386387
**Reason Code:** `131`
387388

@@ -391,13 +392,13 @@ requested resource does not exist
391392

392393
| Name | Type | Required | Description |
393394
| :--- | :--- | :------- | :---------- |
394-
| reason | string | no | contains information on what specifically is not valid about the message |
395+
| reason | string | no | contains information on what specifically isn't valid about the message |
395396

396397
**Payload**: empty
397398

398399
### Not Modified
399400

400-
Resource was not modified based on provided precondition.
401+
Resource wasn't modified based on provided precondition.
401402

402403
**Reason Code:** `0`
403404

@@ -410,7 +411,7 @@ Resource was not modified based on provided precondition.
410411

411412
### Precondition Failed
412413

413-
Precondition was not met resulting in request being canceled
414+
Precondition wasn't met resulting in request being canceled
414415

415416
**Reason Code:** `131`
416417

@@ -446,7 +447,7 @@ resource has no capacity to complete the operation
446447

447448
| Name | Type | Required | Description |
448449
| :--- | :--- | :------- | :---------- |
449-
| reason | string | no | contains information on what specifically is not valid about the message |
450+
| reason | string | no | contains information on what specifically isn't valid about the message |
450451

451452
**Payload**: empty
452453

@@ -462,7 +463,7 @@ server busy
462463

463464
| Name | Type | Required | Description |
464465
| :--- | :--- | :------- | :---------- |
465-
| trace-id | string | no | trace ID for correlation with additional diagnostics for the error |
466+
| trace-id | string | no | trace ID for correlation with other diagnostics for the error |
466467

467468
**Payload**: empty
468469

@@ -478,7 +479,7 @@ internal server error
478479

479480
| Name | Type | Required | Description |
480481
| :--- | :--- | :------- | :---------- |
481-
| trace-id | string | no | trace ID for correlation with additional diagnostics for the error |
482+
| trace-id | string | no | trace ID for correlation with other diagnostics for the error |
482483

483484
**Payload**: empty
484485

@@ -494,7 +495,7 @@ Target responded but the response was invalid or malformed
494495

495496
| Name | Type | Required | Description |
496497
| :--- | :--- | :------- | :---------- |
497-
| reason | string | no | contains information on what specifically is not valid about the message |
498+
| reason | string | no | contains information on what specifically isn't valid about the message |
498499

499500
**Payload**: empty
500501

@@ -510,8 +511,8 @@ timed out waiting for target to complete the request
510511

511512
| Name | Type | Required | Description |
512513
| :--- | :--- | :------- | :---------- |
513-
| trace-id | string | no | trace ID for correlation with additional diagnostics for the error |
514-
| reason | string | no | contains information on what specifically is not valid about the message |
514+
| trace-id | string | no | trace ID for correlation with other diagnostics for the error |
515+
| reason | string | no | contains information on what specifically isn't valid about the message |
515516

516517
**Payload**: empty
517518

@@ -553,7 +554,7 @@ operation timed out before it could be completed
553554

554555
| Name | Type | Required | Description |
555556
| :--- | :--- | :------- | :---------- |
556-
| trace-id | string | no | trace ID for correlation with additional diagnostics for the error |
557+
| trace-id | string | no | trace ID for correlation with other diagnostics for the error |
557558

558559
**Payload**: empty
559560

0 commit comments

Comments
 (0)