1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. PolicyRestriction
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.PolicyRestriction

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Policy restriction contract details. Azure REST API version: 2023-05-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",
        });
    
    });
    
    package main
    
    import (
    	"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
    	})
    }
    
    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());
    
        }
    }
    
    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")
    
    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",
    });
    
    resources:
      policyRestriction:
        type: azure-native:apimanagement:PolicyRestriction
        properties:
          policyRestrictionId: policyRestriction1
          requireBase: 'true'
          resourceGroupName: rg1
          scope: Sample Path to the policy document.
          serviceName: apimService1
    

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

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

    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

    The PolicyRestriction resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    PolicyRestrictionId 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 string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    PolicyRestrictionId 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 String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    policyRestrictionId 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 string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    policyRestrictionId 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 str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    policy_restriction_id 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 String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    policyRestrictionId 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} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi