pulumi-azure-native-kotlin/com.pulumi.azurenative.authorization.kotlin/PolicySetDefinition

PolicySetDefinition

class PolicySetDefinition : KotlinCustomResource

The policy set definition. Uses Azure REST API version 2021-06-01. In version 1.x of the Azure Native provider, it used API version 2020-09-01. Other available API versions: 2019-06-01, 2023-04-01, 2024-05-01, 2025-01-01, 2025-03-01.

Example Usage

Create or update a policy set definition

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var policySetDefinition = new AzureNative.Authorization.PolicySetDefinition("policySetDefinition", new()
    {
        Description = "Policies to enforce low cost storage SKUs",
        DisplayName = "Cost Management",
        Metadata = new Dictionary<string, object?>
        {
            ["category"] = "Cost Management",
        },
        Parameters =
        {
            { "namePrefix", new AzureNative.Authorization.Inputs.ParameterDefinitionsValueArgs
            {
                DefaultValue = "myPrefix",
                Metadata = new AzureNative.Authorization.Inputs.ParameterDefinitionsValueMetadataArgs
                {
                    DisplayName = "Prefix to enforce on resource names",
                },
                Type = AzureNative.Authorization.ParameterType.String,
            } },
        },
        PolicyDefinitions = new[]
        {
            new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
            {
                Parameters =
                {
                    { "listOfAllowedSKUs", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
                    {
                        Value = new[]
                        {
                            "Standard_GRS",
                            "Standard_LRS",
                        },
                    } },
                },
                PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
                PolicyDefinitionReferenceId = "Limit_Skus",
            },
            new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
            {
                Parameters =
                {
                    { "prefix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
                    {
                        Value = "[parameters('namePrefix')]",
                    } },
                    { "suffix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
                    {
                        Value = "-LC",
                    } },
                },
                PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
                PolicyDefinitionReferenceId = "Resource_Naming",
            },
        },
        PolicySetDefinitionName = "CostManagement",
    });
});
Content copied to clipboard
package main
import (
	authorization "github.com/pulumi/pulumi-azure-native-sdk/authorization/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authorization.NewPolicySetDefinition(ctx, "policySetDefinition", &authorization.PolicySetDefinitionArgs{
			Description: pulumi.String("Policies to enforce low cost storage SKUs"),
			DisplayName: pulumi.String("Cost Management"),
			Metadata: pulumi.Any(map[string]interface{}{
				"category": "Cost Management",
			}),
			Parameters: authorization.ParameterDefinitionsValueMap{
				"namePrefix": &authorization.ParameterDefinitionsValueArgs{
					DefaultValue: pulumi.Any("myPrefix"),
					Metadata: &authorization.ParameterDefinitionsValueMetadataArgs{
						DisplayName: pulumi.String("Prefix to enforce on resource names"),
					},
					Type: pulumi.String(authorization.ParameterTypeString),
				},
			},
			PolicyDefinitions: authorization.PolicyDefinitionReferenceArray{
				&authorization.PolicyDefinitionReferenceArgs{
					Parameters: authorization.ParameterValuesValueMap{
						"listOfAllowedSKUs": &authorization.ParameterValuesValueArgs{
							Value: pulumi.Any{
								"Standard_GRS",
								"Standard_LRS",
							},
						},
					},
					PolicyDefinitionId:          pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1"),
					PolicyDefinitionReferenceId: pulumi.String("Limit_Skus"),
				},
				&authorization.PolicyDefinitionReferenceArgs{
					Parameters: authorization.ParameterValuesValueMap{
						"prefix": &authorization.ParameterValuesValueArgs{
							Value: pulumi.Any("[parameters('namePrefix')]"),
						},
						"suffix": &authorization.ParameterValuesValueArgs{
							Value: pulumi.Any("-LC"),
						},
					},
					PolicyDefinitionId:          pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming"),
					PolicyDefinitionReferenceId: pulumi.String("Resource_Naming"),
				},
			},
			PolicySetDefinitionName: pulumi.String("CostManagement"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.authorization.PolicySetDefinition;
import com.pulumi.azurenative.authorization.PolicySetDefinitionArgs;
import com.pulumi.azurenative.authorization.inputs.PolicyDefinitionReferenceArgs;
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 policySetDefinition = new PolicySetDefinition("policySetDefinition", PolicySetDefinitionArgs.builder()
            .description("Policies to enforce low cost storage SKUs")
            .displayName("Cost Management")
            .metadata(Map.of("category", "Cost Management"))
            .parameters(Map.of("namePrefix", Map.ofEntries(
                Map.entry("defaultValue", "myPrefix"),
                Map.entry("metadata", Map.of("displayName", "Prefix to enforce on resource names")),
                Map.entry("type", "String")
            )))
            .policyDefinitions(
                PolicyDefinitionReferenceArgs.builder()
                    .parameters(Map.of("listOfAllowedSKUs", Map.of("value",
                        "Standard_GRS",
                        "Standard_LRS")))
                    .policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1")
                    .policyDefinitionReferenceId("Limit_Skus")
                    .build(),
                PolicyDefinitionReferenceArgs.builder()
                    .parameters(Map.ofEntries(
                        Map.entry("prefix", Map.of("value", "[parameters('namePrefix')]")),
                        Map.entry("suffix", Map.of("value", "-LC"))
                    ))
                    .policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming")
                    .policyDefinitionReferenceId("Resource_Naming")
                    .build())
            .policySetDefinitionName("CostManagement")
            .build());
    }
}
Content copied to clipboard

Create or update a policy set definition with groups

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var policySetDefinition = new AzureNative.Authorization.PolicySetDefinition("policySetDefinition", new()
    {
        Description = "Policies to enforce low cost storage SKUs",
        DisplayName = "Cost Management",
        Metadata = new Dictionary<string, object?>
        {
            ["category"] = "Cost Management",
        },
        PolicyDefinitionGroups = new[]
        {
            new AzureNative.Authorization.Inputs.PolicyDefinitionGroupArgs
            {
                Description = "Policies designed to control spend within a subscription.",
                DisplayName = "Cost Management Policies",
                Name = "CostSaving",
            },
            new AzureNative.Authorization.Inputs.PolicyDefinitionGroupArgs
            {
                Description = "Policies that help enforce resource organization standards within a subscription.",
                DisplayName = "Organizational Policies",
                Name = "Organizational",
            },
        },
        PolicyDefinitions = new[]
        {
            new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
            {
                GroupNames = new[]
                {
                    "CostSaving",
                },
                Parameters =
                {
                    { "listOfAllowedSKUs", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
                    {
                        Value = new[]
                        {
                            "Standard_GRS",
                            "Standard_LRS",
                        },
                    } },
                },
                PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
                PolicyDefinitionReferenceId = "Limit_Skus",
            },
            new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
            {
                GroupNames = new[]
                {
                    "Organizational",
                },
                Parameters =
                {
                    { "prefix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
                    {
                        Value = "DeptA",
                    } },
                    { "suffix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
                    {
                        Value = "-LC",
                    } },
                },
                PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
                PolicyDefinitionReferenceId = "Resource_Naming",
            },
        },
        PolicySetDefinitionName = "CostManagement",
    });
});
Content copied to clipboard
package main
import (
	authorization "github.com/pulumi/pulumi-azure-native-sdk/authorization/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authorization.NewPolicySetDefinition(ctx, "policySetDefinition", &authorization.PolicySetDefinitionArgs{
			Description: pulumi.String("Policies to enforce low cost storage SKUs"),
			DisplayName: pulumi.String("Cost Management"),
			Metadata: pulumi.Any(map[string]interface{}{
				"category": "Cost Management",
			}),
			PolicyDefinitionGroups: authorization.PolicyDefinitionGroupArray{
				&authorization.PolicyDefinitionGroupArgs{
					Description: pulumi.String("Policies designed to control spend within a subscription."),
					DisplayName: pulumi.String("Cost Management Policies"),
					Name:        pulumi.String("CostSaving"),
				},
				&authorization.PolicyDefinitionGroupArgs{
					Description: pulumi.String("Policies that help enforce resource organization standards within a subscription."),
					DisplayName: pulumi.String("Organizational Policies"),
					Name:        pulumi.String("Organizational"),
				},
			},
			PolicyDefinitions: authorization.PolicyDefinitionReferenceArray{
				&authorization.PolicyDefinitionReferenceArgs{
					GroupNames: pulumi.StringArray{
						pulumi.String("CostSaving"),
					},
					Parameters: authorization.ParameterValuesValueMap{
						"listOfAllowedSKUs": &authorization.ParameterValuesValueArgs{
							Value: pulumi.Any{
								"Standard_GRS",
								"Standard_LRS",
							},
						},
					},
					PolicyDefinitionId:          pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1"),
					PolicyDefinitionReferenceId: pulumi.String("Limit_Skus"),
				},
				&authorization.PolicyDefinitionReferenceArgs{
					GroupNames: pulumi.StringArray{
						pulumi.String("Organizational"),
					},
					Parameters: authorization.ParameterValuesValueMap{
						"prefix": &authorization.ParameterValuesValueArgs{
							Value: pulumi.Any("DeptA"),
						},
						"suffix": &authorization.ParameterValuesValueArgs{
							Value: pulumi.Any("-LC"),
						},
					},
					PolicyDefinitionId:          pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming"),
					PolicyDefinitionReferenceId: pulumi.String("Resource_Naming"),
				},
			},
			PolicySetDefinitionName: pulumi.String("CostManagement"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.authorization.PolicySetDefinition;
import com.pulumi.azurenative.authorization.PolicySetDefinitionArgs;
import com.pulumi.azurenative.authorization.inputs.PolicyDefinitionGroupArgs;
import com.pulumi.azurenative.authorization.inputs.PolicyDefinitionReferenceArgs;
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 policySetDefinition = new PolicySetDefinition("policySetDefinition", PolicySetDefinitionArgs.builder()
            .description("Policies to enforce low cost storage SKUs")
            .displayName("Cost Management")
            .metadata(Map.of("category", "Cost Management"))
            .policyDefinitionGroups(
                PolicyDefinitionGroupArgs.builder()
                    .description("Policies designed to control spend within a subscription.")
                    .displayName("Cost Management Policies")
                    .name("CostSaving")
                    .build(),
                PolicyDefinitionGroupArgs.builder()
                    .description("Policies that help enforce resource organization standards within a subscription.")
                    .displayName("Organizational Policies")
                    .name("Organizational")
                    .build())
            .policyDefinitions(
                PolicyDefinitionReferenceArgs.builder()
                    .groupNames("CostSaving")
                    .parameters(Map.of("listOfAllowedSKUs", Map.of("value",
                        "Standard_GRS",
                        "Standard_LRS")))
                    .policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1")
                    .policyDefinitionReferenceId("Limit_Skus")
                    .build(),
                PolicyDefinitionReferenceArgs.builder()
                    .groupNames("Organizational")
                    .parameters(Map.ofEntries(
                        Map.entry("prefix", Map.of("value", "DeptA")),
                        Map.entry("suffix", Map.of("value", "-LC"))
                    ))
                    .policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming")
                    .policyDefinitionReferenceId("Resource_Naming")
                    .build())
            .policySetDefinitionName("CostManagement")
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:authorization:PolicySetDefinition CostManagement /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
Content copied to clipboard

Properties

Link copied to clipboard
val description: Output<String>?

The policy set definition description.

Link copied to clipboard
val displayName: Output<String>?

The display name of the policy set definition.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val metadata: Output<Any>?

The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

Link copied to clipboard
val name: Output<String>

The name of the policy set definition.

Link copied to clipboard
val parameters: Output<Map<String, ParameterDefinitionsValueResponse>>?

The policy set definition parameters that can be used in policy definition references.

Link copied to clipboard
val policyDefinitionGroups: Output<List<PolicyDefinitionGroupResponse>>?

The metadata describing groups of policy definition references within the policy set definition.

Link copied to clipboard
val policyDefinitions: Output<List<PolicyDefinitionReferenceResponse>>

An array of policy definition references.

Link copied to clipboard
val policyType: Output<String>?

The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val systemData: Output<SystemDataResponse>

The system metadata relating to this resource.

Link copied to clipboard
val type: Output<String>

The type of the resource (Microsoft.Authorization/policySetDefinitions).

Link copied to clipboard
val urn: Output<String>