1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. PolicyFragment
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.PolicyFragment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Policy fragment contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2021-12-01-preview.

    Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview.

    Example Usage

    ApiManagementCreatePolicy

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var policyFragment = new AzureNative.ApiManagement.PolicyFragment("policyFragment", new()
        {
            Description = "A policy fragment example",
            Format = AzureNative.ApiManagement.PolicyFragmentContentFormat.Xml,
            Id = "policyFragment1",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Value = "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apimanagement.NewPolicyFragment(ctx, "policyFragment", &apimanagement.PolicyFragmentArgs{
    			Description:       pulumi.String("A policy fragment example"),
    			Format:            pulumi.String(apimanagement.PolicyFragmentContentFormatXml),
    			Id:                pulumi.String("policyFragment1"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    			Value:             pulumi.String("<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.apimanagement.PolicyFragment;
    import com.pulumi.azurenative.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 policyFragment = new PolicyFragment("policyFragment", PolicyFragmentArgs.builder()        
                .description("A policy fragment example")
                .format("xml")
                .id("policyFragment1")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .value("<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    policy_fragment = azure_native.apimanagement.PolicyFragment("policyFragment",
        description="A policy fragment example",
        format=azure_native.apimanagement.PolicyFragmentContentFormat.XML,
        id="policyFragment1",
        resource_group_name="rg1",
        service_name="apimService1",
        value="<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const policyFragment = new azure_native.apimanagement.PolicyFragment("policyFragment", {
        description: "A policy fragment example",
        format: azure_native.apimanagement.PolicyFragmentContentFormat.Xml,
        id: "policyFragment1",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
        value: "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>",
    });
    
    resources:
      policyFragment:
        type: azure-native:apimanagement:PolicyFragment
        properties:
          description: A policy fragment example
          format: xml
          id: policyFragment1
          resourceGroupName: rg1
          serviceName: apimService1
          value: <fragment><json-to-xml apply="always" consider-accept-header="false" /></fragment>
    

    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,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       value: Optional[str] = None,
                       description: Optional[str] = None,
                       format: Optional[Union[str, PolicyFragmentContentFormat]] = None,
                       id: 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-native:apimanagement:PolicyFragment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PolicyFragmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args PolicyFragmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyFragmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyFragmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var policyFragmentResource = new AzureNative.ApiManagement.PolicyFragment("policyFragmentResource", new()
    {
        ResourceGroupName = "string",
        ServiceName = "string",
        Value = "string",
        Description = "string",
        Format = "string",
        Id = "string",
    });
    
    example, err := apimanagement.NewPolicyFragment(ctx, "policyFragmentResource", &apimanagement.PolicyFragmentArgs{
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    Value: pulumi.String("string"),
    Description: pulumi.String("string"),
    Format: pulumi.String("string"),
    Id: pulumi.String("string"),
    })
    
    var policyFragmentResource = new PolicyFragment("policyFragmentResource", PolicyFragmentArgs.builder()        
        .resourceGroupName("string")
        .serviceName("string")
        .value("string")
        .description("string")
        .format("string")
        .id("string")
        .build());
    
    policy_fragment_resource = azure_native.apimanagement.PolicyFragment("policyFragmentResource",
        resource_group_name="string",
        service_name="string",
        value="string",
        description="string",
        format="string",
        id="string")
    
    const policyFragmentResource = new azure_native.apimanagement.PolicyFragment("policyFragmentResource", {
        resourceGroupName: "string",
        serviceName: "string",
        value: "string",
        description: "string",
        format: "string",
        id: "string",
    });
    
    type: azure-native:apimanagement:PolicyFragment
    properties:
        description: string
        format: string
        id: string
        resourceGroupName: string
        serviceName: string
        value: string
    

    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

    The PolicyFragment resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Value string
    Contents of the policy fragment.
    Description string
    Policy fragment description.
    Format string | Pulumi.AzureNative.ApiManagement.PolicyFragmentContentFormat
    Format of the policy fragment content.
    Id string
    A resource identifier.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Value string
    Contents of the policy fragment.
    Description string
    Policy fragment description.
    Format string | PolicyFragmentContentFormat
    Format of the policy fragment content.
    Id string
    A resource identifier.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    value String
    Contents of the policy fragment.
    description String
    Policy fragment description.
    format String | PolicyFragmentContentFormat
    Format of the policy fragment content.
    id String
    A resource identifier.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    value string
    Contents of the policy fragment.
    description string
    Policy fragment description.
    format string | PolicyFragmentContentFormat
    Format of the policy fragment content.
    id string
    A resource identifier.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    value str
    Contents of the policy fragment.
    description str
    Policy fragment description.
    format str | PolicyFragmentContentFormat
    Format of the policy fragment content.
    id str
    A resource identifier.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    value String
    Contents of the policy fragment.
    description String
    Policy fragment description.
    format String | "xml" | "rawxml"
    Format of the policy fragment content.
    id String
    A resource identifier.

    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.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    PolicyFragmentContentFormat, PolicyFragmentContentFormatArgs

    Xml
    xmlThe contents are inline and Content type is an XML document.
    Rawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    PolicyFragmentContentFormatXml
    xmlThe contents are inline and Content type is an XML document.
    PolicyFragmentContentFormatRawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    Xml
    xmlThe contents are inline and Content type is an XML document.
    Rawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    Xml
    xmlThe contents are inline and Content type is an XML document.
    Rawxml
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    XML
    xmlThe contents are inline and Content type is an XML document.
    RAWXML
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.
    "xml"
    xmlThe contents are inline and Content type is an XML document.
    "rawxml"
    rawxmlThe contents are inline and Content type is a non XML encoded policy document.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:PolicyFragment policyFragment1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi