Remove value from cache
APPLIES TO: All API Management tiers
The cache-remove-value
deletes a cached item identified by its key. The key can have an arbitrary string value and is typically provided using a policy expression.
Note
Set a policy's elements and child elements in the order provided in the policy statement. Learn more about how to set or edit API Management policies.
Policy statement
<cache-remove-value key="cache key value" caching-type="prefer-external | external | internal" />
Attributes
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 |
key | The key of the previously cached value to be removed from the cache. Policy expressions are allowed. | Yes | N/A |
Usage
- Policy sections: inbound, outbound, backend, on-error
- Policy scopes: global, workspace, product, API, operation
- Gateways: classic, consumption, self-hosted
Example
<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.
Related policies
Next steps
For more information about working with policies, see:
- Tutorial: Transform and protect your API
- Policy reference for a full list of policy statements and their settings
- Policy expressions
- Set or edit policies
- Policy samples