PolicyDefinitionVersion

class PolicyDefinitionVersion : KotlinCustomResource

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/v2"
"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", Map.ofEntries(
Map.entry("metadata", Map.ofEntries(
Map.entry("description", "Resource name prefix"),
Map.entry("displayName", "Prefix")
)),
Map.entry("type", "String")
)),
Map.entry("suffix", Map.ofEntries(
Map.entry("metadata", Map.ofEntries(
Map.entry("description", "Resource name suffix"),
Map.entry("displayName", "Suffix")
)),
Map.entry("type", "String")
))
))
.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}

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

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

The policy definition description.

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

The display name of the policy definition.

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

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>?

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

Link copied to clipboard
val name: Output<String>

The name of the policy definition version.

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 policyRule: Output<Any>?

The policy rule.

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

The system metadata relating to this resource.

Link copied to clipboard
val type: Output<String>

The type of the resource (Microsoft.Authorization/policyDefinitions/versions).

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

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