pulumi-azure-kotlin/com.pulumi.azure.policy.kotlin/PolicySetDefinitionArgs

PolicySetDefinitionArgs

data class PolicySetDefinitionArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val managementGroupId: Output<String>? = null, val metadata: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<String>? = null, val policyDefinitionGroups: Output<List<PolicySetDefinitionPolicyDefinitionGroupArgs>>? = null, val policyDefinitionReferences: Output<List<PolicySetDefinitionPolicyDefinitionReferenceArgs>>? = null, val policyType: Output<String>? = null) : ConvertibleToJava<PolicySetDefinitionArgs>

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

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()
            .displayName("Test Policy Set")
            .parameters("""
    {
        "allowedLocations": {
            "type": "Array",
            "metadata": {
                "description": "The list of allowed locations for resources.",
                "displayName": "Allowed locations",
                "strongType": "location"
            }
        }
    }
            """)
            .policyDefinitionReferences(PolicySetDefinitionPolicyDefinitionReferenceArgs.builder()
                .parameterValues("""
    {
      "listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
    }
                """)
                .policyDefinitionId("/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988")
                .build())
            .policyType("Custom")
            .build());
    }
}

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/testPolicySet

$ pulumi import azure:policy/policySetDefinition:PolicySetDefinition example /providers/Microsoft.Management/managementGroups/my-mgmt-group-id/providers/Microsoft.Authorization/policySetDefinitions/testPolicySet

Constructors

PolicySetDefinitionArgs

fun PolicySetDefinitionArgs(description: Output<String>? = null, displayName: Output<String>? = null, managementGroupId: Output<String>? = null, metadata: Output<String>? = null, name: Output<String>? = null, parameters: Output<String>? = null, policyDefinitionGroups: Output<List<PolicySetDefinitionPolicyDefinitionGroupArgs>>? = null, policyDefinitionReferences: Output<List<PolicySetDefinitionPolicyDefinitionReferenceArgs>>? = null, policyType: Output<String>? = null)

Functions

toJava

open override fun toJava(): PolicySetDefinitionArgs

Properties

description

val description: Output<String>? = null

The description of the policy set definition.

displayName

val displayName: Output<String>? = null

The display name of the policy set definition.

managementGroupId

val managementGroupId: Output<String>? = null

The id of the Management Group where this policy set definition should be defined. Changing this forces a new resource to be created.

metadata

val metadata: Output<String>? = null

The metadata for the policy set definition. This is a JSON object representing additional metadata that should be stored with the policy definition.

name

val name: Output<String>? = null

The name of the policy set definition. Changing this forces a new resource to be created.

parameters

val parameters: Output<String>? = null

Parameters for the policy set definition. This field is a JSON object that allows you to parameterize your policy definition.

policyDefinitionGroups

val policyDefinitionGroups: Output<List<PolicySetDefinitionPolicyDefinitionGroupArgs>>? = null

One or more policy_definition_group blocks as defined below.

policyDefinitionReferences

val policyDefinitionReferences: Output<List<PolicySetDefinitionPolicyDefinitionReferenceArgs>>? = null

One or more policy_definition_reference blocks as defined below.

policyType

val policyType: Output<String>? = null

The policy set type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.