com.pulumi.azure.consumption.kotlin.BudgetSubscription.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.kotlin.outputs.BudgetSubscriptionFilter
import com.pulumi.azure.consumption.kotlin.outputs.BudgetSubscriptionNotification
import com.pulumi.azure.consumption.kotlin.outputs.BudgetSubscriptionTimePeriod
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.Boolean
import kotlin.Double
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.azure.consumption.kotlin.outputs.BudgetSubscriptionFilter.Companion.toKotlin as budgetSubscriptionFilterToKotlin
import com.pulumi.azure.consumption.kotlin.outputs.BudgetSubscriptionNotification.Companion.toKotlin as budgetSubscriptionNotificationToKotlin
import com.pulumi.azure.consumption.kotlin.outputs.BudgetSubscriptionTimePeriod.Companion.toKotlin as budgetSubscriptionTimePeriodToKotlin
/**
* Builder for [BudgetSubscription].
*/
@PulumiTagMarker
public class BudgetSubscriptionResourceBuilder internal constructor() {
public var name: String? = null
public var args: BudgetSubscriptionArgs = BudgetSubscriptionArgs()
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 BudgetSubscriptionArgsBuilder.() -> Unit) {
val builder = BudgetSubscriptionArgsBuilder()
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(): BudgetSubscription {
val builtJavaResource = com.pulumi.azure.consumption.BudgetSubscription(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return BudgetSubscription(builtJavaResource)
}
}
/**
* Manages a Subscription Consumption Budget.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const current = azure.core.getSubscription({});
* 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 exampleBudgetSubscription = new azure.consumption.BudgetSubscription("example", {
* name: "example",
* subscriptionId: current.then(current => current.id),
* amount: 1000,
* timeGrain: "Monthly",
* timePeriod: {
* startDate: "2022-06-01T00:00:00Z",
* endDate: "2022-07-01T00:00:00Z",
* },
* filter: {
* dimensions: [{
* name: "ResourceGroupName",
* values: [example.name],
* }],
* tags: [{
* name: "foo",
* values: [
* "bar",
* "baz",
* ],
* }],
* },
* notifications: [
* {
* enabled: true,
* threshold: 90,
* operator: "EqualTo",
* contactEmails: [
* "[email protected]",
* "[email protected]",
* ],
* contactGroups: [exampleActionGroup.id],
* contactRoles: ["Owner"],
* },
* {
* enabled: false,
* threshold: 100,
* operator: "GreaterThan",
* thresholdType: "Forecasted",
* contactEmails: [
* "[email protected]",
* "[email protected]",
* ],
* },
* ],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* current = azure.core.get_subscription()
* 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_subscription = azure.consumption.BudgetSubscription("example",
* name="example",
* subscription_id=current.id,
* amount=1000,
* time_grain="Monthly",
* time_period=azure.consumption.BudgetSubscriptionTimePeriodArgs(
* start_date="2022-06-01T00:00:00Z",
* end_date="2022-07-01T00:00:00Z",
* ),
* filter=azure.consumption.BudgetSubscriptionFilterArgs(
* dimensions=[azure.consumption.BudgetSubscriptionFilterDimensionArgs(
* name="ResourceGroupName",
* values=[example.name],
* )],
* tags=[azure.consumption.BudgetSubscriptionFilterTagArgs(
* name="foo",
* values=[
* "bar",
* "baz",
* ],
* )],
* ),
* notifications=[
* azure.consumption.BudgetSubscriptionNotificationArgs(
* enabled=True,
* threshold=90,
* operator="EqualTo",
* contact_emails=[
* "[email protected]",
* "[email protected]",
* ],
* contact_groups=[example_action_group.id],
* contact_roles=["Owner"],
* ),
* azure.consumption.BudgetSubscriptionNotificationArgs(
* 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 current = Azure.Core.GetSubscription.Invoke();
* 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 exampleBudgetSubscription = new Azure.Consumption.BudgetSubscription("example", new()
* {
* Name = "example",
* SubscriptionId = current.Apply(getSubscriptionResult => getSubscriptionResult.Id),
* Amount = 1000,
* TimeGrain = "Monthly",
* TimePeriod = new Azure.Consumption.Inputs.BudgetSubscriptionTimePeriodArgs
* {
* StartDate = "2022-06-01T00:00:00Z",
* EndDate = "2022-07-01T00:00:00Z",
* },
* Filter = new Azure.Consumption.Inputs.BudgetSubscriptionFilterArgs
* {
* Dimensions = new[]
* {
* new Azure.Consumption.Inputs.BudgetSubscriptionFilterDimensionArgs
* {
* Name = "ResourceGroupName",
* Values = new[]
* {
* example.Name,
* },
* },
* },
* Tags = new[]
* {
* new Azure.Consumption.Inputs.BudgetSubscriptionFilterTagArgs
* {
* Name = "foo",
* Values = new[]
* {
* "bar",
* "baz",
* },
* },
* },
* },
* Notifications = new[]
* {
* new Azure.Consumption.Inputs.BudgetSubscriptionNotificationArgs
* {
* Enabled = true,
* Threshold = 90,
* Operator = "EqualTo",
* ContactEmails = new[]
* {
* "[email protected]",
* "[email protected]",
* },
* ContactGroups = new[]
* {
* exampleActionGroup.Id,
* },
* ContactRoles = new[]
* {
* "Owner",
* },
* },
* new Azure.Consumption.Inputs.BudgetSubscriptionNotificationArgs
* {
* 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/monitoring"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* current, err := core.LookupSubscription(ctx, nil, nil)
* if err != nil {
* return err
* }
* 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.NewBudgetSubscription(ctx, "example", &consumption.BudgetSubscriptionArgs{
* Name: pulumi.String("example"),
* SubscriptionId: pulumi.String(current.Id),
* Amount: pulumi.Float64(1000),
* TimeGrain: pulumi.String("Monthly"),
* TimePeriod: &consumption.BudgetSubscriptionTimePeriodArgs{
* StartDate: pulumi.String("2022-06-01T00:00:00Z"),
* EndDate: pulumi.String("2022-07-01T00:00:00Z"),
* },
* Filter: &consumption.BudgetSubscriptionFilterArgs{
* Dimensions: consumption.BudgetSubscriptionFilterDimensionArray{
* &consumption.BudgetSubscriptionFilterDimensionArgs{
* Name: pulumi.String("ResourceGroupName"),
* Values: pulumi.StringArray{
* example.Name,
* },
* },
* },
* Tags: consumption.BudgetSubscriptionFilterTagArray{
* &consumption.BudgetSubscriptionFilterTagArgs{
* Name: pulumi.String("foo"),
* Values: pulumi.StringArray{
* pulumi.String("bar"),
* pulumi.String("baz"),
* },
* },
* },
* },
* Notifications: consumption.BudgetSubscriptionNotificationArray{
* &consumption.BudgetSubscriptionNotificationArgs{
* Enabled: pulumi.Bool(true),
* Threshold: pulumi.Int(90),
* Operator: pulumi.String("EqualTo"),
* ContactEmails: pulumi.StringArray{
* pulumi.String("[email protected]"),
* pulumi.String("[email protected]"),
* },
* ContactGroups: pulumi.StringArray{
* exampleActionGroup.ID(),
* },
* ContactRoles: pulumi.StringArray{
* pulumi.String("Owner"),
* },
* },
* &consumption.BudgetSubscriptionNotificationArgs{
* 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.core.CoreFunctions;
* import com.pulumi.azure.core.inputs.GetSubscriptionArgs;
* 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.BudgetSubscription;
* import com.pulumi.azure.consumption.BudgetSubscriptionArgs;
* import com.pulumi.azure.consumption.inputs.BudgetSubscriptionTimePeriodArgs;
* import com.pulumi.azure.consumption.inputs.BudgetSubscriptionFilterArgs;
* import com.pulumi.azure.consumption.inputs.BudgetSubscriptionNotificationArgs;
* 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) {
* final var current = CoreFunctions.getSubscription();
* 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 exampleBudgetSubscription = new BudgetSubscription("exampleBudgetSubscription", BudgetSubscriptionArgs.builder()
* .name("example")
* .subscriptionId(current.applyValue(getSubscriptionResult -> getSubscriptionResult.id()))
* .amount(1000)
* .timeGrain("Monthly")
* .timePeriod(BudgetSubscriptionTimePeriodArgs.builder()
* .startDate("2022-06-01T00:00:00Z")
* .endDate("2022-07-01T00:00:00Z")
* .build())
* .filter(BudgetSubscriptionFilterArgs.builder()
* .dimensions(BudgetSubscriptionFilterDimensionArgs.builder()
* .name("ResourceGroupName")
* .values(example.name())
* .build())
* .tags(BudgetSubscriptionFilterTagArgs.builder()
* .name("foo")
* .values(
* "bar",
* "baz")
* .build())
* .build())
* .notifications(
* BudgetSubscriptionNotificationArgs.builder()
* .enabled(true)
* .threshold(90)
* .operator("EqualTo")
* .contactEmails(
* "[email protected]",
* "[email protected]")
* .contactGroups(exampleActionGroup.id())
* .contactRoles("Owner")
* .build(),
* BudgetSubscriptionNotificationArgs.builder()
* .enabled(false)
* .threshold(100)
* .operator("GreaterThan")
* .thresholdType("Forecasted")
* .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
* exampleBudgetSubscription:
* type: azure:consumption:BudgetSubscription
* name: example
* properties:
* name: example
* subscriptionId: ${current.id}
* amount: 1000
* timeGrain: Monthly
* timePeriod:
* startDate: 2022-06-01T00:00:00Z
* endDate: 2022-07-01T00:00:00Z
* filter:
* dimensions:
* - name: ResourceGroupName
* values:
* - ${example.name}
* tags:
* - name: foo
* values:
* - bar
* - baz
* notifications:
* - enabled: true
* threshold: 90
* operator: EqualTo
* contactEmails:
* - [email protected]
* - [email protected]
* contactGroups:
* - ${exampleActionGroup.id}
* contactRoles:
* - Owner
* - enabled: false
* threshold: 100
* operator: GreaterThan
* thresholdType: Forecasted
* contactEmails:
* - [email protected]
* - [email protected]
* variables:
* current:
* fn::invoke:
* Function: azure:core:getSubscription
* Arguments: {}
* ```
*
* ## Import
* Subscription Consumption Budgets can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:consumption/budgetSubscription:BudgetSubscription example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/subscription1
* ```
*/
public class BudgetSubscription internal constructor(
override val javaResource: com.pulumi.azure.consumption.BudgetSubscription,
) : KotlinCustomResource(javaResource, BudgetSubscriptionMapper) {
/**
* The total amount of cost to track with the budget.
*/
public val amount: Output
get() = javaResource.amount().applyValue({ args0 -> args0 })
/**
* (Optional) The ETag of the Subscription Consumption Budget.
*/
public val etag: Output
get() = javaResource.etag().applyValue({ args0 -> args0 })
/**
* A `filter` block as defined below.
*/
public val filter: Output?
get() = javaResource.filter().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
budgetSubscriptionFilterToKotlin(args0)
})
}).orElse(null)
})
/**
* The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* One or more `notification` blocks as defined below.
*/
public val notifications: Output>
get() = javaResource.notifications().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> budgetSubscriptionNotificationToKotlin(args0) })
})
})
/**
* The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.
* > **NOTE:** The `subscription_id` property can accept a subscription ID e.g. `00000000-0000-0000-0000-000000000000` or the subscription resource ID e.g. `/subscriptions/00000000-0000-0000-0000-000000000000`. In version 3.0 this property will only accept the subscription resource ID.
*/
public val subscriptionId: Output
get() = javaResource.subscriptionId().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val timeGrain: Output?
get() = javaResource.timeGrain().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A `time_period` block as defined below.
*/
public val timePeriod: Output
get() = javaResource.timePeriod().applyValue({ args0 ->
args0.let({ args0 ->
budgetSubscriptionTimePeriodToKotlin(args0)
})
})
}
public object BudgetSubscriptionMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.consumption.BudgetSubscription::class == javaResource::class
override fun map(javaResource: Resource): BudgetSubscription = BudgetSubscription(
javaResource as
com.pulumi.azure.consumption.BudgetSubscription,
)
}
/**
* @see [BudgetSubscription].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [BudgetSubscription].
*/
public suspend fun budgetSubscription(
name: String,
block: suspend BudgetSubscriptionResourceBuilder.() -> Unit,
): BudgetSubscription {
val builder = BudgetSubscriptionResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [BudgetSubscription].
* @param name The _unique_ name of the resulting resource.
*/
public fun budgetSubscription(name: String): BudgetSubscription {
val builder = BudgetSubscriptionResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy