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

azure-native-v2.apimanagement.PolicyRestriction

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.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

Policy restriction contract details. Azure REST API version: 2023-05-01-preview.

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

Example Usage

ApiManagementCreatePolicyRestriction

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

return await Deployment.RunAsync(() => 
{
    var policyRestriction = new AzureNative.ApiManagement.PolicyRestriction("policyRestriction", new()
    {
        PolicyRestrictionId = "policyRestriction1",
        RequireBase = AzureNative.ApiManagement.PolicyRestrictionRequireBase.@True,
        ResourceGroupName = "rg1",
        Scope = "Sample Path to the policy document.",
        ServiceName = "apimService1",
    });

});
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.NewPolicyRestriction(ctx, "policyRestriction", &apimanagement.PolicyRestrictionArgs{
			PolicyRestrictionId: pulumi.String("policyRestriction1"),
			RequireBase:         pulumi.String(apimanagement.PolicyRestrictionRequireBaseTrue),
			ResourceGroupName:   pulumi.String("rg1"),
			Scope:               pulumi.String("Sample Path to the policy document."),
			ServiceName:         pulumi.String("apimService1"),
		})
		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.PolicyRestriction;
import com.pulumi.azurenative.apimanagement.PolicyRestrictionArgs;
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 policyRestriction = new PolicyRestriction("policyRestriction", PolicyRestrictionArgs.builder()
            .policyRestrictionId("policyRestriction1")
            .requireBase("true")
            .resourceGroupName("rg1")
            .scope("Sample Path to the policy document.")
            .serviceName("apimService1")
            .build());

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

const policyRestriction = new azure_native.apimanagement.PolicyRestriction("policyRestriction", {
    policyRestrictionId: "policyRestriction1",
    requireBase: azure_native.apimanagement.PolicyRestrictionRequireBase.True,
    resourceGroupName: "rg1",
    scope: "Sample Path to the policy document.",
    serviceName: "apimService1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

policy_restriction = azure_native.apimanagement.PolicyRestriction("policyRestriction",
    policy_restriction_id="policyRestriction1",
    require_base=azure_native.apimanagement.PolicyRestrictionRequireBase.TRUE,
    resource_group_name="rg1",
    scope="Sample Path to the policy document.",
    service_name="apimService1")
Copy
resources:
  policyRestriction:
    type: azure-native:apimanagement:PolicyRestriction
    properties:
      policyRestrictionId: policyRestriction1
      requireBase: 'true'
      resourceGroupName: rg1
      scope: Sample Path to the policy document.
      serviceName: apimService1
Copy

Create PolicyRestriction Resource

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

Constructor syntax

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

@overload
def PolicyRestriction(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      policy_restriction_id: Optional[str] = None,
                      require_base: Optional[Union[str, PolicyRestrictionRequireBase]] = None,
                      scope: Optional[str] = None)
func NewPolicyRestriction(ctx *Context, name string, args PolicyRestrictionArgs, opts ...ResourceOption) (*PolicyRestriction, error)
public PolicyRestriction(string name, PolicyRestrictionArgs args, CustomResourceOptions? opts = null)
public PolicyRestriction(String name, PolicyRestrictionArgs args)
public PolicyRestriction(String name, PolicyRestrictionArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:PolicyRestriction
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. PolicyRestrictionArgs
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. PolicyRestrictionArgs
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. PolicyRestrictionArgs
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. PolicyRestrictionArgs
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. PolicyRestrictionArgs
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 policyRestrictionResource = new AzureNative.Apimanagement.PolicyRestriction("policyRestrictionResource", new()
{
    ResourceGroupName = "string",
    ServiceName = "string",
    PolicyRestrictionId = "string",
    RequireBase = "string",
    Scope = "string",
});
Copy
example, err := apimanagement.NewPolicyRestriction(ctx, "policyRestrictionResource", &apimanagement.PolicyRestrictionArgs{
	ResourceGroupName:   "string",
	ServiceName:         "string",
	PolicyRestrictionId: "string",
	RequireBase:         "string",
	Scope:               "string",
})
Copy
var policyRestrictionResource = new PolicyRestriction("policyRestrictionResource", PolicyRestrictionArgs.builder()
    .resourceGroupName("string")
    .serviceName("string")
    .policyRestrictionId("string")
    .requireBase("string")
    .scope("string")
    .build());
Copy
policy_restriction_resource = azure_native.apimanagement.PolicyRestriction("policyRestrictionResource",
    resource_group_name=string,
    service_name=string,
    policy_restriction_id=string,
    require_base=string,
    scope=string)
Copy
const policyRestrictionResource = new azure_native.apimanagement.PolicyRestriction("policyRestrictionResource", {
    resourceGroupName: "string",
    serviceName: "string",
    policyRestrictionId: "string",
    requireBase: "string",
    scope: "string",
});
Copy
type: azure-native:apimanagement:PolicyRestriction
properties:
    policyRestrictionId: string
    requireBase: string
    resourceGroupName: string
    scope: string
    serviceName: string
Copy

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

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.
PolicyRestrictionId Changes to this property will trigger replacement. string
Policy restrictions after an entity level
RequireBase string | Pulumi.AzureNative.ApiManagement.PolicyRestrictionRequireBase
Indicates if base policy should be enforced for the policy document.
Scope string
Path to the policy document.
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.
PolicyRestrictionId Changes to this property will trigger replacement. string
Policy restrictions after an entity level
RequireBase string | PolicyRestrictionRequireBase
Indicates if base policy should be enforced for the policy document.
Scope string
Path to the policy document.
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.
policyRestrictionId Changes to this property will trigger replacement. String
Policy restrictions after an entity level
requireBase String | PolicyRestrictionRequireBase
Indicates if base policy should be enforced for the policy document.
scope String
Path to the policy document.
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.
policyRestrictionId Changes to this property will trigger replacement. string
Policy restrictions after an entity level
requireBase string | PolicyRestrictionRequireBase
Indicates if base policy should be enforced for the policy document.
scope string
Path to the policy document.
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.
policy_restriction_id Changes to this property will trigger replacement. str
Policy restrictions after an entity level
require_base str | PolicyRestrictionRequireBase
Indicates if base policy should be enforced for the policy document.
scope str
Path to the policy document.
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.
policyRestrictionId Changes to this property will trigger replacement. String
Policy restrictions after an entity level
requireBase String | "true" | "false"
Indicates if base policy should be enforced for the policy document.
scope String
Path to the policy document.

Outputs

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

PolicyRestrictionRequireBase
, PolicyRestrictionRequireBaseArgs

@True
trueThe policy is required to have base policy
@False
falseThe policy does not require to have base policy
PolicyRestrictionRequireBaseTrue
trueThe policy is required to have base policy
PolicyRestrictionRequireBaseFalse
falseThe policy does not require to have base policy
True_
trueThe policy is required to have base policy
False_
falseThe policy does not require to have base policy
True
trueThe policy is required to have base policy
False
falseThe policy does not require to have base policy
TRUE
trueThe policy is required to have base policy
FALSE
falseThe policy does not require to have base policy
"true"
trueThe policy is required to have base policy
"false"
falseThe policy does not require to have base policy

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:PolicyRestriction policyRestrictions1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}
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.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native