We recommend using Azure Native.
azure.apimanagement.Policy
Explore with Pulumi AI
Manages a API Management service Policy.
NOTE: This resource will, upon creation, overwrite any existing policy in the API Management service, as there is no feasible way to test whether the policy has been modified from the default. Similarly, when this resource is destroyed, the API Management service will revert to its default policy.
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 exampleNamedValue = new azure.apimanagement.NamedValue("example", {
name: "example-apimg",
resourceGroupName: example.name,
apiManagementName: exampleService.name,
displayName: "ExampleProperty",
value: "Example Value",
});
const examplePolicy = new azure.apimanagement.Policy("example", {
apiManagementId: exampleService.id,
xmlContent: std.file({
input: "example.xml",
}).then(invoke => invoke.result),
});
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_named_value = azure.apimanagement.NamedValue("example",
name="example-apimg",
resource_group_name=example.name,
api_management_name=example_service.name,
display_name="ExampleProperty",
value="Example Value")
example_policy = azure.apimanagement.Policy("example",
api_management_id=example_service.id,
xml_content=std.file(input="example.xml").result)
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
}
_, err = apimanagement.NewNamedValue(ctx, "example", &apimanagement.NamedValueArgs{
Name: pulumi.String("example-apimg"),
ResourceGroupName: example.Name,
ApiManagementName: exampleService.Name,
DisplayName: pulumi.String("ExampleProperty"),
Value: pulumi.String("Example Value"),
})
if err != nil {
return err
}
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "example.xml",
}, nil)
if err != nil {
return err
}
_, err = apimanagement.NewPolicy(ctx, "example", &apimanagement.PolicyArgs{
ApiManagementId: exampleService.ID(),
XmlContent: pulumi.String(invokeFile.Result),
})
if err != nil {
return err
}
return nil
})
}
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 exampleNamedValue = new Azure.ApiManagement.NamedValue("example", new()
{
Name = "example-apimg",
ResourceGroupName = example.Name,
ApiManagementName = exampleService.Name,
DisplayName = "ExampleProperty",
Value = "Example Value",
});
var examplePolicy = new Azure.ApiManagement.Policy("example", new()
{
ApiManagementId = exampleService.Id,
XmlContent = Std.File.Invoke(new()
{
Input = "example.xml",
}).Apply(invoke => invoke.Result),
});
});
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.NamedValue;
import com.pulumi.azure.apimanagement.NamedValueArgs;
import com.pulumi.azure.apimanagement.Policy;
import com.pulumi.azure.apimanagement.PolicyArgs;
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 exampleNamedValue = new NamedValue("exampleNamedValue", NamedValueArgs.builder()
.name("example-apimg")
.resourceGroupName(example.name())
.apiManagementName(exampleService.name())
.displayName("ExampleProperty")
.value("Example Value")
.build());
var examplePolicy = new Policy("examplePolicy", PolicyArgs.builder()
.apiManagementId(exampleService.id())
.xmlContent(StdFunctions.file(FileArgs.builder()
.input("example.xml")
.build()).result())
.build());
}
}
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
exampleNamedValue:
type: azure:apimanagement:NamedValue
name: example
properties:
name: example-apimg
resourceGroupName: ${example.name}
apiManagementName: ${exampleService.name}
displayName: ExampleProperty
value: Example Value
examplePolicy:
type: azure:apimanagement:Policy
name: example
properties:
apiManagementId: ${exampleService.id}
xmlContent:
fn::invoke:
Function: std:file
Arguments:
input: example.xml
Return: result
Create Policy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);
@overload
def Policy(resource_name: str,
args: PolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Policy(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_management_id: Optional[str] = None,
xml_content: Optional[str] = None,
xml_link: Optional[str] = None)
func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)
type: azure:apimanagement:Policy
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 PolicyArgs
- 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 PolicyArgs
- 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 PolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyArgs
- 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 policyResource = new Azure.ApiManagement.Policy("policyResource", new()
{
ApiManagementId = "string",
XmlContent = "string",
XmlLink = "string",
});
example, err := apimanagement.NewPolicy(ctx, "policyResource", &apimanagement.PolicyArgs{
ApiManagementId: pulumi.String("string"),
XmlContent: pulumi.String("string"),
XmlLink: pulumi.String("string"),
})
var policyResource = new Policy("policyResource", PolicyArgs.builder()
.apiManagementId("string")
.xmlContent("string")
.xmlLink("string")
.build());
policy_resource = azure.apimanagement.Policy("policyResource",
api_management_id="string",
xml_content="string",
xml_link="string")
const policyResource = new azure.apimanagement.Policy("policyResource", {
apiManagementId: "string",
xmlContent: "string",
xmlLink: "string",
});
type: azure:apimanagement:Policy
properties:
apiManagementId: string
xmlContent: string
xmlLink: string
Policy 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 Policy resource accepts the following input properties:
- Api
Management stringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- Xml
Content string - The XML Content for this Policy as a string.
- Xml
Link string - A link to a Policy XML Document, which must be publicly available.
- Api
Management stringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- Xml
Content string - The XML Content for this Policy as a string.
- Xml
Link string - A link to a Policy XML Document, which must be publicly available.
- api
Management StringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml
Content String - The XML Content for this Policy as a string.
- xml
Link String - A link to a Policy XML Document, which must be publicly available.
- api
Management stringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml
Content string - The XML Content for this Policy as a string.
- xml
Link string - A link to a Policy XML Document, which must be publicly available.
- api_
management_ strid - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml_
content str - The XML Content for this Policy as a string.
- xml_
link str - A link to a Policy XML Document, which must be publicly available.
- api
Management StringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml
Content String - The XML Content for this Policy as a string.
- xml
Link String - A link to a Policy XML Document, which must be publicly available.
Outputs
All input properties are implicitly available as output properties. Additionally, the Policy 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 Policy Resource
Get an existing Policy 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?: PolicyState, opts?: CustomResourceOptions): Policy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_management_id: Optional[str] = None,
xml_content: Optional[str] = None,
xml_link: Optional[str] = None) -> Policy
func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)
public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)
public static Policy get(String name, Output<String> id, PolicyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Api
Management stringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- Xml
Content string - The XML Content for this Policy as a string.
- Xml
Link string - A link to a Policy XML Document, which must be publicly available.
- Api
Management stringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- Xml
Content string - The XML Content for this Policy as a string.
- Xml
Link string - A link to a Policy XML Document, which must be publicly available.
- api
Management StringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml
Content String - The XML Content for this Policy as a string.
- xml
Link String - A link to a Policy XML Document, which must be publicly available.
- api
Management stringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml
Content string - The XML Content for this Policy as a string.
- xml
Link string - A link to a Policy XML Document, which must be publicly available.
- api_
management_ strid - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml_
content str - The XML Content for this Policy as a string.
- xml_
link str - A link to a Policy XML Document, which must be publicly available.
- api
Management StringId - The ID of the API Management service. Changing this forces a new API Management service Policy to be created.
- xml
Content String - The XML Content for this Policy as a string.
- xml
Link String - A link to a Policy XML Document, which must be publicly available.
Import
API Management service Policys can be imported using the resource id
, e.g.
$ pulumi import azure:apimanagement/policy:Policy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1
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.