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

PolicySetDefinitionVersionArgs

data class PolicySetDefinitionVersionArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val metadata: Output<Any>? = null, val parameters: Output<Map<String, ParameterDefinitionsValueArgs>>? = null, val policyDefinitionGroups: Output<List<PolicyDefinitionGroupArgs>>? = null, val policyDefinitionVersion: Output<String>? = null, val policyDefinitions: Output<List<PolicyDefinitionReferenceArgs>>? = null, val policySetDefinitionName: Output<String>? = null, val policyType: Output<Either<String, PolicyType>>? = null, val version: Output<String>? = null) : ConvertibleToJava<PolicySetDefinitionVersionArgs>

The policy set definition version. Uses Azure REST API version 2025-01-01. In version 2.x of the Azure Native provider, it used API version 2023-04-01. Other available API versions: 2023-04-01, 2024-05-01, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native authorization [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create or update a policy set definition version

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var policySetDefinitionVersion = new AzureNative.Authorization.PolicySetDefinitionVersion("policySetDefinitionVersion", 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,
            } },
        },
        PolicyDefinitionVersion = "1.2.1",
        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",
        Version = "1.2.1",
    });
});
Content copied to clipboard
package main
import (
	authorization "github.com/pulumi/pulumi-azure-native-sdk/authorization/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authorization.NewPolicySetDefinitionVersion(ctx, "policySetDefinitionVersion", &authorization.PolicySetDefinitionVersionArgs{
			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),
				},
			},
			PolicyDefinitionVersion: pulumi.String("1.2.1"),
			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"),
			Version:                 pulumi.String("1.2.1"),
		})
		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.PolicySetDefinitionVersion;
import com.pulumi.azurenative.authorization.PolicySetDefinitionVersionArgs;
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 policySetDefinitionVersion = new PolicySetDefinitionVersion("policySetDefinitionVersion", PolicySetDefinitionVersionArgs.builder()
            .description("Policies to enforce low cost storage SKUs")
            .displayName("Cost Management")
            .metadata(Map.of("category", "Cost Management"))
            .parameters(Map.of("namePrefix", ParameterDefinitionsValueArgs.builder()
                .defaultValue("myPrefix")
                .metadata(ParameterDefinitionsValueMetadataArgs.builder()
                    .displayName("Prefix to enforce on resource names")
                    .build())
                .type("String")
                .build()))
            .policyDefinitionVersion("1.2.1")
            .policyDefinitions(
                PolicyDefinitionReferenceArgs.builder()
                    .parameters(Map.of("listOfAllowedSKUs", ParameterValuesValueArgs.builder()
                        .value(
                            "Standard_GRS",
                            "Standard_LRS")
                        .build()))
                    .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", ParameterValuesValueArgs.builder()
                            .value("[parameters('namePrefix')]")
                            .build()),
                        Map.entry("suffix", ParameterValuesValueArgs.builder()
                            .value("-LC")
                            .build())
                    ))
                    .policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming")
                    .policyDefinitionReferenceId("Resource_Naming")
                    .build())
            .policySetDefinitionName("CostManagement")
            .version("1.2.1")
            .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:PolicySetDefinitionVersion 1.2.1 /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, displayName: Output<String>? = null, metadata: Output<Any>? = null, parameters: Output<Map<String, ParameterDefinitionsValueArgs>>? = null, policyDefinitionGroups: Output<List<PolicyDefinitionGroupArgs>>? = null, policyDefinitionVersion: Output<String>? = null, policyDefinitions: Output<List<PolicyDefinitionReferenceArgs>>? = null, policySetDefinitionName: Output<String>? = null, policyType: Output<Either<String, PolicyType>>? = null, version: Output<String>? = null)

Properties

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

The policy set definition description.

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

The display name of the policy set definition.

Link copied to clipboard
val metadata: Output<Any>? = null

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 parameters: Output<Map<String, ParameterDefinitionsValueArgs>>? = null

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

Link copied to clipboard
val policyDefinitionGroups: Output<List<PolicyDefinitionGroupArgs>>? = null

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

Link copied to clipboard
val policyDefinitions: Output<List<PolicyDefinitionReferenceArgs>>? = null

An array of policy definition references.

Link copied to clipboard
val policyDefinitionVersion: Output<String>? = null

The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number

Link copied to clipboard
val policySetDefinitionName: Output<String>? = null

The name of the policy set definition.

Link copied to clipboard
val policyType: Output<Either<String, PolicyType>>? = null

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

Link copied to clipboard
val version: Output<String>? = null

The policy set definition version in #.#.# format.

Functions

Link copied to clipboard
open override fun toJava(): PolicySetDefinitionVersionArgs