ApiOperationPolicy

Policy Contract details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateApiOperationPolicy

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var apiOperationPolicy = new AzureNative.ApiManagement.ApiOperationPolicy("apiOperationPolicy", new()
    {
        ApiId = "5600b57e7e8880006a040001",
        Format = "xml",
        OperationId = "5600b57e7e8880006a080001",
        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/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiOperationPolicy(ctx, "apiOperationPolicy", &apimanagement.ApiOperationPolicyArgs{
			ApiId:             pulumi.String("5600b57e7e8880006a040001"),
			Format:            pulumi.String("xml"),
			OperationId:       pulumi.String("5600b57e7e8880006a080001"),
			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.ApiOperationPolicy;
import com.pulumi.azurenative.apimanagement.ApiOperationPolicyArgs;
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 apiOperationPolicy = new ApiOperationPolicy("apiOperationPolicy", ApiOperationPolicyArgs.builder()        
            .apiId("5600b57e7e8880006a040001")
            .format("xml")
            .operationId("5600b57e7e8880006a080001")
            .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

api_operation_policy = azure_native.apimanagement.ApiOperationPolicy("apiOperationPolicy",
    api_id="5600b57e7e8880006a040001",
    format="xml",
    operation_id="5600b57e7e8880006a080001",
    policy_id="policy",
    resource_group_name="rg1",
    service_name="apimService1",
    value="<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiOperationPolicy = new azure_native.apimanagement.ApiOperationPolicy("apiOperationPolicy", {
    apiId: "5600b57e7e8880006a040001",
    format: "xml",
    operationId: "5600b57e7e8880006a080001",
    policyId: "policy",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    value: "<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>",
});
resources:
  apiOperationPolicy:
    type: azure-native:apimanagement:ApiOperationPolicy
    properties:
      apiId: 5600b57e7e8880006a040001
      format: xml
      operationId: 5600b57e7e8880006a080001
      policyId: policy
      resourceGroupName: rg1
      serviceName: apimService1
      value: <policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>

Create ApiOperationPolicy Resource

new ApiOperationPolicy(name: string, args: ApiOperationPolicyArgs, opts?: CustomResourceOptions);
@overload
def ApiOperationPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       api_id: Optional[str] = None,
                       format: Optional[Union[str, PolicyContentFormat]] = None,
                       operation_id: Optional[str] = None,
                       policy_id: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       value: Optional[str] = None)
@overload
def ApiOperationPolicy(resource_name: str,
                       args: ApiOperationPolicyArgs,
                       opts: Optional[ResourceOptions] = None)
func NewApiOperationPolicy(ctx *Context, name string, args ApiOperationPolicyArgs, opts ...ResourceOption) (*ApiOperationPolicy, error)
public ApiOperationPolicy(string name, ApiOperationPolicyArgs args, CustomResourceOptions? opts = null)
public ApiOperationPolicy(String name, ApiOperationPolicyArgs args)
public ApiOperationPolicy(String name, ApiOperationPolicyArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ApiOperationPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

ApiOperationPolicy 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 ApiOperationPolicy resource accepts the following input properties:

ApiId string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

OperationId string

Operation identifier within an API. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Value string

Contents of the Policy as defined by the format.

Format string | Pulumi.AzureNative.ApiManagement.PolicyContentFormat

Format of the policyContent.

PolicyId string

The identifier of the Policy.

ApiId string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

OperationId string

Operation identifier within an API. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Value string

Contents of the Policy as defined by the format.

Format string | PolicyContentFormat

Format of the policyContent.

PolicyId string

The identifier of the Policy.

apiId String

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId String

Operation identifier within an API. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

value String

Contents of the Policy as defined by the format.

format String | PolicyContentFormat

Format of the policyContent.

policyId String

The identifier of the Policy.

apiId string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId string

Operation identifier within an API. Must be unique in the current API Management service instance.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

value string

Contents of the Policy as defined by the format.

format string | PolicyContentFormat

Format of the policyContent.

policyId string

The identifier of the Policy.

api_id str

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operation_id str

Operation identifier within an API. Must be unique in the current API Management service instance.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

value str

Contents of the Policy as defined by the format.

format str | PolicyContentFormat

Format of the policyContent.

policy_id str

The identifier of the Policy.

apiId String

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId String

Operation identifier within an API. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

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 ApiOperationPolicy resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

type string

Resource type for API Management resource.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

type str

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

Supporting Types

PolicyContentFormat

Xml
xml

The contents are inline and Content type is an XML document.

Xml_link
xml-link

The policy XML document is hosted on a http endpoint accessible from the API Management service.

Rawxml
rawxml

The contents are inline and Content type is a non XML encoded policy document.

Rawxml_link
rawxml-link

The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.

PolicyContentFormatXml
xml

The contents are inline and Content type is an XML document.

PolicyContentFormat_Xml_Link
xml-link

The policy XML document is hosted on a http endpoint accessible from the API Management service.

PolicyContentFormatRawxml
rawxml

The contents are inline and Content type is a non XML encoded policy document.

PolicyContentFormat_Rawxml_Link
rawxml-link

The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.

Xml
xml

The contents are inline and Content type is an XML document.

Xmllink
xml-link

The policy XML document is hosted on a http endpoint accessible from the API Management service.

Rawxml
rawxml

The contents are inline and Content type is a non XML encoded policy document.

Rawxmllink
rawxml-link

The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.

Xml
xml

The contents are inline and Content type is an XML document.

Xml_link
xml-link

The policy XML document is hosted on a http endpoint accessible from the API Management service.

Rawxml
rawxml

The contents are inline and Content type is a non XML encoded policy document.

Rawxml_link
rawxml-link

The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.

XML
xml

The contents are inline and Content type is an XML document.

XML_LINK
xml-link

The policy XML document is hosted on a http endpoint accessible from the API Management service.

RAWXML
rawxml

The contents are inline and Content type is a non XML encoded policy document.

RAWXML_LINK
rawxml-link

The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.

"xml"
xml

The contents are inline and Content type is an XML document.

"xml-link"
xml-link

The policy XML document is hosted on a http endpoint accessible from the API Management service.

"rawxml"
rawxml

The contents are inline and Content type is a non XML encoded policy document.

"rawxml-link"
rawxml-link

The 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:ApiOperationPolicy policy /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0