com.pulumi.azure.consumption.kotlin.BudgetManagementGroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-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.azure.consumption.kotlin
import com.pulumi.azure.consumption.BudgetManagementGroupArgs.builder
import com.pulumi.azure.consumption.kotlin.inputs.BudgetManagementGroupFilterArgs
import com.pulumi.azure.consumption.kotlin.inputs.BudgetManagementGroupFilterArgsBuilder
import com.pulumi.azure.consumption.kotlin.inputs.BudgetManagementGroupNotificationArgs
import com.pulumi.azure.consumption.kotlin.inputs.BudgetManagementGroupNotificationArgsBuilder
import com.pulumi.azure.consumption.kotlin.inputs.BudgetManagementGroupTimePeriodArgs
import com.pulumi.azure.consumption.kotlin.inputs.BudgetManagementGroupTimePeriodArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Double
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Manages a Consumption Budget for a Management Group.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.management.Group("example", {displayName: "example"});
* const exampleResourceGroup = new azure.core.ResourceGroup("example", {
* name: "example",
* location: "eastus",
* });
* const exampleBudgetManagementGroup = new azure.consumption.BudgetManagementGroup("example", {
* name: "example",
* managementGroupId: example.id,
* amount: 1000,
* timeGrain: "Monthly",
* timePeriod: {
* startDate: "2022-06-01T00:00:00Z",
* endDate: "2022-07-01T00:00:00Z",
* },
* filter: {
* dimensions: [{
* name: "ResourceGroupName",
* values: [exampleResourceGroup.name],
* }],
* tags: [{
* name: "foo",
* values: [
* "bar",
* "baz",
* ],
* }],
* },
* notifications: [
* {
* enabled: true,
* threshold: 90,
* operator: "EqualTo",
* contactEmails: [
* "[email protected]",
* "[email protected]",
* ],
* },
* {
* enabled: false,
* threshold: 100,
* operator: "GreaterThan",
* thresholdType: "Forecasted",
* contactEmails: [
* "[email protected]",
* "[email protected]",
* ],
* },
* ],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.management.Group("example", display_name="example")
* example_resource_group = azure.core.ResourceGroup("example",
* name="example",
* location="eastus")
* example_budget_management_group = azure.consumption.BudgetManagementGroup("example",
* name="example",
* management_group_id=example.id,
* amount=1000,
* time_grain="Monthly",
* time_period={
* "start_date": "2022-06-01T00:00:00Z",
* "end_date": "2022-07-01T00:00:00Z",
* },
* filter={
* "dimensions": [{
* "name": "ResourceGroupName",
* "values": [example_resource_group.name],
* }],
* "tags": [{
* "name": "foo",
* "values": [
* "bar",
* "baz",
* ],
* }],
* },
* notifications=[
* {
* "enabled": True,
* "threshold": 90,
* "operator": "EqualTo",
* "contact_emails": [
* "[email protected]",
* "[email protected]",
* ],
* },
* {
* "enabled": False,
* "threshold": 100,
* "operator": "GreaterThan",
* "threshold_type": "Forecasted",
* "contact_emails": [
* "[email protected]",
* "[email protected]",
* ],
* },
* ])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Management.Group("example", new()
* {
* DisplayName = "example",
* });
* var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example",
* Location = "eastus",
* });
* var exampleBudgetManagementGroup = new Azure.Consumption.BudgetManagementGroup("example", new()
* {
* Name = "example",
* ManagementGroupId = example.Id,
* Amount = 1000,
* TimeGrain = "Monthly",
* TimePeriod = new Azure.Consumption.Inputs.BudgetManagementGroupTimePeriodArgs
* {
* StartDate = "2022-06-01T00:00:00Z",
* EndDate = "2022-07-01T00:00:00Z",
* },
* Filter = new Azure.Consumption.Inputs.BudgetManagementGroupFilterArgs
* {
* Dimensions = new[]
* {
* new Azure.Consumption.Inputs.BudgetManagementGroupFilterDimensionArgs
* {
* Name = "ResourceGroupName",
* Values = new[]
* {
* exampleResourceGroup.Name,
* },
* },
* },
* Tags = new[]
* {
* new Azure.Consumption.Inputs.BudgetManagementGroupFilterTagArgs
* {
* Name = "foo",
* Values = new[]
* {
* "bar",
* "baz",
* },
* },
* },
* },
* Notifications = new[]
* {
* new Azure.Consumption.Inputs.BudgetManagementGroupNotificationArgs
* {
* Enabled = true,
* Threshold = 90,
* Operator = "EqualTo",
* ContactEmails = new[]
* {
* "[email protected]",
* "[email protected]",
* },
* },
* new Azure.Consumption.Inputs.BudgetManagementGroupNotificationArgs
* {
* Enabled = false,
* Threshold = 100,
* Operator = "GreaterThan",
* ThresholdType = "Forecasted",
* ContactEmails = new[]
* {
* "[email protected]",
* "[email protected]",
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/consumption"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/management"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := management.NewGroup(ctx, "example", &management.GroupArgs{
* DisplayName: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example"),
* Location: pulumi.String("eastus"),
* })
* if err != nil {
* return err
* }
* _, err = consumption.NewBudgetManagementGroup(ctx, "example", &consumption.BudgetManagementGroupArgs{
* Name: pulumi.String("example"),
* ManagementGroupId: example.ID(),
* Amount: pulumi.Float64(1000),
* TimeGrain: pulumi.String("Monthly"),
* TimePeriod: &consumption.BudgetManagementGroupTimePeriodArgs{
* StartDate: pulumi.String("2022-06-01T00:00:00Z"),
* EndDate: pulumi.String("2022-07-01T00:00:00Z"),
* },
* Filter: &consumption.BudgetManagementGroupFilterArgs{
* Dimensions: consumption.BudgetManagementGroupFilterDimensionArray{
* &consumption.BudgetManagementGroupFilterDimensionArgs{
* Name: pulumi.String("ResourceGroupName"),
* Values: pulumi.StringArray{
* exampleResourceGroup.Name,
* },
* },
* },
* Tags: consumption.BudgetManagementGroupFilterTagArray{
* &consumption.BudgetManagementGroupFilterTagArgs{
* Name: pulumi.String("foo"),
* Values: pulumi.StringArray{
* pulumi.String("bar"),
* pulumi.String("baz"),
* },
* },
* },
* },
* Notifications: consumption.BudgetManagementGroupNotificationArray{
* &consumption.BudgetManagementGroupNotificationArgs{
* Enabled: pulumi.Bool(true),
* Threshold: pulumi.Int(90),
* Operator: pulumi.String("EqualTo"),
* ContactEmails: pulumi.StringArray{
* pulumi.String("[email protected]"),
* pulumi.String("[email protected]"),
* },
* },
* &consumption.BudgetManagementGroupNotificationArgs{
* Enabled: pulumi.Bool(false),
* Threshold: pulumi.Int(100),
* Operator: pulumi.String("GreaterThan"),
* ThresholdType: pulumi.String("Forecasted"),
* ContactEmails: pulumi.StringArray{
* pulumi.String("[email protected]"),
* pulumi.String("[email protected]"),
* },
* },
* },
* })
* 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.azure.management.Group;
* import com.pulumi.azure.management.GroupArgs;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.consumption.BudgetManagementGroup;
* import com.pulumi.azure.consumption.BudgetManagementGroupArgs;
* import com.pulumi.azure.consumption.inputs.BudgetManagementGroupTimePeriodArgs;
* import com.pulumi.azure.consumption.inputs.BudgetManagementGroupFilterArgs;
* import com.pulumi.azure.consumption.inputs.BudgetManagementGroupNotificationArgs;
* 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 Group("example", GroupArgs.builder()
* .displayName("example")
* .build());
* var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
* .name("example")
* .location("eastus")
* .build());
* var exampleBudgetManagementGroup = new BudgetManagementGroup("exampleBudgetManagementGroup", BudgetManagementGroupArgs.builder()
* .name("example")
* .managementGroupId(example.id())
* .amount(1000)
* .timeGrain("Monthly")
* .timePeriod(BudgetManagementGroupTimePeriodArgs.builder()
* .startDate("2022-06-01T00:00:00Z")
* .endDate("2022-07-01T00:00:00Z")
* .build())
* .filter(BudgetManagementGroupFilterArgs.builder()
* .dimensions(BudgetManagementGroupFilterDimensionArgs.builder()
* .name("ResourceGroupName")
* .values(exampleResourceGroup.name())
* .build())
* .tags(BudgetManagementGroupFilterTagArgs.builder()
* .name("foo")
* .values(
* "bar",
* "baz")
* .build())
* .build())
* .notifications(
* BudgetManagementGroupNotificationArgs.builder()
* .enabled(true)
* .threshold(90)
* .operator("EqualTo")
* .contactEmails(
* "[email protected]",
* "[email protected]")
* .build(),
* BudgetManagementGroupNotificationArgs.builder()
* .enabled(false)
* .threshold(100)
* .operator("GreaterThan")
* .thresholdType("Forecasted")
* .contactEmails(
* "[email protected]",
* "[email protected]")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:management:Group
* properties:
* displayName: example
* exampleResourceGroup:
* type: azure:core:ResourceGroup
* name: example
* properties:
* name: example
* location: eastus
* exampleBudgetManagementGroup:
* type: azure:consumption:BudgetManagementGroup
* name: example
* properties:
* name: example
* managementGroupId: ${example.id}
* amount: 1000
* timeGrain: Monthly
* timePeriod:
* startDate: 2022-06-01T00:00:00Z
* endDate: 2022-07-01T00:00:00Z
* filter:
* dimensions:
* - name: ResourceGroupName
* values:
* - ${exampleResourceGroup.name}
* tags:
* - name: foo
* values:
* - bar
* - baz
* notifications:
* - enabled: true
* threshold: 90
* operator: EqualTo
* contactEmails:
* - [email protected]
* - [email protected]
* - enabled: false
* threshold: 100
* operator: GreaterThan
* thresholdType: Forecasted
* contactEmails:
* - [email protected]
* - [email protected]
* ```
*
* ## Import
* Management Group Consumption Budgets can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:consumption/budgetManagementGroup:BudgetManagementGroup example /providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/budget1
* ```
* @property amount The total amount of cost to track with the budget.
* @property etag (Optional) The ETag of the Management Group Consumption Budget.
* @property filter A `filter` block as defined below.
* @property managementGroupId The ID of the Management Group. Changing this forces a new resource to be created.
* @property name The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
* @property notifications One or more `notification` blocks as defined below.
* @property timeGrain The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of `BillingAnnual`, `BillingMonth`, `BillingQuarter`, `Annually`, `Monthly` and `Quarterly`. Defaults to `Monthly`. Changing this forces a new resource to be created.
* @property timePeriod A `time_period` block as defined below.
*/
public data class BudgetManagementGroupArgs(
public val amount: Output? = null,
public val etag: Output? = null,
public val filter: Output? = null,
public val managementGroupId: Output? = null,
public val name: Output? = null,
public val notifications: Output>? = null,
public val timeGrain: Output? = null,
public val timePeriod: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.consumption.BudgetManagementGroupArgs =
com.pulumi.azure.consumption.BudgetManagementGroupArgs.builder()
.amount(amount?.applyValue({ args0 -> args0 }))
.etag(etag?.applyValue({ args0 -> args0 }))
.filter(filter?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.managementGroupId(managementGroupId?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.notifications(
notifications?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.timeGrain(timeGrain?.applyValue({ args0 -> args0 }))
.timePeriod(timePeriod?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) })).build()
}
/**
* Builder for [BudgetManagementGroupArgs].
*/
@PulumiTagMarker
public class BudgetManagementGroupArgsBuilder internal constructor() {
private var amount: Output? = null
private var etag: Output? = null
private var filter: Output? = null
private var managementGroupId: Output? = null
private var name: Output? = null
private var notifications: Output>? = null
private var timeGrain: Output? = null
private var timePeriod: Output? = null
/**
* @param value The total amount of cost to track with the budget.
*/
@JvmName("oivrjvermodwhmyp")
public suspend fun amount(`value`: Output) {
this.amount = value
}
/**
* @param value (Optional) The ETag of the Management Group Consumption Budget.
*/
@JvmName("vedxolwpelksfcow")
public suspend fun etag(`value`: Output) {
this.etag = value
}
/**
* @param value A `filter` block as defined below.
*/
@JvmName("iigslxexmseetymx")
public suspend fun filter(`value`: Output) {
this.filter = value
}
/**
* @param value The ID of the Management Group. Changing this forces a new resource to be created.
*/
@JvmName("hopxjlhosqwbduqa")
public suspend fun managementGroupId(`value`: Output) {
this.managementGroupId = value
}
/**
* @param value The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
*/
@JvmName("oceuuocgxypldbyv")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value One or more `notification` blocks as defined below.
*/
@JvmName("hewhhkghnbvgtbww")
public suspend fun notifications(`value`: Output>) {
this.notifications = value
}
@JvmName("rpmveylxwqxhgsdr")
public suspend fun notifications(vararg values: Output) {
this.notifications = Output.all(values.asList())
}
/**
* @param values One or more `notification` blocks as defined below.
*/
@JvmName("ulbpdhhvnvfdfwxy")
public suspend fun notifications(values: List>) {
this.notifications = Output.all(values)
}
/**
* @param value The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of `BillingAnnual`, `BillingMonth`, `BillingQuarter`, `Annually`, `Monthly` and `Quarterly`. Defaults to `Monthly`. Changing this forces a new resource to be created.
*/
@JvmName("foyjyhsgxikbavsr")
public suspend fun timeGrain(`value`: Output) {
this.timeGrain = value
}
/**
* @param value A `time_period` block as defined below.
*/
@JvmName("cvpsjwcsvbpnnkef")
public suspend fun timePeriod(`value`: Output) {
this.timePeriod = value
}
/**
* @param value The total amount of cost to track with the budget.
*/
@JvmName("bxiugmrrlfbltuha")
public suspend fun amount(`value`: Double?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.amount = mapped
}
/**
* @param value (Optional) The ETag of the Management Group Consumption Budget.
*/
@JvmName("wfwpjufketxpjsge")
public suspend fun etag(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.etag = mapped
}
/**
* @param value A `filter` block as defined below.
*/
@JvmName("unpvxkshqnusmcop")
public suspend fun filter(`value`: BudgetManagementGroupFilterArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.filter = mapped
}
/**
* @param argument A `filter` block as defined below.
*/
@JvmName("bnvgmqfkluskxfpl")
public suspend fun filter(argument: suspend BudgetManagementGroupFilterArgsBuilder.() -> Unit) {
val toBeMapped = BudgetManagementGroupFilterArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.filter = mapped
}
/**
* @param value The ID of the Management Group. Changing this forces a new resource to be created.
*/
@JvmName("igqroejrilgapoct")
public suspend fun managementGroupId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.managementGroupId = mapped
}
/**
* @param value The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
*/
@JvmName("adssxhxslhtoerxi")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value One or more `notification` blocks as defined below.
*/
@JvmName("wyjvwoifxrokponi")
public suspend fun notifications(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.notifications = mapped
}
/**
* @param argument One or more `notification` blocks as defined below.
*/
@JvmName("qymfbyomigdclyus")
public suspend fun notifications(argument: List Unit>) {
val toBeMapped = argument.toList().map {
BudgetManagementGroupNotificationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.notifications = mapped
}
/**
* @param argument One or more `notification` blocks as defined below.
*/
@JvmName("bmlsqcowvffdnvrs")
public suspend fun notifications(vararg argument: suspend BudgetManagementGroupNotificationArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
BudgetManagementGroupNotificationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.notifications = mapped
}
/**
* @param argument One or more `notification` blocks as defined below.
*/
@JvmName("ojxlypmqfrysparm")
public suspend fun notifications(argument: suspend BudgetManagementGroupNotificationArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
BudgetManagementGroupNotificationArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.notifications = mapped
}
/**
* @param values One or more `notification` blocks as defined below.
*/
@JvmName("vyyvuudjigyvharj")
public suspend fun notifications(vararg values: BudgetManagementGroupNotificationArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.notifications = mapped
}
/**
* @param value The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of `BillingAnnual`, `BillingMonth`, `BillingQuarter`, `Annually`, `Monthly` and `Quarterly`. Defaults to `Monthly`. Changing this forces a new resource to be created.
*/
@JvmName("npfqqfawfusqlnxb")
public suspend fun timeGrain(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.timeGrain = mapped
}
/**
* @param value A `time_period` block as defined below.
*/
@JvmName("xblhheeuakaiinio")
public suspend fun timePeriod(`value`: BudgetManagementGroupTimePeriodArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.timePeriod = mapped
}
/**
* @param argument A `time_period` block as defined below.
*/
@JvmName("iwadvxbmkxfhfwyl")
public suspend fun timePeriod(argument: suspend BudgetManagementGroupTimePeriodArgsBuilder.() -> Unit) {
val toBeMapped = BudgetManagementGroupTimePeriodArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.timePeriod = mapped
}
internal fun build(): BudgetManagementGroupArgs = BudgetManagementGroupArgs(
amount = amount,
etag = etag,
filter = filter,
managementGroupId = managementGroupId,
name = name,
notifications = notifications,
timeGrain = timeGrain,
timePeriod = timePeriod,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy