Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. WorkspaceApiPolicy
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.WorkspaceApiPolicy

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Policy Contract details. Azure REST API version: 2022-09-01-preview.

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

Example Usage

ApiManagementCreateWorkspaceApiPolicy

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

return await Deployment.RunAsync(() => 
{
    var workspaceApiPolicy = new AzureNative.ApiManagement.WorkspaceApiPolicy("workspaceApiPolicy", new()
    {
        ApiId = "5600b57e7e8880006a040001",
        Format = AzureNative.ApiManagement.PolicyContentFormat.Xml,
        PolicyId = "policy",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        Value = "<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>",
        WorkspaceId = "wks1",
    });

});
Copy
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.NewWorkspaceApiPolicy(ctx, "workspaceApiPolicy", &apimanagement.WorkspaceApiPolicyArgs{
			ApiId:             pulumi.String("5600b57e7e8880006a040001"),
			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>"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceApiPolicy;
import com.pulumi.azurenative.apimanagement.WorkspaceApiPolicyArgs;
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 workspaceApiPolicy = new WorkspaceApiPolicy("workspaceApiPolicy", WorkspaceApiPolicyArgs.builder()
            .apiId("5600b57e7e8880006a040001")
            .format("xml")
            .policyId("policy")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .value("<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>")
            .workspaceId("wks1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspaceApiPolicy = new azure_native.apimanagement.WorkspaceApiPolicy("workspaceApiPolicy", {
    apiId: "5600b57e7e8880006a040001",
    format: azure_native.apimanagement.PolicyContentFormat.Xml,
    policyId: "policy",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    value: "<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>",
    workspaceId: "wks1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_api_policy = azure_native.apimanagement.WorkspaceApiPolicy("workspaceApiPolicy",
    api_id="5600b57e7e8880006a040001",
    format=azure_native.apimanagement.PolicyContentFormat.XML,
    policy_id="policy",
    resource_group_name="rg1",
    service_name="apimService1",
    value="<policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>",
    workspace_id="wks1")
Copy
resources:
  workspaceApiPolicy:
    type: azure-native:apimanagement:WorkspaceApiPolicy
    properties:
      apiId: 5600b57e7e8880006a040001
      format: xml
      policyId: policy
      resourceGroupName: rg1
      serviceName: apimService1
      value: <policies> <inbound /> <backend>    <forward-request />  </backend>  <outbound /></policies>
      workspaceId: wks1
Copy

Create WorkspaceApiPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkspaceApiPolicy(name: string, args: WorkspaceApiPolicyArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceApiPolicy(resource_name: str,
                       args: WorkspaceApiPolicyArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceApiPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       api_id: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       value: Optional[str] = None,
                       workspace_id: Optional[str] = None,
                       format: Optional[Union[str, PolicyContentFormat]] = None,
                       policy_id: Optional[str] = None)
func NewWorkspaceApiPolicy(ctx *Context, name string, args WorkspaceApiPolicyArgs, opts ...ResourceOption) (*WorkspaceApiPolicy, error)
public WorkspaceApiPolicy(string name, WorkspaceApiPolicyArgs args, CustomResourceOptions? opts = null)
public WorkspaceApiPolicy(String name, WorkspaceApiPolicyArgs args)
public WorkspaceApiPolicy(String name, WorkspaceApiPolicyArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:WorkspaceApiPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceApiPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceApiPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceApiPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceApiPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceApiPolicyArgs
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 workspaceApiPolicyResource = new AzureNative.Apimanagement.WorkspaceApiPolicy("workspaceApiPolicyResource", new()
{
    ApiId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    Value = "string",
    WorkspaceId = "string",
    Format = "string",
    PolicyId = "string",
});
Copy
example, err := apimanagement.NewWorkspaceApiPolicy(ctx, "workspaceApiPolicyResource", &apimanagement.WorkspaceApiPolicyArgs{
	ApiId:             "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	Value:             "string",
	WorkspaceId:       "string",
	Format:            "string",
	PolicyId:          "string",
})
Copy
var workspaceApiPolicyResource = new WorkspaceApiPolicy("workspaceApiPolicyResource", WorkspaceApiPolicyArgs.builder()
    .apiId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .value("string")
    .workspaceId("string")
    .format("string")
    .policyId("string")
    .build());
Copy
workspace_api_policy_resource = azure_native.apimanagement.WorkspaceApiPolicy("workspaceApiPolicyResource",
    api_id=string,
    resource_group_name=string,
    service_name=string,
    value=string,
    workspace_id=string,
    format=string,
    policy_id=string)
Copy
const workspaceApiPolicyResource = new azure_native.apimanagement.WorkspaceApiPolicy("workspaceApiPolicyResource", {
    apiId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    value: "string",
    workspaceId: "string",
    format: "string",
    policyId: "string",
});
Copy
type: azure-native:apimanagement:WorkspaceApiPolicy
properties:
    apiId: string
    format: string
    policyId: string
    resourceGroupName: string
    serviceName: string
    value: string
    workspaceId: string
Copy

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

ApiId
This property is required.
Changes to this property will trigger replacement.
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Value This property is required. string
Contents of the Policy as defined by the format.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Format string | Pulumi.AzureNative.ApiManagement.PolicyContentFormat
Format of the policyContent.
PolicyId Changes to this property will trigger replacement. string
The identifier of the Policy.
ApiId
This property is required.
Changes to this property will trigger replacement.
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Value This property is required. string
Contents of the Policy as defined by the format.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Format string | PolicyContentFormat
Format of the policyContent.
PolicyId Changes to this property will trigger replacement. string
The identifier of the Policy.
apiId
This property is required.
Changes to this property will trigger replacement.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
value This property is required. String
Contents of the Policy as defined by the format.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
format String | PolicyContentFormat
Format of the policyContent.
policyId Changes to this property will trigger replacement. String
The identifier of the Policy.
apiId
This property is required.
Changes to this property will trigger replacement.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
value This property is required. string
Contents of the Policy as defined by the format.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
format string | PolicyContentFormat
Format of the policyContent.
policyId Changes to this property will trigger replacement. string
The identifier of the Policy.
api_id
This property is required.
Changes to this property will trigger replacement.
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
value This property is required. str
Contents of the Policy as defined by the format.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
format str | PolicyContentFormat
Format of the policyContent.
policy_id Changes to this property will trigger replacement. str
The identifier of the Policy.
apiId
This property is required.
Changes to this property will trigger replacement.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
value This property is required. String
Contents of the Policy as defined by the format.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
format String | "xml" | "xml-link" | "rawxml" | "rawxml-link"
Format of the policyContent.
policyId Changes to this property will trigger replacement. String
The identifier of the Policy.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkspaceApiPolicy 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

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.
PolicyContentFormatXml
xmlThe contents are inline and Content type is an XML document.
PolicyContentFormat_Xml_Link
xml-linkThe policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
PolicyContentFormatRawxml
rawxmlThe contents are inline and Content type is a non XML encoded policy document.
PolicyContentFormat_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:WorkspaceApiPolicy policy /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native