com.pulumi.azure.consumption.kotlin.BudgetResourceGroupArgs.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.BudgetResourceGroupArgs.builder
import com.pulumi.azure.consumption.kotlin.inputs.BudgetResourceGroupFilterArgs
import com.pulumi.azure.consumption.kotlin.inputs.BudgetResourceGroupFilterArgsBuilder
import com.pulumi.azure.consumption.kotlin.inputs.BudgetResourceGroupNotificationArgs
import com.pulumi.azure.consumption.kotlin.inputs.BudgetResourceGroupNotificationArgsBuilder
import com.pulumi.azure.consumption.kotlin.inputs.BudgetResourceGroupTimePeriodArgs
import com.pulumi.azure.consumption.kotlin.inputs.BudgetResourceGroupTimePeriodArgsBuilder
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 Resource Group Consumption Budget.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example",
* location: "eastus",
* });
* const exampleActionGroup = new azure.monitoring.ActionGroup("example", {
* name: "example",
* resourceGroupName: example.name,
* shortName: "example",
* });
* const exampleBudgetResourceGroup = new azure.consumption.BudgetResourceGroup("example", {
* name: "example",
* resourceGroupId: example.id,
* amount: 1000,
* timeGrain: "Monthly",
* timePeriod: {
* startDate: "2022-06-01T00:00:00Z",
* endDate: "2022-07-01T00:00:00Z",
* },
* filter: {
* dimensions: [{
* name: "ResourceId",
* values: [exampleActionGroup.id],
* }],
* tags: [{
* name: "foo",
* values: [
* "bar",
* "baz",
* ],
* }],
* },
* notifications: [
* {
* enabled: true,
* threshold: 90,
* operator: "EqualTo",
* thresholdType: "Forecasted",
* contactEmails: [
* "[email protected]",
* "[email protected]",
* ],
* contactGroups: [exampleActionGroup.id],
* contactRoles: ["Owner"],
* },
* {
* enabled: false,
* threshold: 100,
* operator: "GreaterThan",
* contactEmails: [
* "[email protected]",
* "[email protected]",
* ],
* },
* ],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example",
* location="eastus")
* example_action_group = azure.monitoring.ActionGroup("example",
* name="example",
* resource_group_name=example.name,
* short_name="example")
* example_budget_resource_group = azure.consumption.BudgetResourceGroup("example",
* name="example",
* resource_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": "ResourceId",
* "values": [example_action_group.id],
* }],
* "tags": [{
* "name": "foo",
* "values": [
* "bar",
* "baz",
* ],
* }],
* },
* notifications=[
* {
* "enabled": True,
* "threshold": 90,
* "operator": "EqualTo",
* "threshold_type": "Forecasted",
* "contact_emails": [
* "[email protected]",
* "[email protected]",
* ],
* "contact_groups": [example_action_group.id],
* "contact_roles": ["Owner"],
* },
* {
* "enabled": False,
* "threshold": 100,
* "operator": "GreaterThan",
* "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.Core.ResourceGroup("example", new()
* {
* Name = "example",
* Location = "eastus",
* });
* var exampleActionGroup = new Azure.Monitoring.ActionGroup("example", new()
* {
* Name = "example",
* ResourceGroupName = example.Name,
* ShortName = "example",
* });
* var exampleBudgetResourceGroup = new Azure.Consumption.BudgetResourceGroup("example", new()
* {
* Name = "example",
* ResourceGroupId = example.Id,
* Amount = 1000,
* TimeGrain = "Monthly",
* TimePeriod = new Azure.Consumption.Inputs.BudgetResourceGroupTimePeriodArgs
* {
* StartDate = "2022-06-01T00:00:00Z",
* EndDate = "2022-07-01T00:00:00Z",
* },
* Filter = new Azure.Consumption.Inputs.BudgetResourceGroupFilterArgs
* {
* Dimensions = new[]
* {
* new Azure.Consumption.Inputs.BudgetResourceGroupFilterDimensionArgs
* {
* Name = "ResourceId",
* Values = new[]
* {
* exampleActionGroup.Id,
* },
* },
* },
* Tags = new[]
* {
* new Azure.Consumption.Inputs.BudgetResourceGroupFilterTagArgs
* {
* Name = "foo",
* Values = new[]
* {
* "bar",
* "baz",
* },
* },
* },
* },
* Notifications = new[]
* {
* new Azure.Consumption.Inputs.BudgetResourceGroupNotificationArgs
* {
* Enabled = true,
* Threshold = 90,
* Operator = "EqualTo",
* ThresholdType = "Forecasted",
* ContactEmails = new[]
* {
* "[email protected]",
* "[email protected]",
* },
* ContactGroups = new[]
* {
* exampleActionGroup.Id,
* },
* ContactRoles = new[]
* {
* "Owner",
* },
* },
* new Azure.Consumption.Inputs.BudgetResourceGroupNotificationArgs
* {
* Enabled = false,
* Threshold = 100,
* Operator = "GreaterThan",
* 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/monitoring"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example"),
* Location: pulumi.String("eastus"),
* })
* if err != nil {
* return err
* }
* exampleActionGroup, err := monitoring.NewActionGroup(ctx, "example", &monitoring.ActionGroupArgs{
* Name: pulumi.String("example"),
* ResourceGroupName: example.Name,
* ShortName: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* _, err = consumption.NewBudgetResourceGroup(ctx, "example", &consumption.BudgetResourceGroupArgs{
* Name: pulumi.String("example"),
* ResourceGroupId: example.ID(),
* Amount: pulumi.Float64(1000),
* TimeGrain: pulumi.String("Monthly"),
* TimePeriod: &consumption.BudgetResourceGroupTimePeriodArgs{
* StartDate: pulumi.String("2022-06-01T00:00:00Z"),
* EndDate: pulumi.String("2022-07-01T00:00:00Z"),
* },
* Filter: &consumption.BudgetResourceGroupFilterArgs{
* Dimensions: consumption.BudgetResourceGroupFilterDimensionArray{
* &consumption.BudgetResourceGroupFilterDimensionArgs{
* Name: pulumi.String("ResourceId"),
* Values: pulumi.StringArray{
* exampleActionGroup.ID(),
* },
* },
* },
* Tags: consumption.BudgetResourceGroupFilterTagArray{
* &consumption.BudgetResourceGroupFilterTagArgs{
* Name: pulumi.String("foo"),
* Values: pulumi.StringArray{
* pulumi.String("bar"),
* pulumi.String("baz"),
* },
* },
* },
* },
* Notifications: consumption.BudgetResourceGroupNotificationArray{
* &consumption.BudgetResourceGroupNotificationArgs{
* Enabled: pulumi.Bool(true),
* Threshold: pulumi.Int(90),
* Operator: pulumi.String("EqualTo"),
* ThresholdType: pulumi.String("Forecasted"),
* ContactEmails: pulumi.StringArray{
* pulumi.String("[email protected]"),
* pulumi.String("[email protected]"),
* },
* ContactGroups: pulumi.StringArray{
* exampleActionGroup.ID(),
* },
* ContactRoles: pulumi.StringArray{
* pulumi.String("Owner"),
* },
* },
* &consumption.BudgetResourceGroupNotificationArgs{
* Enabled: pulumi.Bool(false),
* Threshold: pulumi.Int(100),
* Operator: pulumi.String("GreaterThan"),
* 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.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.monitoring.ActionGroup;
* import com.pulumi.azure.monitoring.ActionGroupArgs;
* import com.pulumi.azure.consumption.BudgetResourceGroup;
* import com.pulumi.azure.consumption.BudgetResourceGroupArgs;
* import com.pulumi.azure.consumption.inputs.BudgetResourceGroupTimePeriodArgs;
* import com.pulumi.azure.consumption.inputs.BudgetResourceGroupFilterArgs;
* import com.pulumi.azure.consumption.inputs.BudgetResourceGroupNotificationArgs;
* 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 ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example")
* .location("eastus")
* .build());
* var exampleActionGroup = new ActionGroup("exampleActionGroup", ActionGroupArgs.builder()
* .name("example")
* .resourceGroupName(example.name())
* .shortName("example")
* .build());
* var exampleBudgetResourceGroup = new BudgetResourceGroup("exampleBudgetResourceGroup", BudgetResourceGroupArgs.builder()
* .name("example")
* .resourceGroupId(example.id())
* .amount(1000)
* .timeGrain("Monthly")
* .timePeriod(BudgetResourceGroupTimePeriodArgs.builder()
* .startDate("2022-06-01T00:00:00Z")
* .endDate("2022-07-01T00:00:00Z")
* .build())
* .filter(BudgetResourceGroupFilterArgs.builder()
* .dimensions(BudgetResourceGroupFilterDimensionArgs.builder()
* .name("ResourceId")
* .values(exampleActionGroup.id())
* .build())
* .tags(BudgetResourceGroupFilterTagArgs.builder()
* .name("foo")
* .values(
* "bar",
* "baz")
* .build())
* .build())
* .notifications(
* BudgetResourceGroupNotificationArgs.builder()
* .enabled(true)
* .threshold(90)
* .operator("EqualTo")
* .thresholdType("Forecasted")
* .contactEmails(
* "[email protected]",
* "[email protected]")
* .contactGroups(exampleActionGroup.id())
* .contactRoles("Owner")
* .build(),
* BudgetResourceGroupNotificationArgs.builder()
* .enabled(false)
* .threshold(100)
* .operator("GreaterThan")
* .contactEmails(
* "[email protected]",
* "[email protected]")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example
* location: eastus
* exampleActionGroup:
* type: azure:monitoring:ActionGroup
* name: example
* properties:
* name: example
* resourceGroupName: ${example.name}
* shortName: example
* exampleBudgetResourceGroup:
* type: azure:consumption:BudgetResourceGroup
* name: example
* properties:
* name: example
* resourceGroupId: ${example.id}
* amount: 1000
* timeGrain: Monthly
* timePeriod:
* startDate: 2022-06-01T00:00:00Z
* endDate: 2022-07-01T00:00:00Z
* filter:
* dimensions:
* - name: ResourceId
* values:
* - ${exampleActionGroup.id}
* tags:
* - name: foo
* values:
* - bar
* - baz
* notifications:
* - enabled: true
* threshold: 90
* operator: EqualTo
* thresholdType: Forecasted
* contactEmails:
* - [email protected]
* - [email protected]
* contactGroups:
* - ${exampleActionGroup.id}
* contactRoles:
* - Owner
* - enabled: false
* threshold: 100
* operator: GreaterThan
* contactEmails:
* - [email protected]
* - [email protected]
* ```
*
* ## Import
* Resource Group Consumption Budgets can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:consumption/budgetResourceGroup:BudgetResourceGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Consumption/budgets/resourceGroup1
* ```
* @property amount The total amount of cost to track with the budget.
* @property etag (Optional) The ETag of the Resource Group Consumption Budget
* @property filter A `filter` block as defined below.
* @property name The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
* @property notifications One or more `notification` blocks as defined below.
* @property resourceGroupId The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
* @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 BudgetResourceGroupArgs(
public val amount: Output? = null,
public val etag: Output? = null,
public val filter: Output? = null,
public val name: Output? = null,
public val notifications: Output>? = null,
public val resourceGroupId: Output? = null,
public val timeGrain: Output? = null,
public val timePeriod: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.consumption.BudgetResourceGroupArgs =
com.pulumi.azure.consumption.BudgetResourceGroupArgs.builder()
.amount(amount?.applyValue({ args0 -> args0 }))
.etag(etag?.applyValue({ args0 -> args0 }))
.filter(filter?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.name(name?.applyValue({ args0 -> args0 }))
.notifications(
notifications?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.resourceGroupId(resourceGroupId?.applyValue({ args0 -> args0 }))
.timeGrain(timeGrain?.applyValue({ args0 -> args0 }))
.timePeriod(timePeriod?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) })).build()
}
/**
* Builder for [BudgetResourceGroupArgs].
*/
@PulumiTagMarker
public class BudgetResourceGroupArgsBuilder internal constructor() {
private var amount: Output? = null
private var etag: Output? = null
private var filter: Output? = null
private var name: Output? = null
private var notifications: Output>? = null
private var resourceGroupId: 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("lootermbbbbrbqbp")
public suspend fun amount(`value`: Output) {
this.amount = value
}
/**
* @param value (Optional) The ETag of the Resource Group Consumption Budget
*/
@JvmName("gcoseoakdosojpbt")
public suspend fun etag(`value`: Output) {
this.etag = value
}
/**
* @param value A `filter` block as defined below.
*/
@JvmName("rkrdwiqxjeoondnw")
public suspend fun filter(`value`: Output) {
this.filter = value
}
/**
* @param value The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
*/
@JvmName("lgkrxblncahvlkpn")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value One or more `notification` blocks as defined below.
*/
@JvmName("qovgkfdvpvnucnvo")
public suspend fun notifications(`value`: Output>) {
this.notifications = value
}
@JvmName("spbdcfuwrptfgpoj")
public suspend fun notifications(vararg values: Output) {
this.notifications = Output.all(values.asList())
}
/**
* @param values One or more `notification` blocks as defined below.
*/
@JvmName("sujyemwnqjrqeatb")
public suspend fun notifications(values: List>) {
this.notifications = Output.all(values)
}
/**
* @param value The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
*/
@JvmName("dxyjtwijvdfbhaxq")
public suspend fun resourceGroupId(`value`: Output) {
this.resourceGroupId = value
}
/**
* @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("rgkbegkoxilbyqat")
public suspend fun timeGrain(`value`: Output) {
this.timeGrain = value
}
/**
* @param value A `time_period` block as defined below.
*/
@JvmName("arjhxunwqwuymubd")
public suspend fun timePeriod(`value`: Output) {
this.timePeriod = value
}
/**
* @param value The total amount of cost to track with the budget.
*/
@JvmName("aigjadmpevdukvjd")
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 Resource Group Consumption Budget
*/
@JvmName("vohwrryruyrvpidb")
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("jjjsbustusidgerf")
public suspend fun filter(`value`: BudgetResourceGroupFilterArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.filter = mapped
}
/**
* @param argument A `filter` block as defined below.
*/
@JvmName("gfvbfmbvityegcwd")
public suspend fun filter(argument: suspend BudgetResourceGroupFilterArgsBuilder.() -> Unit) {
val toBeMapped = BudgetResourceGroupFilterArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.filter = mapped
}
/**
* @param value The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
*/
@JvmName("hehuicwjmpnjanei")
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("eknpyaoggfybpmfy")
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("dxubyifmayreeivy")
public suspend fun notifications(argument: List Unit>) {
val toBeMapped = argument.toList().map {
BudgetResourceGroupNotificationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.notifications = mapped
}
/**
* @param argument One or more `notification` blocks as defined below.
*/
@JvmName("eedgdplahleunekv")
public suspend fun notifications(vararg argument: suspend BudgetResourceGroupNotificationArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
BudgetResourceGroupNotificationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.notifications = mapped
}
/**
* @param argument One or more `notification` blocks as defined below.
*/
@JvmName("jvjrqoymxhuggujn")
public suspend fun notifications(argument: suspend BudgetResourceGroupNotificationArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
BudgetResourceGroupNotificationArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.notifications = mapped
}
/**
* @param values One or more `notification` blocks as defined below.
*/
@JvmName("aqvwalwyakqbwqra")
public suspend fun notifications(vararg values: BudgetResourceGroupNotificationArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.notifications = mapped
}
/**
* @param value The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
*/
@JvmName("flyutuommmbhsynf")
public suspend fun resourceGroupId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupId = 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("bmrrgdlilrykwbob")
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("ppcwuqbnsfmxgcju")
public suspend fun timePeriod(`value`: BudgetResourceGroupTimePeriodArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.timePeriod = mapped
}
/**
* @param argument A `time_period` block as defined below.
*/
@JvmName("kmlplddytomdgaus")
public suspend fun timePeriod(argument: suspend BudgetResourceGroupTimePeriodArgsBuilder.() -> Unit) {
val toBeMapped = BudgetResourceGroupTimePeriodArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.timePeriod = mapped
}
internal fun build(): BudgetResourceGroupArgs = BudgetResourceGroupArgs(
amount = amount,
etag = etag,
filter = filter,
name = name,
notifications = notifications,
resourceGroupId = resourceGroupId,
timeGrain = timeGrain,
timePeriod = timePeriod,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy