Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: Configure Request and Response Buffers description: Learn how to configure Request and Response buffers for your Azure Application Gateway. services: application-gateway author: mbender-ms ms.service: azure-application-gateway ms.topic: how-to ms.date: 09/25/2024 ms.author: mbender #Customer intent: As a user, I want to know how can I disable/enable proxy buffers. # Customer intent: As a system administrator, I want to configure request and response buffering settings on my application gateway, so that I can optimize performance based on client interaction and backend processing capabilities. --- # Configure Request and Response Proxy Buffers Azure Application Gateway Standard v2 SKU supports buffering Requests from clients or Responses (from the backend servers). Based on the processing capabilities of the clients that interact with your application gateway, you can use these buffers to configure the speed of packet delivery. ## Response Buffer Application Gateway's response buffer can collect all or parts of the response packets sent by the backend server, before delivering them to the clients. By default, the Response buffering is enabled on Application Gateway which is useful to accommodate slow clients. This setting allows you to conserve the backend TCP connections as they can be closed once Application Gateway receives complete response and work according to the client's processing speed. This way, your Application Gateway continues to deliver the response as per the client’s pace. ## Request Buffer In a similar way, Application Gateway's Request buffer can temporarily store the entire or parts of the request body, and then forward a larger upload request at once to the backend server. By default, Request buffering setting is enabled on Application Gateway and is useful to offload the processing function of reassembling the smaller packets of data on the backend server. >[!NOTE] >By default, both Request and Response buffers are enabled on your Application Gateway resource but you can choose to configure them separately. Further, the settings are applied at a resource level and can't be managed separately for each listener. </br> You can keep either the Request or Response buffer, enabled or disabled, based on your requirements and the observed performance of the client systems that communicate with your Application Gateway. </br> > [!WARNING] > We strongly recommend that you test and evaluate the performance before rolling this out on the production gateways. ## How to change the buffer settings? You can change this setting by using the globalConfiguration property. ### Azure CLI method **Response Buffer** ```azurecli-interactive az network application-gateway update --name <gw-name> --resource-group <rg-name> --set globalConfiguration.enableResponseBuffering=false ``` **Request Buffer** ```azurecli-interactive az network application-gateway update --name <gw-name> --resource-group <rg-name> --set globalConfiguration.enableRequestBuffering=false ``` ### PowerShell method **New application gateway** ```PowerShell $AppGw02 = New-AzApplicationGateway -Name "ApplicationGateway02" -ResourceGroupName "ResourceGroup02" -Location $location -BackendAddressPools $pool -BackendHttpSettingsCollection $poolSetting01 -FrontendIpConfigurations $fipconfig -GatewayIpConfigurations $gipconfig -FrontendPorts $fp01 -HttpListeners $listener01 -RequestRoutingRules $rule01 -Sku $sku -EnableRequestBuffering:$false -EnableResponseBuffering:$false ``` **Update an existing application gateway** ```PowerShell $appgw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $rgname $appgw.EnableRequestBuffering = $false $appgw.EnableResponseBuffering = $false Set-AzApplicationGateway -ApplicationGateway $appgw ``` ### ARM template method ```json { "$schema":"https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", "contentVersion":"1.0.0.0", "parameters":{ }, "variables":{ }, "resources":[ { "type":"Microsoft.Network/applicationGateways", "apiVersion":"xxx-xx-xx", "name":"[parameters('applicationGateways_xxxx_x_xx_name')]", "location":"eastus", "tags":{ }, "identity":{ }, "properties":{ "globalConfiguration":{ "enableRequestBuffering":false, "enableResponseBuffering":false } } } ] } ``` For reference, visit [Azure SDK for .NET](/dotnet/api/microsoft.azure.management.network.models.applicationgatewayglobalconfiguration) ## Limitations - API version 2020-01-01 or later should be used to configure buffers. - Currently, these changes aren't supported through Portal and PowerShell. - Request buffering can't be disabled if you're running the WAF SKU of Application Gateway. The WAF requires the full request to buffer as part of processing, therefore, even if you disable request buffering within Application Gateway the WAF still buffers the request. Response buffering isn't impacted by the WAF.