rule-set-server-variables.md

title	description	services	author	ms.service	ms.topic	ms.date	ms.author
Server variables - Azure Front Door	This article provides a list of the server variables available in Azure Front Door rule sets.	frontdoor	duongau	frontdoor	conceptual	03/22/2022	duau

Azure Front Door Rule set server variables

Rule set server variables provide access to structured information about the request when you work with Rule sets.

When you use Rule set match conditions, server variables are available as match conditions so that you can identify requests with specific properties.

When you use Rule set actions, you can use server variables to dynamically change the request and response headers, and rewrite URLs, paths, and query strings, for example, when a new page load or when a form is posted.

Note

Server variable is only available with Azure Front Door Standard and Premium tiers.

Supported variables

Variable name	Description
socket_ip	The IP address of the direct connection to Azure Front Door edge. If the client used an HTTP proxy or a load balancer to send the request, the value of socket_ip is the IP address of the proxy or load balancer. To access this server variable in a match condition, use Socket address.
client_ip	The IP address of the client that made the original request. If there was an X-Forwarded-For header in the request, then the client IP address is picked from the header. To access this server variable in a match condition, use Remote address and configure the Operator to IP Match or IP Not Match.
client_port	The IP port of the client that made the request. To access this server variable in a match condition, use Client port.
hostname	The host name in the request from the client. To access this server variable in a match condition, use Host name.
geo_country	Indicates the requester's country/region of origin through its country/region code. To access this server variable in a match condition, use Remote address and configure the Operator to Geo Match or Geo Not Match.
http_method	The method used to make the URL request, such as GET or POST. To access this server variable in a match condition, use Request method.
http_version	The request protocol. Usually HTTP/1.0, HTTP/1.1, or HTTP/2.0. To access this server variable in a match condition, use HTTP version.
query_string	The list of variable/value pairs that follows the "?" in the requested URL. For example, in the request http://contoso.com:8080/article.aspx?id=123&title=fabrikam, the query_string value will be id=123&title=fabrikam. To access this server variable in a match condition, use Query string.
request_scheme	The request scheme: http or https. To access this server variable in a match condition, use Request protocol.
request_uri	The full original request URI (with arguments). For example, in the request http://contoso.com:8080/article.aspx?id=123&title=fabrikam, the request_uri value will be /article.aspx?id=123&title=fabrikam. To access this server variable in a match condition, use Request URL.
ssl_protocol	The protocol of an established TLS connection. To access this server variable in a match condition, use SSL protocol.
server_port	The port of the server that accepted a request. To access this server variable in a match condition, use Server port.
url_path	Identifies the specific resource in the host that the web client wants to access. This is the part of the request URI without the arguments. For example, in the request http://contoso.com:8080/article.aspx?id=123&title=fabrikam, the uri_path value will be /article.aspx. To access this server variable in a match condition, use Request path.

Server variable format

When you work with Rule Set actions, specify server variables by using the following formats:

• {variable}: Include the entire server variable. For example, if the client IP address is 111.222.333.444 then the {client_ip} token would evaluate to 111.222.333.444.
• {variable:offset}: Include the server variable after a specific offset, until the end of the variable. The offset is zero-based. For example, if the client IP address is 111.222.333.444 then the {client_ip:3} token would evaluate to .222.333.444.
• {variable:offset:length}: Include the server variable after a specific offset, up to the specified length. The offset is zero-based. For example, For example, when the variable var is 'AppId=01f592979c584d0f9d679db3e66a3e5e',
  • Offsets within range, no lengths: {var:0} = AppId=01f592979c584d0f9d679db3e66a3e5e, {var:6} = 01f592979c584d0f9d679db3e66a3e5e, {var:-8} = e66a3e5e
  • Offsets out of range, no lengths: {var:-128} = AppId=01f592979c584d0f9d679db3e66a3e5e, {var:128} = null
  • Offsets and lengths within range: {var:0:5} = AppId, {var:7:7} = 1f59297, {var:7:-7} = 1f592979c584d0f9d679db3e
  • Zero lengths: {var:0:0} = null, {var:4:0} = null
  • Offsets within range and lengths out of range: {var:0:100} = AppId=01f592979c584d0f9d679db3e66a3e5e, {var:5:100} = =01f592979c584d0f9d679db3e66a3e5e, {var:0:-48} = null, {var:4:-48} = null

Supported rule set actions

Server variables are supported on the following Rule set actions:

• Query string caching behavior in Route configuration override
• Modify request header
• Modify response header
• URL redirect
• URL rewrite

Next steps

• Learn more about Azure Front Door Rule set.
• Learn more about Rule set match conditions.
• Learn more about Rule set actions.