|
1 | 1 | ---
|
2 | 2 | title: Azure IoT Hub MQTT 5 support (preview)
|
3 |
| - description: Learn about IoT Hub's MQTT 5 support |
| 3 | + description: Learn about MQTT 5 support in IoT Hub |
4 | 4 | services: iot
|
5 | 5 | ms.service: iot
|
6 | 6 | author: kgremban
|
|
9 | 9 | ms.date: 04/24/2023
|
10 | 10 | ---
|
11 | 11 |
|
12 |
| -# IoT Hub MQTT 5 support overview (preview) |
| 12 | +# IoT Hub MQTT 5 support (preview) |
13 | 13 |
|
14 | 14 | **Version:** 2.0
|
15 | 15 | **api-version:** 2020-10-01-preview
|
16 | 16 |
|
17 |
| -This document defines IoT Hub data plane API over MQTT version 5.0 protocol. See [API Reference](iot-hub-mqtt-5-reference.md) for complete definitions in this API. |
| 17 | +This document defines IoT Hub data plane API over MQTT version 5.0 protocol. See [API Reference](iot-mqtt-5-preview-reference.md) for complete definitions in this API. |
18 | 18 |
|
19 | 19 | ## Prerequisites
|
20 | 20 |
|
21 |
| -- [Enable preview mode](iot-hub-preview-mode.md) on a brand new IoT hub to try MQTT 5. |
| 21 | +- [Enable preview mode](../iot-hub/iot-hub-preview-mode.md) on a brand new IoT hub to try MQTT 5. |
22 | 22 | - Prior knowledge of [MQTT 5 specification](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html) is required.
|
23 | 23 |
|
24 | 24 | ## Level of support and limitations
|
25 | 25 |
|
26 | 26 | IoT Hub support for MQTT 5 is in preview and limited in following ways (communicated to client via `CONNACK` properties unless explicitly noted otherwise):
|
27 | 27 |
|
28 |
| -- No official [Azure IoT Hub device SDK](iot-hub-devguide-sdks.md) support yet. |
| 28 | +- No official [Azure IoT device SDKs](iot-sdks.md) support yet. |
29 | 29 | - Subscription identifiers aren't supported.
|
30 | 30 | - Shared subscriptions aren't supported.
|
31 | 31 | - `RETAIN` isn't supported.
|
@@ -107,7 +107,7 @@ Username/password authentication used in previous API versions isn't supported.
|
107 | 107 |
|
108 | 108 | #### SAS
|
109 | 109 |
|
110 |
| -With SAS-based authentication, a client must provide the signature of the connection context. The signature proves authenticity of the MQTT connection. The signature must be based on one of two authentication keys in the client's configuration in IoT Hub. Or it must be based on one of two shared access keys of a [Shared access policy](iot-hub-dev-guide-sas.md). |
| 110 | +With SAS-based authentication, a client must provide the signature of the connection context. The signature proves authenticity of the MQTT connection. The signature must be based on one of two authentication keys in the client's configuration in IoT Hub. Or it must be based on one of two shared access keys of a [shared access policy](../iot-hub/iot-hub-dev-guide-sas.md). |
111 | 111 |
|
112 | 112 | String to sign must be formed as follows:
|
113 | 113 |
|
@@ -184,7 +184,7 @@ All functionalities in this API are expressed as operations. Here's an example o
|
184 | 184 | Reason_Code: 0
|
185 | 185 | ```
|
186 | 186 |
|
187 |
| -For complete specification of operations in this API, see [API Reference](iot-hub-mqtt-5-reference.md). |
| 187 | +For complete specification of operations in this API, see [IoT Hub data plane MQTT 5 API reference](iot-mqtt-5-preview-reference.md). |
188 | 188 |
|
189 | 189 | > [!NOTE]
|
190 | 190 | > All the samples in this specification are shown from client's perspective. Sign `->` means client sending packet, `<-` - receiving.
|
@@ -409,7 +409,7 @@ There's no special format to send a batch of messages. To reduce overhead of res
|
409 | 409 |
|
410 | 410 | ## Migration
|
411 | 411 |
|
412 |
| -This section lists the changes in the API compared to [previous MQTT API](iot-hub-mqtt-support.md). |
| 412 | +This section lists the changes in the API compared to [previous MQTT support](iot-mqtt-connect-to-iot-hub.md). |
413 | 413 |
|
414 | 414 | - Transport protocol is MQTT 5. Previously - MQTT 3.1.1.
|
415 | 415 | - Context information for SAS Authentication is contained in `CONNECT` packet directly instead of being encoded along with signature.
|
@@ -580,5 +580,5 @@ Response:
|
580 | 580 | ```
|
581 | 581 | ## Next steps
|
582 | 582 |
|
583 |
| -- To review the MQTT 5 preview API reference, see [IoT Hub data plane MQTT 5 API reference](iot-hub-mqtt-5-reference.md). |
| 583 | +- To review the MQTT 5 preview API reference, see [IoT Hub data plane MQTT 5 API reference (preview)](iot-mqtt-5-preview-reference.md). |
584 | 584 | - To follow a C# sample, see [GitHub sample repository](https://github.com/Azure-Samples/iot-hub-mqtt-5-preview-samples-csharp).
|
0 commit comments