Skip to content

Commit 7a200ad

Browse files
committed
Update inline links to other docs
1 parent bcde129 commit 7a200ad

File tree

4 files changed

+37
-37
lines changed

4 files changed

+37
-37
lines changed

articles/iot/iot-mqtt-5-preview-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure IoT Hub MQTT 5 API reference (preview)
3-
description: Learn about IoT Hub's MQTT 5 API reference
3+
description: Learn about the IoT Hub MQTT 5 preview API
44
services: iot
55
ms.service: iot
66
author: kgremban
@@ -10,7 +10,7 @@
1010

1111
---
1212

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

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

articles/iot/iot-mqtt-5-preview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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
44
services: iot
55
ms.service: iot
66
author: kgremban
@@ -9,23 +9,23 @@
99
ms.date: 04/24/2023
1010
---
1111

12-
# IoT Hub MQTT 5 support overview (preview)
12+
# IoT Hub MQTT 5 support (preview)
1313

1414
**Version:** 2.0
1515
**api-version:** 2020-10-01-preview
1616

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.
1818

1919
## Prerequisites
2020

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.
2222
- Prior knowledge of [MQTT 5 specification](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html) is required.
2323

2424
## Level of support and limitations
2525

2626
IoT Hub support for MQTT 5 is in preview and limited in following ways (communicated to client via `CONNACK` properties unless explicitly noted otherwise):
2727

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.
2929
- Subscription identifiers aren't supported.
3030
- Shared subscriptions aren't supported.
3131
- `RETAIN` isn't supported.
@@ -107,7 +107,7 @@ Username/password authentication used in previous API versions isn't supported.
107107

108108
#### SAS
109109

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).
111111

112112
String to sign must be formed as follows:
113113

@@ -184,7 +184,7 @@ All functionalities in this API are expressed as operations. Here's an example o
184184
Reason_Code: 0
185185
```
186186

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).
188188

189189
> [!NOTE]
190190
> 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
409409

410410
## Migration
411411

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).
413413

414414
- Transport protocol is MQTT 5. Previously - MQTT 3.1.1.
415415
- Context information for SAS Authentication is contained in `CONNECT` packet directly instead of being encoded along with signature.
@@ -580,5 +580,5 @@ Response:
580580
```
581581
## Next steps
582582
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).
584584
- To follow a C# sample, see [GitHub sample repository](https://github.com/Azure-Samples/iot-hub-mqtt-5-preview-samples-csharp).

articles/iot/iot-mqtt-connect-to-iot-dps.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.date: 04/24/2023
1010
ms.custom: [amqp, mqtt]
1111
---
1212

13-
# Communicate with your DPS using the MQTT protocol
13+
# Communicate with DPS using the MQTT protocol
1414

1515
DPS enables devices to communicate with the DPS device endpoint using:
1616

@@ -22,13 +22,13 @@ DPS isn't a full-featured MQTT broker and doesn't support all the behaviors spec
2222
All device communication with DPS must be secured using TLS/SSL. Therefore, DPS doesn't support nonsecure connections over port 1883.
2323

2424
> [!NOTE]
25-
> DPS does not currently support devices using TPM [attestation mechanism](./concepts-service.md#attestation-mechanism) over the MQTT protocol.
25+
> DPS does not currently support devices using TPM [attestation mechanism](../iot-dps/concepts-service.md#attestation-mechanism) over the MQTT protocol.
2626
2727
## Connecting to DPS
2828

2929
A device can use the MQTT protocol to connect to a DPS instance using any of the following options.
3030

31-
* Libraries in the [Azure IoT Provisioning SDKs](libraries-sdks.md).
31+
* Libraries in the [Azure IoT Provisioning SDKs](iot-sdks#dps-management-sdks).
3232
* The MQTT protocol directly.
3333

3434
## Using the MQTT protocol directly (as a device)
@@ -37,7 +37,7 @@ If a device can't use the device SDKs, it can still connect to the public device
3737

3838
* For the **ClientId** field, use **registrationId**.
3939

40-
* For the **Username** field, use `{idScope}/registrations/{registration_id}/api-version=2019-03-31`, where `{idScope}` is the [ID scope](./concepts-service.md#id-scope) of the DPS and `{registration_id}` is the [Registration ID](./concepts-service.md#registration-id) for your device.
40+
* For the **Username** field, use `{idScope}/registrations/{registration_id}/api-version=2019-03-31`, where `{idScope}` is the [ID scope](../iot-dps/concepts-service.md#id-scope) of the DPS and `{registration_id}` is the [Registration ID](../iot-dps/concepts-service.md#registration-id) for your device.
4141

4242
> [!NOTE]
4343
> If you use X.509 certificate authentication, the registration ID is provided by the subject common name (CN) of your device leaf (end-entity) certificate. `{registration_id}` in the **Username** field must match the common name.
@@ -50,7 +50,7 @@ If a device can't use the device SDKs, it can still connect to the public device
5050
> [!NOTE]
5151
> If you use X.509 certificate authentication, SAS token passwords are not required.
5252
53-
For more information about how to generate SAS tokens, see the security tokens section of [Control access to DPS](how-to-control-access.md#security-tokens).
53+
For more information about how to generate SAS tokens, see the security tokens section of [Control access to DPS](../iot-dps/how-to-control-access.md#security-tokens).
5454

5555
The following list contains DPS implementation-specific behaviors:
5656

0 commit comments

Comments
 (0)