Include fragment

APPLIES TO: All API Management tiers

The include-fragment policy inserts the contents of a previously created policy fragment in the policy definition. A policy fragment is a centrally managed, reusable XML policy snippet that can be included in policy definitions in your API Management instance.

The policy inserts the policy fragment as-is at the location you select in the policy definition.

Note

Set the 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

<include-fragment fragment-id="fragment" />

Attributes

Attribute	Description	Required	Default
fragment-id	A string. Specifies the identifier (name) of a policy fragment created in the API Management instance. Policy expressions aren't allowed.	Yes	N/A

Usage

• Policy sections: inbound, outbound, backend, on-error
• Policy scopes: global, workspace, product, API, operation
• Gateways: classic, v2, consumption, self-hosted

Example

In the following example, the policy fragment named myFragment is added in the inbound section of a policy definition.

<inbound>
    <include-fragment fragment-id="myFragment" />
    <base />
</inbound>
[...]

Related policies

• Policy control and flow

Related content

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
• Reuse policy configurations
• Policy snippets repo
• Author policies using Microsoft Copilot for Azure