Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. PolicyFragment

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.PolicyFragment

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Api Management Policy Fragment.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as std from "@pulumi/std";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const examplePolicyFragment = new azure.apimanagement.PolicyFragment("example", {
    apiManagementId: exampleService.id,
    name: "example-policy-fragment",
    format: "xml",
    value: std.file({
        input: "policy-fragment-1.xml",
    }).then(invoke => invoke.result),
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_std as std

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_policy_fragment = azure.apimanagement.PolicyFragment("example",
    api_management_id=example_service.id,
    name="example-policy-fragment",
    format="xml",
    value=std.file(input="policy-fragment-1.xml").result)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("pub1"),
			PublisherEmail:    pulumi.String("pub1@email.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "policy-fragment-1.xml",
		}, nil)
		if err != nil {
			return err
		}
		_, err = apimanagement.NewPolicyFragment(ctx, "example", &apimanagement.PolicyFragmentArgs{
			ApiManagementId: exampleService.ID(),
			Name:            pulumi.String("example-policy-fragment"),
			Format:          pulumi.String("xml"),
			Value:           pulumi.String(invokeFile.Result),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "pub1",
        PublisherEmail = "pub1@email.com",
        SkuName = "Developer_1",
    });

    var examplePolicyFragment = new Azure.ApiManagement.PolicyFragment("example", new()
    {
        ApiManagementId = exampleService.Id,
        Name = "example-policy-fragment",
        Format = "xml",
        Value = Std.File.Invoke(new()
        {
            Input = "policy-fragment-1.xml",
        }).Apply(invoke => invoke.Result),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.PolicyFragment;
import com.pulumi.azure.apimanagement.PolicyFragmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Developer_1")
            .build());

        var examplePolicyFragment = new PolicyFragment("examplePolicyFragment", PolicyFragmentArgs.builder()
            .apiManagementId(exampleService.id())
            .name("example-policy-fragment")
            .format("xml")
            .value(StdFunctions.file(FileArgs.builder()
                .input("policy-fragment-1.xml")
                .build()).result())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: pub1
      publisherEmail: pub1@email.com
      skuName: Developer_1
  examplePolicyFragment:
    type: azure:apimanagement:PolicyFragment
    name: example
    properties:
      apiManagementId: ${exampleService.id}
      name: example-policy-fragment
      format: xml
      value:
        fn::invoke:
          function: std:file
          arguments:
            input: policy-fragment-1.xml
          return: result
Copy

Create PolicyFragment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PolicyFragment(name: string, args: PolicyFragmentArgs, opts?: CustomResourceOptions);
@overload
def PolicyFragment(resource_name: str,
                   args: PolicyFragmentArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PolicyFragment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_management_id: Optional[str] = None,
                   value: Optional[str] = None,
                   description: Optional[str] = None,
                   format: Optional[str] = None,
                   name: Optional[str] = None)
func NewPolicyFragment(ctx *Context, name string, args PolicyFragmentArgs, opts ...ResourceOption) (*PolicyFragment, error)
public PolicyFragment(string name, PolicyFragmentArgs args, CustomResourceOptions? opts = null)
public PolicyFragment(String name, PolicyFragmentArgs args)
public PolicyFragment(String name, PolicyFragmentArgs args, CustomResourceOptions options)

type: azure:apimanagement:PolicyFragment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PolicyFragmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PolicyFragmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyFragmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyFragmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PolicyFragmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var policyFragmentResource = new Azure.ApiManagement.PolicyFragment("policyFragmentResource", new()
{
    ApiManagementId = "string",
    Value = "string",
    Description = "string",
    Format = "string",
    Name = "string",
});
Copy
example, err := apimanagement.NewPolicyFragment(ctx, "policyFragmentResource", &apimanagement.PolicyFragmentArgs{
	ApiManagementId: pulumi.String("string"),
	Value:           pulumi.String("string"),
	Description:     pulumi.String("string"),
	Format:          pulumi.String("string"),
	Name:            pulumi.String("string"),
})
Copy
var policyFragmentResource = new PolicyFragment("policyFragmentResource", PolicyFragmentArgs.builder()
    .apiManagementId("string")
    .value("string")
    .description("string")
    .format("string")
    .name("string")
    .build());
Copy
policy_fragment_resource = azure.apimanagement.PolicyFragment("policyFragmentResource",
    api_management_id="string",
    value="string",
    description="string",
    format="string",
    name="string")
Copy
const policyFragmentResource = new azure.apimanagement.PolicyFragment("policyFragmentResource", {
    apiManagementId: "string",
    value: "string",
    description: "string",
    format: "string",
    name: "string",
});
Copy
type: azure:apimanagement:PolicyFragment
properties:
    apiManagementId: string
    description: string
    format: string
    name: string
    value: string
Copy

PolicyFragment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PolicyFragment resource accepts the following input properties:

ApiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
Value This property is required. string

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

Description string
The description for the Policy Fragment.
Format string

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

Name Changes to this property will trigger replacement. string
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
ApiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
Value This property is required. string

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

Description string
The description for the Policy Fragment.
Format string

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

Name Changes to this property will trigger replacement. string
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
String
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
value This property is required. String

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

description String
The description for the Policy Fragment.
format String

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. String
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
value This property is required. string

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

description string
The description for the Policy Fragment.
format string

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. string
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
api_management_id
This property is required.
Changes to this property will trigger replacement.
str
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
value This property is required. str

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

description str
The description for the Policy Fragment.
format str

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. str
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
String
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
value This property is required. String

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

description String
The description for the Policy Fragment.
format String

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. String
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyFragment resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PolicyFragment Resource

Get an existing PolicyFragment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PolicyFragmentState, opts?: CustomResourceOptions): PolicyFragment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        description: Optional[str] = None,
        format: Optional[str] = None,
        name: Optional[str] = None,
        value: Optional[str] = None) -> PolicyFragment
func GetPolicyFragment(ctx *Context, name string, id IDInput, state *PolicyFragmentState, opts ...ResourceOption) (*PolicyFragment, error)
public static PolicyFragment Get(string name, Input<string> id, PolicyFragmentState? state, CustomResourceOptions? opts = null)
public static PolicyFragment get(String name, Output<String> id, PolicyFragmentState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:PolicyFragment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiManagementId Changes to this property will trigger replacement. string
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
Description string
The description for the Policy Fragment.
Format string

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

Name Changes to this property will trigger replacement. string
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
Value string

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

ApiManagementId Changes to this property will trigger replacement. string
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
Description string
The description for the Policy Fragment.
Format string

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

Name Changes to this property will trigger replacement. string
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
Value string

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

apiManagementId Changes to this property will trigger replacement. String
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
description String
The description for the Policy Fragment.
format String

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. String
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
value String

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

apiManagementId Changes to this property will trigger replacement. string
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
description string
The description for the Policy Fragment.
format string

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. string
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
value string

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

api_management_id Changes to this property will trigger replacement. str
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
description str
The description for the Policy Fragment.
format str

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. str
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
value str

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

apiManagementId Changes to this property will trigger replacement. String
The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
description String
The description for the Policy Fragment.
format String

The format of the Policy Fragment. Possible values are xml or rawxml. Default is xml.

NOTE: The value property will be updated to reflect the corresponding format when format is updated.

name Changes to this property will trigger replacement. String
The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
value String

The value of the Policy Fragment.

NOTE: Be aware of the two format possibilities. If the value is not applied and continues to cause a diff the format could be wrong.

Import

Api Management Policy Fragments can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/policyFragment:PolicyFragment example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/instance1/policyFragments/policyFragment1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure