Direct Line App Service extension
Commencing September 1, 2023, it is strongly advised to employ the Azure Service Tag method for network isolation. The utilization of DL-ASE should be limited to highly specific scenarios. Prior to implementing this solution in a production environment, we kindly recommend consulting your support team for guidance.
APPLIES TO: SDK v4
The Direct Line App Service extension allows clients to connect directly with the host, where the bot is located. It runs inside the same subscription, app service, and Azure network as your bot and provides network isolation and, in some cases, improved performance. The client application uses WebSocket protocol to communicate with the bot.
The Direct Line App Service extension is only supported in a Windows App Service, and not currently supported in a Linux App Service.
The following picture shows the overall architecture:
Note
If you don't require network isolation and want to use the standard channel over the HTTPS protocol, refer to Connect a bot to Direct Line.
The Direct Line App Service extension adds a new set of streaming extensions to the Bot Framework protocol, replacing exchanging messages via HTTP with a transport that allows bidirectional requests to be sent over a persistent WebSocket.
Before streaming extensions, the Direct Line API offered one way for a client to send Activities to Direct Line and two ways for a client to retrieve Activities from Direct Line. The messages were sent via an HTTP POST, and received by either an HTTP GET (polling) or by opening a WebSocket to receive ActivitySets. Streaming extensions expand on the use of the WebSocket and allow all messaging communication to be sent on that WebSocket. Streaming extensions can also be used between channel services and the bot.
The Direct Line App Service extension is pre-installed on all instances of Azure App Services in every data center around the world. It's maintained and managed by Azure without additional deployment work for the customer. It's disabled on Azure App Services by default, but it can be easily turned on to connect to your hosted bot.
See Also
Name | Description |
---|---|
Configure .NET bot for extension | Update a .NET bot to work with named pipes, and enable the Direct Line App Service extension in the Azure App Service resource where the bot is hosted. |
Configure Node.js bot for extension | Update a Node.js bot to work with named pipes and enable the Direct Line App Service extension in the Azure App Service resource where the bot is hosted. |
Create .NET client with extension | Create a .NET client in C# which connects to the Direct Line App Service extension. |
Use extension with Web Chat | Use Web Chat with the Direct Line App Service extension. |
Use extension within VNET | Use the Direct Line App Service extension with an Azure Virtual Network (VNET). |