Skip to content

Commit c4a2c73

Browse files
Clarify WebSocket connection mapping and limitations
Clarified that client to backend connections consist of one-to-one mappings and emphasized that WebSocket sessions cannot be distributed across multiple backends.
1 parent bc2ab1f commit c4a2c73

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

articles/api-management/websocket-api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ During the WebSocket passthrough, the client application establishes a WebSocket
5353
1. When either side disconnects, API Management terminates the corresponding connection.
5454

5555
> [!NOTE]
56-
> The client-side and backend-side connections consist of one-to-one mapping.
56+
> Client to backend connections consist of one-to-one mappings. The same WebSocket session cannot be distributed across multiple backends.
5757
5858
## onHandshake operation
5959

@@ -120,6 +120,7 @@ The following are the current restrictions of WebSocket support in API Managemen
120120
* WebSocket APIs support the following valid buffer types for messages: Close, BinaryFragment, BinaryMessage, UTF8Fragment, and UTF8Message.
121121
* Currently, the [set-header](set-header-policy.md) policy doesn't support changing certain well-known headers, including `Host` headers, in onHandshake requests.
122122
* During the TLS handshake with a WebSocket backend, API Management validates that the server certificate is trusted and that its subject name matches the hostname. With HTTP APIs, API Management validates that the certificate is trusted but doesn’t validate that hostname and subject match.
123+
* WebSocket sessions cannot be distributed or load-balanced across multiple backends as, once connected, a session is maintained one-to-one between client and backend.
123124

124125
For WebSocket connection limits, see [API Management limits](../azure-resource-manager/management/azure-subscription-service-limits.md#azure-api-management-limits).
125126

0 commit comments

Comments
 (0)