Skip to content

Commit bfe7848

Browse files
Merge pull request #226453 from johndowns/front-door-caching-february-2023
Front Door - Update caching query string behavior documentation
2 parents b8555d4 + 87433c4 commit bfe7848

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

articles/frontdoor/front-door-caching.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,15 @@ If there's more than one key-value pair in a query string of a request then thei
123123

124124
When you configure caching, you specify how the cache should handle query strings. The following behaviors are supported:
125125

126-
* **Ignore query strings**: In this mode, Azure Front Door passes the query strings from the client to the origin on the first request and caches the asset. All ensuing requests for the asset that are served from the Front Door environment ignore the query strings until the cached asset expires.
126+
* **Ignore Query String**: In this mode, Azure Front Door passes the query strings from the client to the origin on the first request and caches the asset. Future requests for the asset that are served from the Front Door environment ignore the query strings until the cached asset expires.
127127

128-
* **Cache every unique URL**: In this mode, each request with a unique URL, including the query string, is treated as a unique asset with its own cache. For example, the response from the origin for a request for `www.example.ashx?q=test1` is cached at the Front Door environment and returned for ensuing caches with the same query string. A request for `www.example.ashx?q=test2` is cached as a separate asset with its own time-to-live setting.
128+
* **Use Query String**: In this mode, each request with a unique URL, including the query string, is treated as a unique asset with its own cache. For example, the response from the origin for a request for `www.example.ashx?q=test1` is cached at the Front Door environment and returned for ensuing caches with the same query string. A request for `www.example.ashx?q=test2` is cached as a separate asset with its own time-to-live setting.
129+
130+
The order of the query string parameters doesn't matter. For example, if the Azure Front Door environment includes a cached response for the URL `www.example.ashx?q=test1&r=test2`, then a request for `www.example.ashx?r=test2&q=test1` is also served from the cache.
129131

130132
::: zone pivot="front-door-standard-premium"
131133

132-
* **Specify cache key query string** behavior to include or exclude specified parameters when the cache key is generated.
134+
* **Ignore Specified Query Strings** and **Include Specified Query Strings**: In this mode, you can configure Azure Front Door to include or exclude specified parameters when the cache key is generated.
133135

134136
For example, suppose that the default cache key is `/foo/image/asset.html`, and a request is made to the URL `https://contoso.com/foo/image/asset.html?language=EN&userid=100&sessionid=200`. If there's a rules engine rule to exclude the `userid` query string parameter, then the query string cache key would be `/foo/image/asset.html?language=EN&sessionid=200`.
135137

articles/frontdoor/front-door-rules-engine-actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -470,10 +470,10 @@ Use these settings to control how files get cached for requests that contain que
470470

471471
| Cache behavior | Description |
472472
| -------------- | ------------ |
473-
| Ignore query strings | Once the asset is cached, all ensuing requests ignore the query strings until the cached asset expires. |
474-
| Cache every unique URL | Each request with a unique URL, including the query string, is treated as a unique asset with its own cache. |
475-
| Ignore specified query strings | Request URL query strings listed in "Query parameters" setting are ignored for caching. |
476-
| Include specified query strings | Request URL query strings listed in "Query parameters" setting are used for caching. |
473+
| Ignore Query String | Once the asset is cached, all ensuing requests ignore the query strings until the cached asset expires. |
474+
| Use Query String | Each request with a unique URL, including the query string, is treated as a unique asset with its own cache. |
475+
| Ignore Specified Query Strings | Request URL query strings listed in "Query parameters" setting are ignored for caching. |
476+
| Include Specified Query Strings | Request URL query strings listed in "Query parameters" setting are used for caching. |
477477

478478
| Additional fields | Description
479479
------------------|---------------

articles/frontdoor/scenario-storage-blobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ As a content delivery network (CDN), Front Door caches the content at its global
6363

6464
#### Authentication
6565

66-
Front Door is designed to be internet-facing, and this scenario is optimized for publicly available blobs. If you need to authenticate access to blobs, consider using [shared access signatures](../storage/common/storage-sas-overview.md), and ensure that you enable the [*Cache every unique URL* query string behavior](front-door-caching.md#query-string-behavior) to avoid Front Door from serving requests to unauthenticated clients. However, this approach might not make effective use of the Front Door cache, because each request with a different shared access signature must be sent to the origin separately.
66+
Front Door is designed to be internet-facing, and this scenario is optimized for publicly available blobs. If you need to authenticate access to blobs, consider using [shared access signatures](../storage/common/storage-sas-overview.md), and ensure that you enable the [*Use Query String* query string behavior](front-door-caching.md#query-string-behavior) to avoid Front Door from serving requests to unauthenticated clients. However, this approach might not make effective use of the Front Door cache, because each request with a different shared access signature must be sent to the origin separately.
6767

6868
#### Origin security
6969

0 commit comments

Comments
 (0)