azure-native.apimanagement.ProductPolicy
Explore with Pulumi AI
Policy Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-10-10, 2018-06-01-preview, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateProductPolicy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var productPolicy = new AzureNative.ApiManagement.ProductPolicy("productPolicy", new()
    {
        Format = AzureNative.ApiManagement.PolicyContentFormat.Xml,
        PolicyId = "policy",
        ProductId = "5702e97e5157a50f48dce801",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        Value = @"<policies>
  <inbound>
    <rate-limit calls=""{{call-count}}"" renewal-period=""15""></rate-limit>
    <log-to-eventhub logger-id=""16"">
                      @( string.Join("","", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) 
                  </log-to-eventhub>
    <quota-by-key calls=""40"" counter-key=""cc"" renewal-period=""3600"" increment-count=""@(context.Request.Method == "POST" ? 1:2)"" />
    <base />
  </inbound>
  <backend>
    <base />
  </backend>
  <outbound>
    <base />
  </outbound>
</policies>",
    });
});
package main
import (
	apimanagement "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.NewProductPolicy(ctx, "productPolicy", &apimanagement.ProductPolicyArgs{
			Format:            pulumi.String(apimanagement.PolicyContentFormatXml),
			PolicyId:          pulumi.String("policy"),
			ProductId:         pulumi.String("5702e97e5157a50f48dce801"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			Value: pulumi.String(`<policies>
  <inbound>
    <rate-limit calls="{{call-count}}" renewal-period="15"></rate-limit>
    <log-to-eventhub logger-id="16">
                      @( string.Join(",", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) 
                  </log-to-eventhub>
    <quota-by-key calls="40" counter-key="cc" renewal-period="3600" increment-count="@(context.Request.Method == "POST" ? 1:2)" />
    <base />
  </inbound>
  <backend>
    <base />
  </backend>
  <outbound>
    <base />
  </outbound>
</policies>`),
		})
		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.ProductPolicy;
import com.pulumi.azurenative.apimanagement.ProductPolicyArgs;
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 productPolicy = new ProductPolicy("productPolicy", ProductPolicyArgs.builder()
            .format("xml")
            .policyId("policy")
            .productId("5702e97e5157a50f48dce801")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .value("""
<policies>
  <inbound>
    <rate-limit calls="{{call-count}}" renewal-period="15"></rate-limit>
    <log-to-eventhub logger-id="16">
                      @( string.Join(",", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) 
                  </log-to-eventhub>
    <quota-by-key calls="40" counter-key="cc" renewal-period="3600" increment-count="@(context.Request.Method == "POST" ? 1:2)" />
    <base />
  </inbound>
  <backend>
    <base />
  </backend>
  <outbound>
    <base />
  </outbound>
</policies>            """)
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const productPolicy = new azure_native.apimanagement.ProductPolicy("productPolicy", {
    format: azure_native.apimanagement.PolicyContentFormat.Xml,
    policyId: "policy",
    productId: "5702e97e5157a50f48dce801",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    value: `<policies>\x0d
  <inbound>\x0d
    <rate-limit calls="{{call-count}}" renewal-period="15"></rate-limit>\x0d
    <log-to-eventhub logger-id="16">\x0d
                      @( string.Join(",", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \x0d
                  </log-to-eventhub>\x0d
    <quota-by-key calls="40" counter-key="cc" renewal-period="3600" increment-count="@(context.Request.Method == "POST" ? 1:2)" />\x0d
    <base />\x0d
  </inbound>\x0d
  <backend>\x0d
    <base />\x0d
  </backend>\x0d
  <outbound>\x0d
    <base />\x0d
  </outbound>\x0d
</policies>`,
});
import pulumi
import pulumi_azure_native as azure_native
product_policy = azure_native.apimanagement.ProductPolicy("productPolicy",
    format=azure_native.apimanagement.PolicyContentFormat.XML,
    policy_id="policy",
    product_id="5702e97e5157a50f48dce801",
    resource_group_name="rg1",
    service_name="apimService1",
    value="""<policies>\x0d
  <inbound>\x0d
    <rate-limit calls="{{call-count}}" renewal-period="15"></rate-limit>\x0d
    <log-to-eventhub logger-id="16">\x0d
                      @( string.Join(",", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \x0d
                  </log-to-eventhub>\x0d
    <quota-by-key calls="40" counter-key="cc" renewal-period="3600" increment-count="@(context.Request.Method == "POST" ? 1:2)" />\x0d
    <base />\x0d
  </inbound>\x0d
  <backend>\x0d
    <base />\x0d
  </backend>\x0d
  <outbound>\x0d
    <base />\x0d
  </outbound>\x0d
</policies>""")
resources:
  productPolicy:
    type: azure-native:apimanagement:ProductPolicy
    properties:
      format: xml
      policyId: policy
      productId: 5702e97e5157a50f48dce801
      resourceGroupName: rg1
      serviceName: apimService1
      value: "<policies>\r\n  <inbound>\r\n    <rate-limit calls=\"{{call-count}}\" renewal-period=\"15\"></rate-limit>\r\n    <log-to-eventhub logger-id=\"16\">\r\n                      @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n                  </log-to-eventhub>\r\n    <quota-by-key calls=\"40\" counter-key=\"cc\" renewal-period=\"3600\" increment-count=\"@(context.Request.Method == "POST" ? 1:2)\" />\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <base />\r\n  </outbound>\r\n</policies>"
Create ProductPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ProductPolicy(name: string, args: ProductPolicyArgs, opts?: CustomResourceOptions);@overload
def ProductPolicy(resource_name: str,
                  args: ProductPolicyArgs,
                  opts: Optional[ResourceOptions] = None)
@overload
def ProductPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  product_id: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  service_name: Optional[str] = None,
                  value: Optional[str] = None,
                  format: Optional[Union[str, PolicyContentFormat]] = None,
                  policy_id: Optional[str] = None)func NewProductPolicy(ctx *Context, name string, args ProductPolicyArgs, opts ...ResourceOption) (*ProductPolicy, error)public ProductPolicy(string name, ProductPolicyArgs args, CustomResourceOptions? opts = null)
public ProductPolicy(String name, ProductPolicyArgs args)
public ProductPolicy(String name, ProductPolicyArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ProductPolicy
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 ProductPolicyArgs
- 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 ProductPolicyArgs
- 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 ProductPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProductPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProductPolicyArgs
- 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 productPolicyResource = new AzureNative.ApiManagement.ProductPolicy("productPolicyResource", new()
{
    ProductId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    Value = "string",
    Format = "string",
    PolicyId = "string",
});
example, err := apimanagement.NewProductPolicy(ctx, "productPolicyResource", &apimanagement.ProductPolicyArgs{
	ProductId:         pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Value:             pulumi.String("string"),
	Format:            pulumi.String("string"),
	PolicyId:          pulumi.String("string"),
})
var productPolicyResource = new ProductPolicy("productPolicyResource", ProductPolicyArgs.builder()
    .productId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .value("string")
    .format("string")
    .policyId("string")
    .build());
product_policy_resource = azure_native.apimanagement.ProductPolicy("productPolicyResource",
    product_id="string",
    resource_group_name="string",
    service_name="string",
    value="string",
    format="string",
    policy_id="string")
const productPolicyResource = new azure_native.apimanagement.ProductPolicy("productPolicyResource", {
    productId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    value: "string",
    format: "string",
    policyId: "string",
});
type: azure-native:apimanagement:ProductPolicy
properties:
    format: string
    policyId: string
    productId: string
    resourceGroupName: string
    serviceName: string
    value: string
ProductPolicy 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 ProductPolicy resource accepts the following input properties:
- ProductId string
- Product identifier. Must be unique in the current API Management service instance.
- ResourceGroup stringName 
- 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 as defined by the format.
- Format
string | Pulumi.Azure Native. Api Management. Policy Content Format 
- Format of the policyContent.
- PolicyId string
- The identifier of the Policy.
- ProductId string
- Product identifier. Must be unique in the current API Management service instance.
- ResourceGroup stringName 
- 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 as defined by the format.
- Format
string | PolicyContent Format 
- Format of the policyContent.
- PolicyId string
- The identifier of the Policy.
- productId String
- Product identifier. Must be unique in the current API Management service instance.
- resourceGroup StringName 
- 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 as defined by the format.
- format
String | PolicyContent Format 
- Format of the policyContent.
- policyId String
- The identifier of the Policy.
- productId string
- Product identifier. Must be unique in the current API Management service instance.
- resourceGroup stringName 
- 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 as defined by the format.
- format
string | PolicyContent Format 
- Format of the policyContent.
- policyId string
- The identifier of the Policy.
- product_id str
- Product identifier. Must be unique in the current API Management service instance.
- resource_group_ strname 
- 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 as defined by the format.
- format
str | PolicyContent Format 
- Format of the policyContent.
- policy_id str
- The identifier of the Policy.
- productId String
- Product identifier. Must be unique in the current API Management service instance.
- resourceGroup StringName 
- 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 as defined by the format.
- format String | "xml" | "xml-link" | "rawxml" | "rawxml-link"
- Format of the policyContent.
- policyId String
- The identifier of the Policy.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProductPolicy resource produces the following output properties:
Supporting Types
PolicyContentFormat, PolicyContentFormatArgs      
- Xml
- xmlThe contents are inline and Content type is an XML document.
- Xml_link 
- xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- Rawxml
- rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- Rawxml_link 
- rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
- PolicyContent Format Xml 
- xmlThe contents are inline and Content type is an XML document.
- PolicyContent Format_Xml_Link 
- xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- PolicyContent Format Rawxml 
- rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- PolicyContent Format_Rawxml_Link 
- rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
- Xml
- xmlThe contents are inline and Content type is an XML document.
- Xmllink
- xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- Rawxml
- rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- Rawxmllink
- rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
- Xml
- xmlThe contents are inline and Content type is an XML document.
- Xml_link 
- xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- Rawxml
- rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- Rawxml_link 
- rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
- XML
- xmlThe contents are inline and Content type is an XML document.
- XML_LINK
- xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- RAWXML
- rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- RAWXML_LINK
- rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
- "xml"
- xmlThe contents are inline and Content type is an XML document.
- "xml-link"
- xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- "rawxml"
- rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- "rawxml-link"
- rawxml-linkThe policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:ProductPolicy policy /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0