Skip to content

Commit fbc371b

Browse files
committed
Update
1 parent 312b68b commit fbc371b

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

articles/azure-web-pubsub/overview-mqtt.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.date: 07/15/2024
88
ms.service: azure-web-pubsub
99
ms.topic: overview
1010
---
11-
# Overview: MQTT in Azure Web PubSub service
11+
# Overview: MQTT in Azure Web PubSub service (Preview)
1212

1313
[MQTT](https://mqtt.org/) is a lightweight pub/sub messaging protocol designed for devices with constrained resources. Azure Web PubSub service now natively supports MQTT over WebSocket transport.
1414

@@ -18,6 +18,9 @@ You can use MQTT protocols in Web PubSub service for the following scenarios:
1818
* Broadcast messages to MQTT clients.
1919
* Get notifications for MQTT client lifetime events.
2020

21+
> [!NOTE]
22+
> MQTT support in Azure Web PubSub is in preview stage.
23+
2124
## Key Features
2225

2326
### Standard MQTT Protocols Support
@@ -74,12 +77,12 @@ In general, a server to authenticate and authorize MQTT clients is required. The
7477

7578
* Workflow 1: The MQTT client gets a [JWT(JSON Web Token)](https://jwt.io) from somewhere with its credential, usually from an auth server. Then the client includes the token in the WebSocket upgrading request to the Web PubSub service, and the Web PubSub service validates the token and auth the client. This workflow is enabled by default.
7679

77-
![Diagram of MQTT Auth Workflow With JWT.](./media/howto-develop-mqtt-websocket-clients/mqtt-jwt-auth-workflow.png)
80+
![Diagram of MQTT Auth Workflow With JWT.](./media/howto-connect-mqtt-websocket-client/mqtt-jwt-auth-workflow.png)
7881

7982
* Workflow 2: The MQTT client sends an MQTT CONNECT packet after it establishes a WebSocket connection with the service, then the service calls an API in the upstream server. The upstream server can auth the client according to the username and password fields in the MQTT connection request, and the TLS certificate from the client. This workflow needs explicit configuration.
8083
<!--Add link to tutorial and configuration-->
8184

82-
![Diagram of MQTT Auth Workflow With Upstream Server.](./media/howto-develop-mqtt-websocket-clients/mqtt-upstream-auth-workflow.png)
85+
![Diagram of MQTT Auth Workflow With Upstream Server.](./media/howto-connect-mqtt-websocket-client/mqtt-upstream-auth-workflow.png)
8386

8487
These two workflows can be used individually or in combination. If they're used in together, the auth result in the latter workflow would be honored by the service.
8588

@@ -100,6 +103,11 @@ You can use REST API to do the following things:
100103

101104
[REST API specification for MQTT](./reference-rest-api-mqtt.md)
102105

106+
## Event Listener Support
107+
108+
> [!NOTE]
109+
> Sending MQTT client events to Event Hubs is not supported yet.
110+
103111
## Next step
104112

105113
> [!div class="nextstepaction"]

articles/azure-web-pubsub/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
href: howto-troubleshoot-common-issues.md
145145
- name: Move across regions
146146
href: howto-move-across-regions.md
147-
- name: MQTT
147+
- name: MQTT(Preview)
148148
expanded: false
149149
items:
150150
- name: Overview

0 commit comments

Comments
 (0)