com.pulumi.azurenative.authorization.kotlin.PolicySetDefinition.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-native-kotlin Show documentation
Show all versions of pulumi-azure-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azurenative.authorization.kotlin
import com.pulumi.azurenative.authorization.kotlin.outputs.ParameterDefinitionsValueResponse
import com.pulumi.azurenative.authorization.kotlin.outputs.PolicyDefinitionGroupResponse
import com.pulumi.azurenative.authorization.kotlin.outputs.PolicyDefinitionReferenceResponse
import com.pulumi.azurenative.authorization.kotlin.outputs.SystemDataResponse
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.azurenative.authorization.kotlin.outputs.ParameterDefinitionsValueResponse.Companion.toKotlin as parameterDefinitionsValueResponseToKotlin
import com.pulumi.azurenative.authorization.kotlin.outputs.PolicyDefinitionGroupResponse.Companion.toKotlin as policyDefinitionGroupResponseToKotlin
import com.pulumi.azurenative.authorization.kotlin.outputs.PolicyDefinitionReferenceResponse.Companion.toKotlin as policyDefinitionReferenceResponseToKotlin
import com.pulumi.azurenative.authorization.kotlin.outputs.SystemDataResponse.Companion.toKotlin as systemDataResponseToKotlin
/**
* Builder for [PolicySetDefinition].
*/
@PulumiTagMarker
public class PolicySetDefinitionResourceBuilder internal constructor() {
public var name: String? = null
public var args: PolicySetDefinitionArgs = PolicySetDefinitionArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend PolicySetDefinitionArgsBuilder.() -> Unit) {
val builder = PolicySetDefinitionArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): PolicySetDefinition {
val builtJavaResource =
com.pulumi.azurenative.authorization.PolicySetDefinition(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PolicySetDefinition(builtJavaResource)
}
}
/**
* The policy set definition.
* Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2020-09-01.
* Other available API versions: 2019-06-01, 2023-04-01, 2024-05-01.
* ## Example Usage
* ### Create or update a policy set definition
* ```csharp
* 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
* {
* ["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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ### Create or update a policy set definition with groups
* ```csharp
* 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
* {
* ["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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ## Import
* An existing resource can be imported using its type token, name, and identifier, e.g.
* ```sh
* $ pulumi import azure-native:authorization:PolicySetDefinition CostManagement /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
* ```
*/
public class PolicySetDefinition internal constructor(
override val javaResource: com.pulumi.azurenative.authorization.PolicySetDefinition,
) : KotlinCustomResource(javaResource, PolicySetDefinitionMapper) {
/**
* The policy set definition description.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The display name of the policy set definition.
*/
public val displayName: Output?
get() = javaResource.displayName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
*/
public val metadata: Output?
get() = javaResource.metadata().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The name of the policy set definition.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The policy set definition parameters that can be used in policy definition references.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(
args0.value.let({ args0 ->
parameterDefinitionsValueResponseToKotlin(args0)
}),
)
}).toMap()
}).orElse(null)
})
/**
* The metadata describing groups of policy definition references within the policy set definition.
*/
public val policyDefinitionGroups: Output>?
get() = javaResource.policyDefinitionGroups().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
policyDefinitionGroupResponseToKotlin(args0)
})
})
}).orElse(null)
})
/**
* An array of policy definition references.
*/
public val policyDefinitions: Output>
get() = javaResource.policyDefinitions().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyDefinitionReferenceResponseToKotlin(args0) })
})
})
/**
* The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
*/
public val policyType: Output?
get() = javaResource.policyType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The system metadata relating to this resource.
*/
public val systemData: Output
get() = javaResource.systemData().applyValue({ args0 ->
args0.let({ args0 ->
systemDataResponseToKotlin(args0)
})
})
/**
* The type of the resource (Microsoft.Authorization/policySetDefinitions).
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
}
public object PolicySetDefinitionMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azurenative.authorization.PolicySetDefinition::class == javaResource::class
override fun map(javaResource: Resource): PolicySetDefinition = PolicySetDefinition(
javaResource
as com.pulumi.azurenative.authorization.PolicySetDefinition,
)
}
/**
* @see [PolicySetDefinition].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PolicySetDefinition].
*/
public suspend fun policySetDefinition(
name: String,
block: suspend PolicySetDefinitionResourceBuilder.() -> Unit,
): PolicySetDefinition {
val builder = PolicySetDefinitionResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PolicySetDefinition].
* @param name The _unique_ name of the resulting resource.
*/
public fun policySetDefinition(name: String): PolicySetDefinition {
val builder = PolicySetDefinitionResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy