You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/websocket-api.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,18 +39,18 @@ API Management supports WebSocket passthrough.
39
39
40
40
:::image type="content" source="./media/websocket-api/websocket-api-passthrough.png" alt-text="Visual illustration of WebSocket passthrough flow":::
41
41
42
-
During the WebSocket passthrough the client application establishes a WebSocket connection with the API Management Gateway, which then establishes a connection with the corresponding backend services. API Management then proxies WebSocket client-server messages.
42
+
During the WebSocket passthrough, the client application establishes a WebSocket connection with the API Management gateway, which then establishes a connection with the corresponding backend services. API Management then proxies WebSocket client-server messages.
43
43
44
-
1. The client application sends a WebSocket handshake request to APIM gateway, invoking onHandshake operation.
45
-
1.APIM gateway sends WebSocket handshake request to the corresponding backend service.
44
+
1. The client application sends a WebSocket handshake request to the gateway, invoking the onHandshake operation
45
+
1.The API Management gateway sends WebSocket handshake requests to the corresponding backend service.
46
46
1. The backend service upgrades a connection to WebSocket.
47
-
1.APIM gateway upgrades the corresponding connection to WebSocket.
48
-
1.Once the connection pair is established, APIM will broker messages back and forth between the client application and backend service.
49
-
1. The client application sends message to APIM gateway.
50
-
1.APIM gateway forwards the message to the backend service.
51
-
1. The backend service sends a message to APIM gateway.
52
-
1.APIM gateway forwards the message to the client application.
53
-
1. When either side disconnects, APIM terminates the corresponding connection.
47
+
1.THe gateway upgrades the corresponding connection to WebSocket.
48
+
1.After the connection pair is established, API Management brokers messages back and forth between the client application and backend service.
49
+
1. The client application sends a message to the gateway.
50
+
1.The gateway forwards the message to the backend service.
51
+
1. The backend service sends a message to the gateway.
52
+
1.The gateway forwards the message to the client application.
53
+
1. When either side disconnects, API Management terminates the corresponding connection.
54
54
55
55
> [!NOTE]
56
56
> The client-side and backend-side connections consist of one-to-one mapping.
@@ -114,9 +114,9 @@ For example, the following screenshot shows recent WebSocket API responses with
114
114
115
115
## Limitations
116
116
117
-
Below are the current restrictions of WebSocket support in API Management:
117
+
The following are the current restrictions of WebSocket support in API Management:
118
118
119
-
* WebSocket APIs are not supported yet in the Consumption tier.
119
+
* WebSocket APIs aren't supported yet in the Consumption tier.
120
120
* WebSocket APIs support the following valid buffer types for messages: Close, BinaryFragment, BinaryMessage, UTF8Fragment, and UTF8Message.
121
121
* Currently, the [set-header](set-header-policy.md) policy doesn't support changing certain well-known headers, including `Host` headers, in onHandshake requests.
122
122
* 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.
@@ -125,7 +125,7 @@ For WebSocket connection limits, see [API Management limits](../azure-resource-m
125
125
126
126
### Unsupported policies
127
127
128
-
The following policies are not supported by and cannot be applied to the onHandshake operation:
128
+
The following policies aren't supported by and can't be applied to the onHandshake operation:
129
129
* Mock response
130
130
* Get from cache
131
131
* Store to cache
@@ -143,10 +143,10 @@ The following policies are not supported by and cannot be applied to the onHands
143
143
* Validate status code
144
144
145
145
> [!NOTE]
146
-
> If you applied the policies at higher scopes (i.e., global or product) and they were inherited by a WebSocket API through the policy, they will be skipped at runtime.
146
+
> If you applied the policies at higher scopes (for example, global or product) and the're inherited by a WebSocket API through the policy, they are skipped at runtime.
0 commit comments