pulumi-azure-native-kotlin/com.pulumi.azurenative.consumption.kotlin/BudgetArgs

BudgetArgs

data class BudgetArgs(val amount: Output<Double>? = null, val budgetName: Output<String>? = null, val category: Output<Either<String, CategoryType>>? = null, val eTag: Output<String>? = null, val filter: Output<BudgetFilterArgs>? = null, val notifications: Output<Map<String, NotificationArgs>>? = null, val scope: Output<String>? = null, val timeGrain: Output<Either<String, TimeGrainType>>? = null, val timePeriod: Output<BudgetTimePeriodArgs>? = null) : ConvertibleToJava<BudgetArgs>

A budget resource. API Version: 2019-10-01.

Example Usage

CreateOrUpdateBudget

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var budget = new AzureNative.Consumption.Budget("budget", new()
    {
        Amount = 100.65,
        BudgetName = "TestBudget",
        Category = "Cost",
        ETag = "\"1d34d016a593709\"",
        Filter = new AzureNative.Consumption.Inputs.BudgetFilterArgs
        {
            And = new[]
            {
                new AzureNative.Consumption.Inputs.BudgetFilterPropertiesArgs
                {
                    Dimensions = new AzureNative.Consumption.Inputs.BudgetComparisonExpressionArgs
                    {
                        Name = "ResourceId",
                        Operator = "In",
                        Values = new[]
                        {
                            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
                            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1",
                        },
                    },
                },
                new AzureNative.Consumption.Inputs.BudgetFilterPropertiesArgs
                {
                    Tags = new AzureNative.Consumption.Inputs.BudgetComparisonExpressionArgs
                    {
                        Name = "category",
                        Operator = "In",
                        Values = new[]
                        {
                            "Dev",
                            "Prod",
                        },
                    },
                },
                new AzureNative.Consumption.Inputs.BudgetFilterPropertiesArgs
                {
                    Tags = new AzureNative.Consumption.Inputs.BudgetComparisonExpressionArgs
                    {
                        Name = "department",
                        Operator = "In",
                        Values = new[]
                        {
                            "engineering",
                            "sales",
                        },
                    },
                },
            },
        },
        Notifications =
        {
            { "Actual_GreaterThan_80_Percent", new AzureNative.Consumption.Inputs.NotificationArgs
            {
                ContactEmails = new[]
                {
                    "johndoe@contoso.com",
                    "janesmith@contoso.com",
                },
                ContactGroups = new[]
                {
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup",
                },
                ContactRoles = new[]
                {
                    "Contributor",
                    "Reader",
                },
                Enabled = true,
                Locale = "en-us",
                Operator = "GreaterThan",
                Threshold = 80,
                ThresholdType = "Actual",
            } },
        },
        Scope = "subscriptions/00000000-0000-0000-0000-000000000000",
        TimeGrain = "Monthly",
        TimePeriod = new AzureNative.Consumption.Inputs.BudgetTimePeriodArgs
        {
            EndDate = "2018-10-31T00:00:00Z",
            StartDate = "2017-10-01T00:00:00Z",
        },
    });
});

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.consumption.Budget;
import com.pulumi.azurenative.consumption.BudgetArgs;
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 budget = new Budget("budget", BudgetArgs.builder()
            .amount(100.65)
            .budgetName("TestBudget")
            .category("Cost")
            .eTag("\"1d34d016a593709\"")
            .filter(Map.of("and",
                Map.of("dimensions", Map.ofEntries(
                    Map.entry("name", "ResourceId"),
                    Map.entry("operator", "In"),
                    Map.entry("values",
                        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
                        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1")
                )),
                Map.of("tags", Map.ofEntries(
                    Map.entry("name", "category"),
                    Map.entry("operator", "In"),
                    Map.entry("values",
                        "Dev",
                        "Prod")
                )),
                Map.of("tags", Map.ofEntries(
                    Map.entry("name", "department"),
                    Map.entry("operator", "In"),
                    Map.entry("values",
                        "engineering",
                        "sales")
                ))))
            .notifications(Map.of("Actual_GreaterThan_80_Percent", Map.ofEntries(
                Map.entry("contactEmails",
                    "johndoe@contoso.com",
                    "janesmith@contoso.com"),
                Map.entry("contactGroups", "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"),
                Map.entry("contactRoles",
                    "Contributor",
                    "Reader"),
                Map.entry("enabled", true),
                Map.entry("locale", "en-us"),
                Map.entry("operator", "GreaterThan"),
                Map.entry("threshold", 80),
                Map.entry("thresholdType", "Actual")
            )))
            .scope("subscriptions/00000000-0000-0000-0000-000000000000")
            .timeGrain("Monthly")
            .timePeriod(Map.ofEntries(
                Map.entry("endDate", "2018-10-31T00:00:00Z"),
                Map.entry("startDate", "2017-10-01T00:00:00Z")
            ))
            .build());
    }
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:consumption:Budget TestBudget subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget

Constructors

BudgetArgs

fun BudgetArgs(amount: Output<Double>? = null, budgetName: Output<String>? = null, category: Output<Either<String, CategoryType>>? = null, eTag: Output<String>? = null, filter: Output<BudgetFilterArgs>? = null, notifications: Output<Map<String, NotificationArgs>>? = null, scope: Output<String>? = null, timeGrain: Output<Either<String, TimeGrainType>>? = null, timePeriod: Output<BudgetTimePeriodArgs>? = null)

Functions

toJava

open override fun toJava(): BudgetArgs

Properties

amount

val amount: Output<Double>? = null

The total amount of cost to track with the budget

budgetName

val budgetName: Output<String>? = null

Budget Name.

category

val category: Output<Either<String, CategoryType>>? = null

The category of the budget, whether the budget tracks cost or usage.

eTag

val eTag: Output<String>? = null

eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

filter

val filter: Output<BudgetFilterArgs>? = null

May be used to filter budgets by user-specified dimensions and/or tags.

notifications

val notifications: Output<Map<String, NotificationArgs>>? = null

Dictionary of notifications associated with the budget. Budget can have up to five notifications.

scope

val scope: Output<String>? = null

The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

timeGrain

val timeGrain: Output<Either<String, TimeGrainType>>? = null

The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers

timePeriod

val timePeriod: Output<BudgetTimePeriodArgs>? = null

Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.