PolicyDefinitionVersionArgs

data class PolicyDefinitionVersionArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val metadata: Output<Any>? = null, val mode: Output<String>? = null, val parameters: Output<Map<String, ParameterDefinitionsValueArgs>>? = null, val policyDefinitionName: Output<String>? = null, val policyDefinitionVersion: Output<String>? = null, val policyRule: Output<Any>? = null, val policyType: Output<Either<String, PolicyType>>? = null, val version: Output<String>? = null) : ConvertibleToJava<PolicyDefinitionVersionArgs>

The ID of the policy 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 definition version

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var policyDefinitionVersion = new AzureNative.Authorization.PolicyDefinitionVersion("policyDefinitionVersion", new()
{
Description = "Force resource names to begin with given 'prefix' and/or end with given 'suffix'",
DisplayName = "Enforce resource naming convention",
Metadata = new Dictionary<string, object?>
{
["category"] = "Naming",
},
Mode = "All",
Parameters =
{
{ "prefix", new AzureNative.Authorization.Inputs.ParameterDefinitionsValueArgs
{
Metadata = new AzureNative.Authorization.Inputs.ParameterDefinitionsValueMetadataArgs
{
Description = "Resource name prefix",
DisplayName = "Prefix",
},
Type = AzureNative.Authorization.ParameterType.String,
} },
{ "suffix", new AzureNative.Authorization.Inputs.ParameterDefinitionsValueArgs
{
Metadata = new AzureNative.Authorization.Inputs.ParameterDefinitionsValueMetadataArgs
{
Description = "Resource name suffix",
DisplayName = "Suffix",
},
Type = AzureNative.Authorization.ParameterType.String,
} },
},
PolicyDefinitionName = "ResourceNaming",
PolicyDefinitionVersion = "1.2.1",
PolicyRule = new Dictionary<string, object?>
{
["if"] = new Dictionary<string, object?>
{
["not"] = new Dictionary<string, object?>
{
["field"] = "name",
["like"] = "[concat(parameters('prefix'), '*', parameters('suffix'))]",
},
},
["then"] = new Dictionary<string, object?>
{
["effect"] = "deny",
},
},
Version = "1.2.1",
});
});
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.NewPolicyDefinitionVersion(ctx, "policyDefinitionVersion", &authorization.PolicyDefinitionVersionArgs{
Description: pulumi.String("Force resource names to begin with given 'prefix' and/or end with given 'suffix'"),
DisplayName: pulumi.String("Enforce resource naming convention"),
Metadata: pulumi.Any(map[string]interface{}{
"category": "Naming",
}),
Mode: pulumi.String("All"),
Parameters: authorization.ParameterDefinitionsValueMap{
"prefix": &authorization.ParameterDefinitionsValueArgs{
Metadata: &authorization.ParameterDefinitionsValueMetadataArgs{
Description: pulumi.String("Resource name prefix"),
DisplayName: pulumi.String("Prefix"),
},
Type: pulumi.String(authorization.ParameterTypeString),
},
"suffix": &authorization.ParameterDefinitionsValueArgs{
Metadata: &authorization.ParameterDefinitionsValueMetadataArgs{
Description: pulumi.String("Resource name suffix"),
DisplayName: pulumi.String("Suffix"),
},
Type: pulumi.String(authorization.ParameterTypeString),
},
},
PolicyDefinitionName: pulumi.String("ResourceNaming"),
PolicyDefinitionVersion: pulumi.String("1.2.1"),
PolicyRule: pulumi.Any(map[string]interface{}{
"if": map[string]interface{}{
"not": map[string]interface{}{
"field": "name",
"like": "[concat(parameters('prefix'), '*', parameters('suffix'))]",
},
},
"then": map[string]interface{}{
"effect": "deny",
},
}),
Version: pulumi.String("1.2.1"),
})
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.authorization.PolicyDefinitionVersion;
import com.pulumi.azurenative.authorization.PolicyDefinitionVersionArgs;
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 policyDefinitionVersion = new PolicyDefinitionVersion("policyDefinitionVersion", PolicyDefinitionVersionArgs.builder()
.description("Force resource names to begin with given 'prefix' and/or end with given 'suffix'")
.displayName("Enforce resource naming convention")
.metadata(Map.of("category", "Naming"))
.mode("All")
.parameters(Map.ofEntries(
Map.entry("prefix", ParameterDefinitionsValueArgs.builder()
.metadata(ParameterDefinitionsValueMetadataArgs.builder()
.description("Resource name prefix")
.displayName("Prefix")
.build())
.type("String")
.build()),
Map.entry("suffix", ParameterDefinitionsValueArgs.builder()
.metadata(ParameterDefinitionsValueMetadataArgs.builder()
.description("Resource name suffix")
.displayName("Suffix")
.build())
.type("String")
.build())
))
.policyDefinitionName("ResourceNaming")
.policyDefinitionVersion("1.2.1")
.policyRule(Map.ofEntries(
Map.entry("if", Map.of("not", Map.ofEntries(
Map.entry("field", "name"),
Map.entry("like", "[concat(parameters('prefix'), '*', parameters('suffix'))]")
))),
Map.entry("then", Map.of("effect", "deny"))
))
.version("1.2.1")
.build());
}
}

Import

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

$ pulumi import azure-native:authorization:PolicyDefinitionVersion 1.2.1 /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions/{policyDefinitionVersion}

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, displayName: Output<String>? = null, metadata: Output<Any>? = null, mode: Output<String>? = null, parameters: Output<Map<String, ParameterDefinitionsValueArgs>>? = null, policyDefinitionName: Output<String>? = null, policyDefinitionVersion: Output<String>? = null, policyRule: Output<Any>? = null, policyType: Output<Either<String, PolicyType>>? = null, version: Output<String>? = null)

Properties

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

The policy definition description.

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

The display name of the policy definition.

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

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

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

The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.

Link copied to clipboard

The parameter definitions for parameters used in the policy rule. The keys are the parameter names.

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

The name of the policy definition.

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

The policy 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 policyRule: Output<Any>? = null

The policy rule.

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 definition version in #.#.# format.

Functions

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