Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. policy
  5. PolicySetDefinition

We recommend using Azure Native.

Azure v6.26.0 published on Wednesday, Sep 10, 2025 by Pulumi
pulumi/pulumi-azure

azure.policy.PolicySetDefinition

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.26.0 published on Wednesday, Sep 10, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Policy Set Definition.

    Note: Policy set definitions (also known as policy initiatives) do not take effect until they are assigned to a scope using a Policy Set Assignment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.policy.PolicySetDefinition("example", {
    name: "example",
    policyType: "Custom",
    displayName: "Example",
    parameters: `    {
        "allowedLocations": {
            "type": "Array",
            "metadata": {
                "description": "The list of allowed locations for resources.",
                "displayName": "Allowed locations",
                "strongType": "location"
            }
        }
    }
`,
    policyDefinitionReferences: [{
        version: "1.0.*",
        policyDefinitionId: "/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988",
        parameterValues: `    {
      "listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
    }
`,
    }],
});

    import pulumi
import pulumi_azure as azure

example = azure.policy.PolicySetDefinition("example",
    name="example",
    policy_type="Custom",
    display_name="Example",
    parameters="""    {
        "allowedLocations": {
            "type": "Array",
            "metadata": {
                "description": "The list of allowed locations for resources.",
                "displayName": "Allowed locations",
                "strongType": "location"
            }
        }
    }
""",
    policy_definition_references=[{
        "version": "1.0.*",
        "policy_definition_id": "/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988",
        "parameter_values": """    {
      "listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
    }
""",
    }])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/policy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := policy.NewPolicySetDefinition(ctx, "example", &policy.PolicySetDefinitionArgs{
			Name:        pulumi.String("example"),
			PolicyType:  pulumi.String("Custom"),
			DisplayName: pulumi.String("Example"),
			Parameters: pulumi.String(`    {
        "allowedLocations": {
            "type": "Array",
            "metadata": {
                "description": "The list of allowed locations for resources.",
                "displayName": "Allowed locations",
                "strongType": "location"
            }
        }
    }
`),
			PolicyDefinitionReferences: policy.PolicySetDefinitionPolicyDefinitionReferenceArray{
				&policy.PolicySetDefinitionPolicyDefinitionReferenceArgs{
					Version:            pulumi.String("1.0.*"),
					PolicyDefinitionId: pulumi.String("/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988"),
					ParameterValues:    pulumi.String("    {\n      \"listOfAllowedLocations\": {\"value\": \"[parameters('allowedLocations')]\"}\n    }\n"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Policy.PolicySetDefinition("example", new()
    {
        Name = "example",
        PolicyType = "Custom",
        DisplayName = "Example",
        Parameters = @"    {
        ""allowedLocations"": {
            ""type"": ""Array"",
            ""metadata"": {
                ""description"": ""The list of allowed locations for resources."",
                ""displayName"": ""Allowed locations"",
                ""strongType"": ""location""
            }
        }
    }
",
        PolicyDefinitionReferences = new[]
        {
            new Azure.Policy.Inputs.PolicySetDefinitionPolicyDefinitionReferenceArgs
            {
                Version = "1.0.*",
                PolicyDefinitionId = "/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988",
                ParameterValues = @"    {
      ""listOfAllowedLocations"": {""value"": ""[parameters('allowedLocations')]""}
    }
",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.policy.PolicySetDefinition;
import com.pulumi.azure.policy.PolicySetDefinitionArgs;
import com.pulumi.azure.policy.inputs.PolicySetDefinitionPolicyDefinitionReferenceArgs;
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 example = new PolicySetDefinition("example", PolicySetDefinitionArgs.builder()
            .name("example")
            .policyType("Custom")
            .displayName("Example")
            .parameters("""
    {
        "allowedLocations": {
            "type": "Array",
            "metadata": {
                "description": "The list of allowed locations for resources.",
                "displayName": "Allowed locations",
                "strongType": "location"
            }
        }
    }
            """)
            .policyDefinitionReferences(PolicySetDefinitionPolicyDefinitionReferenceArgs.builder()
                .version("1.0.*")
                .policyDefinitionId("/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988")
                .parameterValues("""
    {
      "listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
    }
                """)
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:policy:PolicySetDefinition
    properties:
      name: example
      policyType: Custom
      displayName: Example
      parameters: |2
            {
                "allowedLocations": {
                    "type": "Array",
                    "metadata": {
                        "description": "The list of allowed locations for resources.",
                        "displayName": "Allowed locations",
                        "strongType": "location"
                    }
                }
            }
      policyDefinitionReferences:
        - version: 1.0.*
          policyDefinitionId: /providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988
          parameterValues: |2
                {
                  "listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
                }

    API Providers

    This resource uses the following Azure API Providers:

    • Microsoft.Authorization - 2025-01-01

    • Microsoft.Management - 2025-01-01

    Create PolicySetDefinition Resource

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

    Constructor syntax

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

@overload
def PolicySetDefinition(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        display_name: Optional[str] = None,
                        policy_definition_references: Optional[Sequence[PolicySetDefinitionPolicyDefinitionReferenceArgs]] = None,
                        policy_type: Optional[str] = None,
                        description: Optional[str] = None,
                        management_group_id: Optional[str] = None,
                        metadata: Optional[str] = None,
                        name: Optional[str] = None,
                        parameters: Optional[str] = None,
                        policy_definition_groups: Optional[Sequence[PolicySetDefinitionPolicyDefinitionGroupArgs]] = None)
    func NewPolicySetDefinition(ctx *Context, name string, args PolicySetDefinitionArgs, opts ...ResourceOption) (*PolicySetDefinition, error)
    public PolicySetDefinition(string name, PolicySetDefinitionArgs args, CustomResourceOptions? opts = null)
    public PolicySetDefinition(String name, PolicySetDefinitionArgs args)
public PolicySetDefinition(String name, PolicySetDefinitionArgs args, CustomResourceOptions options)

    type: azure:policy:PolicySetDefinition
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 PolicySetDefinitionArgs
    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 PolicySetDefinitionArgs
    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 PolicySetDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicySetDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicySetDefinitionArgs
    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 policySetDefinitionResource = new Azure.Policy.PolicySetDefinition("policySetDefinitionResource", new()
{
    DisplayName = "string",
    PolicyDefinitionReferences = new[]
    {
        new Azure.Policy.Inputs.PolicySetDefinitionPolicyDefinitionReferenceArgs
        {
            PolicyDefinitionId = "string",
            ParameterValues = "string",
            PolicyGroupNames = new[]
            {
                "string",
            },
            ReferenceId = "string",
            Version = "string",
        },
    },
    PolicyType = "string",
    Description = "string",
    Metadata = "string",
    Name = "string",
    Parameters = "string",
    PolicyDefinitionGroups = new[]
    {
        new Azure.Policy.Inputs.PolicySetDefinitionPolicyDefinitionGroupArgs
        {
            Name = "string",
            AdditionalMetadataResourceId = "string",
            Category = "string",
            Description = "string",
            DisplayName = "string",
        },
    },
});

    example, err := policy.NewPolicySetDefinition(ctx, "policySetDefinitionResource", &policy.PolicySetDefinitionArgs{
	DisplayName: pulumi.String("string"),
	PolicyDefinitionReferences: policy.PolicySetDefinitionPolicyDefinitionReferenceArray{
		&policy.PolicySetDefinitionPolicyDefinitionReferenceArgs{
			PolicyDefinitionId: pulumi.String("string"),
			ParameterValues:    pulumi.String("string"),
			PolicyGroupNames: pulumi.StringArray{
				pulumi.String("string"),
			},
			ReferenceId: pulumi.String("string"),
			Version:     pulumi.String("string"),
		},
	},
	PolicyType:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Metadata:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	Parameters:  pulumi.String("string"),
	PolicyDefinitionGroups: policy.PolicySetDefinitionPolicyDefinitionGroupArray{
		&policy.PolicySetDefinitionPolicyDefinitionGroupArgs{
			Name:                         pulumi.String("string"),
			AdditionalMetadataResourceId: pulumi.String("string"),
			Category:                     pulumi.String("string"),
			Description:                  pulumi.String("string"),
			DisplayName:                  pulumi.String("string"),
		},
	},
})

    var policySetDefinitionResource = new PolicySetDefinition("policySetDefinitionResource", PolicySetDefinitionArgs.builder()
    .displayName("string")
    .policyDefinitionReferences(PolicySetDefinitionPolicyDefinitionReferenceArgs.builder()
        .policyDefinitionId("string")
        .parameterValues("string")
        .policyGroupNames("string")
        .referenceId("string")
        .version("string")
        .build())
    .policyType("string")
    .description("string")
    .metadata("string")
    .name("string")
    .parameters("string")
    .policyDefinitionGroups(PolicySetDefinitionPolicyDefinitionGroupArgs.builder()
        .name("string")
        .additionalMetadataResourceId("string")
        .category("string")
        .description("string")
        .displayName("string")
        .build())
    .build());

    policy_set_definition_resource = azure.policy.PolicySetDefinition("policySetDefinitionResource",
    display_name="string",
    policy_definition_references=[{
        "policy_definition_id": "string",
        "parameter_values": "string",
        "policy_group_names": ["string"],
        "reference_id": "string",
        "version": "string",
    }],
    policy_type="string",
    description="string",
    metadata="string",
    name="string",
    parameters="string",
    policy_definition_groups=[{
        "name": "string",
        "additional_metadata_resource_id": "string",
        "category": "string",
        "description": "string",
        "display_name": "string",
    }])

    const policySetDefinitionResource = new azure.policy.PolicySetDefinition("policySetDefinitionResource", {
    displayName: "string",
    policyDefinitionReferences: [{
        policyDefinitionId: "string",
        parameterValues: "string",
        policyGroupNames: ["string"],
        referenceId: "string",
        version: "string",
    }],
    policyType: "string",
    description: "string",
    metadata: "string",
    name: "string",
    parameters: "string",
    policyDefinitionGroups: [{
        name: "string",
        additionalMetadataResourceId: "string",
        category: "string",
        description: "string",
        displayName: "string",
    }],
});

    type: azure:policy:PolicySetDefinition
properties:
    description: string
    displayName: string
    metadata: string
    name: string
    parameters: string
    policyDefinitionGroups:
        - additionalMetadataResourceId: string
          category: string
          description: string
          displayName: string
          name: string
    policyDefinitionReferences:
        - parameterValues: string
          policyDefinitionId: string
          policyGroupNames:
            - string
          referenceId: string
          version: string
    policyType: string

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

    DisplayName string
    The display name of this Policy Set Definition.
    PolicyDefinitionReferences List<PolicySetDefinitionPolicyDefinitionReference>
    One or more policy_definition_reference blocks as defined below.
    PolicyType string
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    Description string
    The description of this Policy Set Definition.
    ManagementGroupId string

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    Metadata string
    The metadata for the Policy Set Definition in JSON format.
    Name string
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    Parameters string
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    PolicyDefinitionGroups List<PolicySetDefinitionPolicyDefinitionGroup>
    One or more policy_definition_group blocks as defined below.
    DisplayName string
    The display name of this Policy Set Definition.
    PolicyDefinitionReferences []PolicySetDefinitionPolicyDefinitionReferenceArgs
    One or more policy_definition_reference blocks as defined below.
    PolicyType string
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    Description string
    The description of this Policy Set Definition.
    ManagementGroupId string

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    Metadata string
    The metadata for the Policy Set Definition in JSON format.
    Name string
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    Parameters string
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    PolicyDefinitionGroups []PolicySetDefinitionPolicyDefinitionGroupArgs
    One or more policy_definition_group blocks as defined below.
    displayName String
    The display name of this Policy Set Definition.
    policyDefinitionReferences List<PolicySetDefinitionPolicyDefinitionReference>
    One or more policy_definition_reference blocks as defined below.
    policyType String
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description String
    The description of this Policy Set Definition.
    managementGroupId String

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata String
    The metadata for the Policy Set Definition in JSON format.
    name String
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters String
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policyDefinitionGroups List<PolicySetDefinitionPolicyDefinitionGroup>
    One or more policy_definition_group blocks as defined below.
    displayName string
    The display name of this Policy Set Definition.
    policyDefinitionReferences PolicySetDefinitionPolicyDefinitionReference[]
    One or more policy_definition_reference blocks as defined below.
    policyType string
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description string
    The description of this Policy Set Definition.
    managementGroupId string

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata string
    The metadata for the Policy Set Definition in JSON format.
    name string
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters string
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policyDefinitionGroups PolicySetDefinitionPolicyDefinitionGroup[]
    One or more policy_definition_group blocks as defined below.
    display_name str
    The display name of this Policy Set Definition.
    policy_definition_references Sequence[PolicySetDefinitionPolicyDefinitionReferenceArgs]
    One or more policy_definition_reference blocks as defined below.
    policy_type str
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description str
    The description of this Policy Set Definition.
    management_group_id str

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata str
    The metadata for the Policy Set Definition in JSON format.
    name str
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters str
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policy_definition_groups Sequence[PolicySetDefinitionPolicyDefinitionGroupArgs]
    One or more policy_definition_group blocks as defined below.
    displayName String
    The display name of this Policy Set Definition.
    policyDefinitionReferences List<Property Map>
    One or more policy_definition_reference blocks as defined below.
    policyType String
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description String
    The description of this Policy Set Definition.
    managementGroupId String

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata String
    The metadata for the Policy Set Definition in JSON format.
    name String
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters String
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policyDefinitionGroups List<Property Map>
    One or more policy_definition_group blocks as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicySetDefinition resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PolicySetDefinition Resource

    Get an existing PolicySetDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PolicySetDefinitionState, opts?: CustomResourceOptions): PolicySetDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        management_group_id: Optional[str] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[str] = None,
        policy_definition_groups: Optional[Sequence[PolicySetDefinitionPolicyDefinitionGroupArgs]] = None,
        policy_definition_references: Optional[Sequence[PolicySetDefinitionPolicyDefinitionReferenceArgs]] = None,
        policy_type: Optional[str] = None) -> PolicySetDefinition
    func GetPolicySetDefinition(ctx *Context, name string, id IDInput, state *PolicySetDefinitionState, opts ...ResourceOption) (*PolicySetDefinition, error)
    public static PolicySetDefinition Get(string name, Input<string> id, PolicySetDefinitionState? state, CustomResourceOptions? opts = null)
    public static PolicySetDefinition get(String name, Output<String> id, PolicySetDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: azure:policy:PolicySetDefinition    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of this Policy Set Definition.
    DisplayName string
    The display name of this Policy Set Definition.
    ManagementGroupId string

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    Metadata string
    The metadata for the Policy Set Definition in JSON format.
    Name string
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    Parameters string
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    PolicyDefinitionGroups List<PolicySetDefinitionPolicyDefinitionGroup>
    One or more policy_definition_group blocks as defined below.
    PolicyDefinitionReferences List<PolicySetDefinitionPolicyDefinitionReference>
    One or more policy_definition_reference blocks as defined below.
    PolicyType string
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    Description string
    The description of this Policy Set Definition.
    DisplayName string
    The display name of this Policy Set Definition.
    ManagementGroupId string

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    Metadata string
    The metadata for the Policy Set Definition in JSON format.
    Name string
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    Parameters string
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    PolicyDefinitionGroups []PolicySetDefinitionPolicyDefinitionGroupArgs
    One or more policy_definition_group blocks as defined below.
    PolicyDefinitionReferences []PolicySetDefinitionPolicyDefinitionReferenceArgs
    One or more policy_definition_reference blocks as defined below.
    PolicyType string
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description String
    The description of this Policy Set Definition.
    displayName String
    The display name of this Policy Set Definition.
    managementGroupId String

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata String
    The metadata for the Policy Set Definition in JSON format.
    name String
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters String
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policyDefinitionGroups List<PolicySetDefinitionPolicyDefinitionGroup>
    One or more policy_definition_group blocks as defined below.
    policyDefinitionReferences List<PolicySetDefinitionPolicyDefinitionReference>
    One or more policy_definition_reference blocks as defined below.
    policyType String
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description string
    The description of this Policy Set Definition.
    displayName string
    The display name of this Policy Set Definition.
    managementGroupId string

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata string
    The metadata for the Policy Set Definition in JSON format.
    name string
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters string
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policyDefinitionGroups PolicySetDefinitionPolicyDefinitionGroup[]
    One or more policy_definition_group blocks as defined below.
    policyDefinitionReferences PolicySetDefinitionPolicyDefinitionReference[]
    One or more policy_definition_reference blocks as defined below.
    policyType string
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description str
    The description of this Policy Set Definition.
    display_name str
    The display name of this Policy Set Definition.
    management_group_id str

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata str
    The metadata for the Policy Set Definition in JSON format.
    name str
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters str
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policy_definition_groups Sequence[PolicySetDefinitionPolicyDefinitionGroupArgs]
    One or more policy_definition_group blocks as defined below.
    policy_definition_references Sequence[PolicySetDefinitionPolicyDefinitionReferenceArgs]
    One or more policy_definition_reference blocks as defined below.
    policy_type str
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.
    description String
    The description of this Policy Set Definition.
    displayName String
    The display name of this Policy Set Definition.
    managementGroupId String

    Deprecated: management_group_id has been deprecated in favour of the azure.management.GroupPolicySetDefinition resource and will be removed in v5.0 of the AzureRM Provider.

    metadata String
    The metadata for the Policy Set Definition in JSON format.
    name String
    The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
    parameters String
    The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
    policyDefinitionGroups List<Property Map>
    One or more policy_definition_group blocks as defined below.
    policyDefinitionReferences List<Property Map>
    One or more policy_definition_reference blocks as defined below.
    policyType String
    The Policy Set Definition type. Possible values are BuiltIn, Custom, NotSpecified, and Static. Changing this forces a new Policy Set Definition to be created.

    Supporting Types

    PolicySetDefinitionPolicyDefinitionGroup, PolicySetDefinitionPolicyDefinitionGroupArgs

    Name string
    The name which should be used for this Policy Definition Group.
    AdditionalMetadataResourceId string
    The ID of a resource that contains additional metadata for this Policy Definition Group.
    Category string
    The category of this Policy Definition Group.
    Description string
    The description of this Policy Definition Group.
    DisplayName string
    The display name of this Policy Definition Group.
    Name string
    The name which should be used for this Policy Definition Group.
    AdditionalMetadataResourceId string
    The ID of a resource that contains additional metadata for this Policy Definition Group.
    Category string
    The category of this Policy Definition Group.
    Description string
    The description of this Policy Definition Group.
    DisplayName string
    The display name of this Policy Definition Group.
    name String
    The name which should be used for this Policy Definition Group.
    additionalMetadataResourceId String
    The ID of a resource that contains additional metadata for this Policy Definition Group.
    category String
    The category of this Policy Definition Group.
    description String
    The description of this Policy Definition Group.
    displayName String
    The display name of this Policy Definition Group.
    name string
    The name which should be used for this Policy Definition Group.
    additionalMetadataResourceId string
    The ID of a resource that contains additional metadata for this Policy Definition Group.
    category string
    The category of this Policy Definition Group.
    description string
    The description of this Policy Definition Group.
    displayName string
    The display name of this Policy Definition Group.
    name str
    The name which should be used for this Policy Definition Group.
    additional_metadata_resource_id str
    The ID of a resource that contains additional metadata for this Policy Definition Group.
    category str
    The category of this Policy Definition Group.
    description str
    The description of this Policy Definition Group.
    display_name str
    The display name of this Policy Definition Group.
    name String
    The name which should be used for this Policy Definition Group.
    additionalMetadataResourceId String
    The ID of a resource that contains additional metadata for this Policy Definition Group.
    category String
    The category of this Policy Definition Group.
    description String
    The description of this Policy Definition Group.
    displayName String
    The display name of this Policy Definition Group.

    PolicySetDefinitionPolicyDefinitionReference, PolicySetDefinitionPolicyDefinitionReferenceArgs

    PolicyDefinitionId string
    The ID of the Policy Definition to include in this Policy Set Definition.
    ParameterValues string
    Parameter values for the references Policy Definition in JSON format.
    PolicyGroupNames List<string>
    Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
    ReferenceId string
    A unique ID within this Policy Set Definition for this Policy Definition Reference.
    Version string
    The version of the Policy Definition to use.
    PolicyDefinitionId string
    The ID of the Policy Definition to include in this Policy Set Definition.
    ParameterValues string
    Parameter values for the references Policy Definition in JSON format.
    PolicyGroupNames []string
    Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
    ReferenceId string
    A unique ID within this Policy Set Definition for this Policy Definition Reference.
    Version string
    The version of the Policy Definition to use.
    policyDefinitionId String
    The ID of the Policy Definition to include in this Policy Set Definition.
    parameterValues String
    Parameter values for the references Policy Definition in JSON format.
    policyGroupNames List<String>
    Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
    referenceId String
    A unique ID within this Policy Set Definition for this Policy Definition Reference.
    version String
    The version of the Policy Definition to use.
    policyDefinitionId string
    The ID of the Policy Definition to include in this Policy Set Definition.
    parameterValues string
    Parameter values for the references Policy Definition in JSON format.
    policyGroupNames string[]
    Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
    referenceId string
    A unique ID within this Policy Set Definition for this Policy Definition Reference.
    version string
    The version of the Policy Definition to use.
    policy_definition_id str
    The ID of the Policy Definition to include in this Policy Set Definition.
    parameter_values str
    Parameter values for the references Policy Definition in JSON format.
    policy_group_names Sequence[str]
    Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
    reference_id str
    A unique ID within this Policy Set Definition for this Policy Definition Reference.
    version str
    The version of the Policy Definition to use.
    policyDefinitionId String
    The ID of the Policy Definition to include in this Policy Set Definition.
    parameterValues String
    Parameter values for the references Policy Definition in JSON format.
    policyGroupNames List<String>
    Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
    referenceId String
    A unique ID within this Policy Set Definition for this Policy Definition Reference.
    version String
    The version of the Policy Definition to use.

    Import

    Policy Set Definitions can be imported using the resource id, e.g.

    $ pulumi import azure:policy/policySetDefinition:PolicySetDefinition example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Authorization/policySetDefinitions/policySetDefinitionName

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.26.0 published on Wednesday, Sep 10, 2025 by Pulumi
    pulumi/pulumi-azure