azure-native.apimanagement.Policy
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: 2018-06-01-preview, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
Example Usage
ApiManagementCreatePolicy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var policy = new AzureNative.ApiManagement.Policy("policy", new()
{
Format = AzureNative.ApiManagement.PolicyContentFormat.Xml,
PolicyId = "policy",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Value = @"<policies>
<inbound />
<backend>
<forward-request />
</backend>
<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.NewPolicy(ctx, "policy", &apimanagement.PolicyArgs{
Format: pulumi.String(apimanagement.PolicyContentFormatXml),
PolicyId: pulumi.String("policy"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Value: pulumi.String(`<policies>
<inbound />
<backend>
<forward-request />
</backend>
<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.Policy;
import com.pulumi.azurenative.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 policy = new Policy("policy", PolicyArgs.builder()
.format("xml")
.policyId("policy")
.resourceGroupName("rg1")
.serviceName("apimService1")
.value("""
<policies>
<inbound />
<backend>
<forward-request />
</backend>
<outbound />
</policies> """)
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
policy = azure_native.apimanagement.Policy("policy",
format=azure_native.apimanagement.PolicyContentFormat.XML,
policy_id="policy",
resource_group_name="rg1",
service_name="apimService1",
value="""<policies>\x0d
<inbound />\x0d
<backend>\x0d
<forward-request />\x0d
</backend>\x0d
<outbound />\x0d
</policies>""")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const policy = new azure_native.apimanagement.Policy("policy", {
format: azure_native.apimanagement.PolicyContentFormat.Xml,
policyId: "policy",
resourceGroupName: "rg1",
serviceName: "apimService1",
value: `<policies>\x0d
<inbound />\x0d
<backend>\x0d
<forward-request />\x0d
</backend>\x0d
<outbound />\x0d
</policies>`,
});
resources:
policy:
type: azure-native:apimanagement:Policy
properties:
format: xml
policyId: policy
resourceGroupName: rg1
serviceName: apimService1
value: "<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"
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,
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 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-native: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 AzureNative.ApiManagement.Policy("policyResource", new()
{
ResourceGroupName = "string",
ServiceName = "string",
Value = "string",
Format = "string",
PolicyId = "string",
});
example, err := apimanagement.NewPolicy(ctx, "policyResource", &apimanagement.PolicyArgs{
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Value: pulumi.String("string"),
Format: pulumi.String("string"),
PolicyId: pulumi.String("string"),
})
var policyResource = new Policy("policyResource", PolicyArgs.builder()
.resourceGroupName("string")
.serviceName("string")
.value("string")
.format("string")
.policyId("string")
.build());
policy_resource = azure_native.apimanagement.Policy("policyResource",
resource_group_name="string",
service_name="string",
value="string",
format="string",
policy_id="string")
const policyResource = new azure_native.apimanagement.Policy("policyResource", {
resourceGroupName: "string",
serviceName: "string",
value: "string",
format: "string",
policyId: "string",
});
type: azure-native:apimanagement:Policy
properties:
format: string
policyId: string
resourceGroupName: string
serviceName: string
value: 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:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name 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.
- Policy
Id string - The identifier of the Policy.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Value string
- Contents of the Policy as defined by the format.
- Format
string | Policy
Content Format - Format of the policyContent.
- Policy
Id string - The identifier of the Policy.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- value String
- Contents of the Policy as defined by the format.
- format
String | Policy
Content Format - Format of the policyContent.
- policy
Id String - The identifier of the Policy.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- value string
- Contents of the Policy as defined by the format.
- format
string | Policy
Content Format - Format of the policyContent.
- policy
Id string - The identifier of the Policy.
- 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 | Policy
Content Format - Format of the policyContent.
- policy_
id str - The identifier of the Policy.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name 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.
- policy
Id String - The identifier of the Policy.
Outputs
All input properties are implicitly available as output properties. Additionally, the Policy 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.
- Policy
Content Format Xml - xmlThe contents are inline and Content type is an XML document.
- Policy
Content Format_Xml_Link - xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
- Policy
Content Format Rawxml - rawxmlThe contents are inline and Content type is a non XML encoded policy document.
- Policy
Content 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:Policy policy /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/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