| title | description | services | author | ms.service | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|
Azure API Management policy reference - cache-store-value | Microsoft Docs |
Reference for the cache-store-value policy available for use in Azure API Management. Provides policy usage, settings, and examples. |
api-management |
dlepow |
api-management |
article |
03/18/2024 |
danlep |
[!INCLUDE api-management-availability-all-tiers]
The cache-store-value performs cache storage by key. The key can have an arbitrary string value and is typically provided using a policy expression.
Note
The operation of storing the value in cache performed by this policy is asynchronous. The stored value can be retrieved using Get value from cache policy. However, the stored value may not be immediately available for retrieval since the asynchronous operation that stores the value in cache may still be in progress.
[!INCLUDE api-management-cache-volatile]
[!INCLUDE api-management-policy-generic-alert]
<cache-store-value key="cache key value" value="value to cache" duration="seconds" caching-type="prefer-external | external | internal" />| Attribute | Description | Required | Default |
|---|---|---|---|
| caching-type | Choose between the following values of the attribute: - internal to use the built-in API Management cache,- external to use the external cache as described in Use an external Azure Cache for Redis in Azure API Management,- prefer-external to use external cache if configured or internal cache otherwise.Policy expressions aren't allowed. |
No | prefer-external |
| duration | Value will be cached for the provided duration value, specified in seconds. Policy expressions are allowed. | Yes | N/A |
| key | Cache key the value will be stored under. Policy expressions are allowed. | Yes | N/A |
| value | The value to be cached. Policy expressions are allowed. | Yes | N/A |
- Policy sections: inbound, outbound, backend, on-error
- Policy scopes: global, workspace, product, API, operation
- Gateways: classic, v2, consumption, self-hosted
<cache-store-value
key="@("userprofile-" + context.Variables["enduserid"])"
value="@((string)context.Variables["userprofile"])" duration="100000" />For more information and examples of this policy, see Custom caching in Azure API Management.
[!INCLUDE api-management-policy-ref-next-steps]