Docs Packages
  1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. consumption
  5. BudgetManagementGroup
azure logo
Azure Classic v5.43.0, May 6 23

azure.consumption.BudgetManagementGroup

Explore with Pulumi AI

Manages a Consumption Budget for a Management Group.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleGroup = new Azure.Management.Group("exampleGroup", new()
    {
        DisplayName = "example",
    });

    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "eastus",
    });

    var exampleBudgetManagementGroup = new Azure.Consumption.BudgetManagementGroup("exampleBudgetManagementGroup", new()
    {
        ManagementGroupId = exampleGroup.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[]
                {
                    "foo@example.com",
                    "bar@example.com",
                },
            },
            new Azure.Consumption.Inputs.BudgetManagementGroupNotificationArgs
            {
                Enabled = false,
                Threshold = 100,
                Operator = "GreaterThan",
                ThresholdType = "Forecasted",
                ContactEmails = new[]
                {
                    "foo@example.com",
                    "bar@example.com",
                },
            },
        },
    });

});

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 {
		exampleGroup, err := management.NewGroup(ctx, "exampleGroup", &management.GroupArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("eastus"),
		})
		if err != nil {
			return err
		}
		_, err = consumption.NewBudgetManagementGroup(ctx, "exampleBudgetManagementGroup", &consumption.BudgetManagementGroupArgs{
			ManagementGroupId: exampleGroup.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("foo@example.com"),
						pulumi.String("bar@example.com"),
					},
				},
				&consumption.BudgetManagementGroupNotificationArgs{
					Enabled:       pulumi.Bool(false),
					Threshold:     pulumi.Int(100),
					Operator:      pulumi.String("GreaterThan"),
					ThresholdType: pulumi.String("Forecasted"),
					ContactEmails: pulumi.StringArray{
						pulumi.String("foo@example.com"),
						pulumi.String("bar@example.com"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleGroup = new Group("exampleGroup", GroupArgs.builder()        
            .displayName("example")
            .build());

        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("eastus")
            .build());

        var exampleBudgetManagementGroup = new BudgetManagementGroup("exampleBudgetManagementGroup", BudgetManagementGroupArgs.builder()        
            .managementGroupId(exampleGroup.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(                    
                        "foo@example.com",
                        "bar@example.com")
                    .build(),
                BudgetManagementGroupNotificationArgs.builder()
                    .enabled(false)
                    .threshold(100)
                    .operator("GreaterThan")
                    .thresholdType("Forecasted")
                    .contactEmails(                    
                        "foo@example.com",
                        "bar@example.com")
                    .build())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_group = azure.management.Group("exampleGroup", display_name="example")
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_budget_management_group = azure.consumption.BudgetManagementGroup("exampleBudgetManagementGroup",
    management_group_id=example_group.id,
    amount=1000,
    time_grain="Monthly",
    time_period=azure.consumption.BudgetManagementGroupTimePeriodArgs(
        start_date="2022-06-01T00:00:00Z",
        end_date="2022-07-01T00:00:00Z",
    ),
    filter=azure.consumption.BudgetManagementGroupFilterArgs(
        dimensions=[azure.consumption.BudgetManagementGroupFilterDimensionArgs(
            name="ResourceGroupName",
            values=[example_resource_group.name],
        )],
        tags=[azure.consumption.BudgetManagementGroupFilterTagArgs(
            name="foo",
            values=[
                "bar",
                "baz",
            ],
        )],
    ),
    notifications=[
        azure.consumption.BudgetManagementGroupNotificationArgs(
            enabled=True,
            threshold=90,
            operator="EqualTo",
            contact_emails=[
                "foo@example.com",
                "bar@example.com",
            ],
        ),
        azure.consumption.BudgetManagementGroupNotificationArgs(
            enabled=False,
            threshold=100,
            operator="GreaterThan",
            threshold_type="Forecasted",
            contact_emails=[
                "foo@example.com",
                "bar@example.com",
            ],
        ),
    ])

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleGroup = new azure.management.Group("exampleGroup", {displayName: "example"});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "eastus"});
const exampleBudgetManagementGroup = new azure.consumption.BudgetManagementGroup("exampleBudgetManagementGroup", {
    managementGroupId: exampleGroup.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: [
                "foo@example.com",
                "bar@example.com",
            ],
        },
        {
            enabled: false,
            threshold: 100,
            operator: "GreaterThan",
            thresholdType: "Forecasted",
            contactEmails: [
                "foo@example.com",
                "bar@example.com",
            ],
        },
    ],
});

resources:
  exampleGroup:
    type: azure:management:Group
    properties:
      displayName: example
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: eastus
  exampleBudgetManagementGroup:
    type: azure:consumption:BudgetManagementGroup
    properties:
      managementGroupId: ${exampleGroup.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:
            - foo@example.com
            - bar@example.com
        - enabled: false
          threshold: 100
          operator: GreaterThan
          thresholdType: Forecasted
          contactEmails:
            - foo@example.com
            - bar@example.com

Create BudgetManagementGroup Resource

new BudgetManagementGroup(name: string, args: BudgetManagementGroupArgs, opts?: CustomResourceOptions);
@overload
def BudgetManagementGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          amount: Optional[float] = None,
                          etag: Optional[str] = None,
                          filter: Optional[BudgetManagementGroupFilterArgs] = None,
                          management_group_id: Optional[str] = None,
                          name: Optional[str] = None,
                          notifications: Optional[Sequence[BudgetManagementGroupNotificationArgs]] = None,
                          time_grain: Optional[str] = None,
                          time_period: Optional[BudgetManagementGroupTimePeriodArgs] = None)
@overload
def BudgetManagementGroup(resource_name: str,
                          args: BudgetManagementGroupArgs,
                          opts: Optional[ResourceOptions] = None)
func NewBudgetManagementGroup(ctx *Context, name string, args BudgetManagementGroupArgs, opts ...ResourceOption) (*BudgetManagementGroup, error)
public BudgetManagementGroup(string name, BudgetManagementGroupArgs args, CustomResourceOptions? opts = null)
public BudgetManagementGroup(String name, BudgetManagementGroupArgs args)
public BudgetManagementGroup(String name, BudgetManagementGroupArgs args, CustomResourceOptions options)

type: azure:consumption:BudgetManagementGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BudgetManagementGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BudgetManagementGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BudgetManagementGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BudgetManagementGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BudgetManagementGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BudgetManagementGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The BudgetManagementGroup resource accepts the following input properties:

Amount double

The total amount of cost to track with the budget.

ManagementGroupId string

The ID of the Management Group. Changing this forces a new resource to be created.

Notifications List<BudgetManagementGroupNotificationArgs>

One or more notification blocks as defined below.

TimePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

Etag string

(Optional) The ETag of the Management Group Consumption Budget.

Filter BudgetManagementGroupFilterArgs

A filter block as defined below.

Name string

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

TimeGrain string

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.

Amount float64

The total amount of cost to track with the budget.

ManagementGroupId string

The ID of the Management Group. Changing this forces a new resource to be created.

Notifications []BudgetManagementGroupNotificationArgs

One or more notification blocks as defined below.

TimePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

Etag string

(Optional) The ETag of the Management Group Consumption Budget.

Filter BudgetManagementGroupFilterArgs

A filter block as defined below.

Name string

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

TimeGrain string

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.

amount Double

The total amount of cost to track with the budget.

managementGroupId String

The ID of the Management Group. Changing this forces a new resource to be created.

notifications List<BudgetManagementGroupNotificationArgs>

One or more notification blocks as defined below.

timePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

etag String

(Optional) The ETag of the Management Group Consumption Budget.

filter BudgetManagementGroupFilterArgs

A filter block as defined below.

name String

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

timeGrain String

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.

amount number

The total amount of cost to track with the budget.

managementGroupId string

The ID of the Management Group. Changing this forces a new resource to be created.

notifications BudgetManagementGroupNotificationArgs[]

One or more notification blocks as defined below.

timePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

etag string

(Optional) The ETag of the Management Group Consumption Budget.

filter BudgetManagementGroupFilterArgs

A filter block as defined below.

name string

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

timeGrain string

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.

amount float

The total amount of cost to track with the budget.

management_group_id str

The ID of the Management Group. Changing this forces a new resource to be created.

notifications Sequence[BudgetManagementGroupNotificationArgs]

One or more notification blocks as defined below.

time_period BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

etag str

(Optional) The ETag of the Management Group Consumption Budget.

filter BudgetManagementGroupFilterArgs

A filter block as defined below.

name str

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

time_grain str

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.

amount Number

The total amount of cost to track with the budget.

managementGroupId String

The ID of the Management Group. Changing this forces a new resource to be created.

notifications List<Property Map>

One or more notification blocks as defined below.

timePeriod Property Map

A time_period block as defined below.

etag String

(Optional) The ETag of the Management Group Consumption Budget.

filter Property Map

A filter block as defined below.

name String

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

timeGrain String

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the BudgetManagementGroup resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing BudgetManagementGroup Resource

Get an existing BudgetManagementGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BudgetManagementGroupState, opts?: CustomResourceOptions): BudgetManagementGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[float] = None,
        etag: Optional[str] = None,
        filter: Optional[BudgetManagementGroupFilterArgs] = None,
        management_group_id: Optional[str] = None,
        name: Optional[str] = None,
        notifications: Optional[Sequence[BudgetManagementGroupNotificationArgs]] = None,
        time_grain: Optional[str] = None,
        time_period: Optional[BudgetManagementGroupTimePeriodArgs] = None) -> BudgetManagementGroup
func GetBudgetManagementGroup(ctx *Context, name string, id IDInput, state *BudgetManagementGroupState, opts ...ResourceOption) (*BudgetManagementGroup, error)
public static BudgetManagementGroup Get(string name, Input<string> id, BudgetManagementGroupState? state, CustomResourceOptions? opts = null)
public static BudgetManagementGroup get(String name, Output<String> id, BudgetManagementGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Amount double

The total amount of cost to track with the budget.

Etag string

(Optional) The ETag of the Management Group Consumption Budget.

Filter BudgetManagementGroupFilterArgs

A filter block as defined below.

ManagementGroupId string

The ID of the Management Group. Changing this forces a new resource to be created.

Name string

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

Notifications List<BudgetManagementGroupNotificationArgs>

One or more notification blocks as defined below.

TimeGrain string

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.

TimePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

Amount float64

The total amount of cost to track with the budget.

Etag string

(Optional) The ETag of the Management Group Consumption Budget.

Filter BudgetManagementGroupFilterArgs

A filter block as defined below.

ManagementGroupId string

The ID of the Management Group. Changing this forces a new resource to be created.

Name string

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

Notifications []BudgetManagementGroupNotificationArgs

One or more notification blocks as defined below.

TimeGrain string

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.

TimePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

amount Double

The total amount of cost to track with the budget.

etag String

(Optional) The ETag of the Management Group Consumption Budget.

filter BudgetManagementGroupFilterArgs

A filter block as defined below.

managementGroupId String

The ID of the Management Group. Changing this forces a new resource to be created.

name String

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

notifications List<BudgetManagementGroupNotificationArgs>

One or more notification blocks as defined below.

timeGrain String

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.

timePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

amount number

The total amount of cost to track with the budget.

etag string

(Optional) The ETag of the Management Group Consumption Budget.

filter BudgetManagementGroupFilterArgs

A filter block as defined below.

managementGroupId string

The ID of the Management Group. Changing this forces a new resource to be created.

name string

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

notifications BudgetManagementGroupNotificationArgs[]

One or more notification blocks as defined below.

timeGrain string

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.

timePeriod BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

amount float

The total amount of cost to track with the budget.

etag str

(Optional) The ETag of the Management Group Consumption Budget.

filter BudgetManagementGroupFilterArgs

A filter block as defined below.

management_group_id str

The ID of the Management Group. Changing this forces a new resource to be created.

name str

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

notifications Sequence[BudgetManagementGroupNotificationArgs]

One or more notification blocks as defined below.

time_grain str

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.

time_period BudgetManagementGroupTimePeriodArgs

A time_period block as defined below.

amount Number

The total amount of cost to track with the budget.

etag String

(Optional) The ETag of the Management Group Consumption Budget.

filter Property Map

A filter block as defined below.

managementGroupId String

The ID of the Management Group. Changing this forces a new resource to be created.

name String

The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.

notifications List<Property Map>

One or more notification blocks as defined below.

timeGrain String

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.

timePeriod Property Map

A time_period block as defined below.

Supporting Types

BudgetManagementGroupFilter

Dimensions List<BudgetManagementGroupFilterDimension>

One or more dimension blocks as defined below to filter the budget on.

Not BudgetManagementGroupFilterNot

A not block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Deprecated:

This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Tags List<BudgetManagementGroupFilterTag>

One or more tag blocks as defined below to filter the budget on.

Dimensions []BudgetManagementGroupFilterDimension

One or more dimension blocks as defined below to filter the budget on.

Not BudgetManagementGroupFilterNot

A not block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Deprecated:

This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Tags []BudgetManagementGroupFilterTag

One or more tag blocks as defined below to filter the budget on.

dimensions List<BudgetManagementGroupFilterDimension>

One or more dimension blocks as defined below to filter the budget on.

not BudgetManagementGroupFilterNot

A not block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Deprecated:

This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

tags List<BudgetManagementGroupFilterTag>

One or more tag blocks as defined below to filter the budget on.

dimensions BudgetManagementGroupFilterDimension[]

One or more dimension blocks as defined below to filter the budget on.

not BudgetManagementGroupFilterNot

A not block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Deprecated:

This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

tags BudgetManagementGroupFilterTag[]

One or more tag blocks as defined below to filter the budget on.

dimensions Sequence[BudgetManagementGroupFilterDimension]

One or more dimension blocks as defined below to filter the budget on.

not_ BudgetManagementGroupFilterNot

A not block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Deprecated:

This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

tags Sequence[BudgetManagementGroupFilterTag]

One or more tag blocks as defined below to filter the budget on.

dimensions List<Property Map>

One or more dimension blocks as defined below to filter the budget on.

not Property Map

A not block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

Deprecated:

This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.

tags List<Property Map>

One or more tag blocks as defined below to filter the budget on.

BudgetManagementGroupFilterDimension

Name string

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

Values List<string>

Specifies a list of values for the column.

Operator string

The operator to use for comparison. The allowed values are In.

Name string

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

Values []string

Specifies a list of values for the column.

Operator string

The operator to use for comparison. The allowed values are In.

name String

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values List<String>

Specifies a list of values for the column.

operator String

The operator to use for comparison. The allowed values are In.

name string

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values string[]

Specifies a list of values for the column.

operator string

The operator to use for comparison. The allowed values are In.

name str

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values Sequence[str]

Specifies a list of values for the column.

operator str

The operator to use for comparison. The allowed values are In.

name String

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values List<String>

Specifies a list of values for the column.

operator String

The operator to use for comparison. The allowed values are In.

BudgetManagementGroupFilterNot

Dimension BudgetManagementGroupFilterNotDimension

One dimension block as defined below to filter the budget on. Conflicts with tag.

Tag BudgetManagementGroupFilterNotTag

One tag block as defined below to filter the budget on. Conflicts with dimension.

Dimension BudgetManagementGroupFilterNotDimension

One dimension block as defined below to filter the budget on. Conflicts with tag.

Tag BudgetManagementGroupFilterNotTag

One tag block as defined below to filter the budget on. Conflicts with dimension.

dimension BudgetManagementGroupFilterNotDimension

One dimension block as defined below to filter the budget on. Conflicts with tag.

tag BudgetManagementGroupFilterNotTag

One tag block as defined below to filter the budget on. Conflicts with dimension.

dimension BudgetManagementGroupFilterNotDimension

One dimension block as defined below to filter the budget on. Conflicts with tag.

tag BudgetManagementGroupFilterNotTag

One tag block as defined below to filter the budget on. Conflicts with dimension.

dimension BudgetManagementGroupFilterNotDimension

One dimension block as defined below to filter the budget on. Conflicts with tag.

tag BudgetManagementGroupFilterNotTag

One tag block as defined below to filter the budget on. Conflicts with dimension.

dimension Property Map

One dimension block as defined below to filter the budget on. Conflicts with tag.

tag Property Map

One tag block as defined below to filter the budget on. Conflicts with dimension.

BudgetManagementGroupFilterNotDimension

Name string

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

Values List<string>

Specifies a list of values for the column.

Operator string

The operator to use for comparison. The allowed values are In.

Name string

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

Values []string

Specifies a list of values for the column.

Operator string

The operator to use for comparison. The allowed values are In.

name String

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values List<String>

Specifies a list of values for the column.

operator String

The operator to use for comparison. The allowed values are In.

name string

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values string[]

Specifies a list of values for the column.

operator string

The operator to use for comparison. The allowed values are In.

name str

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values Sequence[str]

Specifies a list of values for the column.

operator str

The operator to use for comparison. The allowed values are In.

name String

The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.

values List<String>

Specifies a list of values for the column.

operator String

The operator to use for comparison. The allowed values are In.

BudgetManagementGroupFilterNotTag

Name string

The name of the tag to use for the filter.

Values List<string>

Specifies a list of values for the tag.

Operator string

The operator to use for comparison. The allowed values are In.

Name string

The name of the tag to use for the filter.

Values []string

Specifies a list of values for the tag.

Operator string

The operator to use for comparison. The allowed values are In.

name String

The name of the tag to use for the filter.

values List<String>

Specifies a list of values for the tag.

operator String

The operator to use for comparison. The allowed values are In.

name string

The name of the tag to use for the filter.

values string[]

Specifies a list of values for the tag.

operator string

The operator to use for comparison. The allowed values are In.

name str

The name of the tag to use for the filter.

values Sequence[str]

Specifies a list of values for the tag.

operator str

The operator to use for comparison. The allowed values are In.

name String

The name of the tag to use for the filter.

values List<String>

Specifies a list of values for the tag.

operator String

The operator to use for comparison. The allowed values are In.

BudgetManagementGroupFilterTag

Name string

The name of the tag to use for the filter.

Values List<string>

Specifies a list of values for the tag.

Operator string

The operator to use for comparison. The allowed values are In.

Name string

The name of the tag to use for the filter.

Values []string

Specifies a list of values for the tag.

Operator string

The operator to use for comparison. The allowed values are In.

name String

The name of the tag to use for the filter.

values List<String>

Specifies a list of values for the tag.

operator String

The operator to use for comparison. The allowed values are In.

name string

The name of the tag to use for the filter.

values string[]

Specifies a list of values for the tag.

operator string

The operator to use for comparison. The allowed values are In.

name str

The name of the tag to use for the filter.

values Sequence[str]

Specifies a list of values for the tag.

operator str

The operator to use for comparison. The allowed values are In.

name String

The name of the tag to use for the filter.

values List<String>

Specifies a list of values for the tag.

operator String

The operator to use for comparison. The allowed values are In.

BudgetManagementGroupNotification

ContactEmails List<string>

Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

Operator string

The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.

Threshold int

Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

Enabled bool

Should the notification be enabled? Defaults to true.

ThresholdType string

The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.

ContactEmails []string

Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

Operator string

The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.

Threshold int

Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

Enabled bool

Should the notification be enabled? Defaults to true.

ThresholdType string

The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.

contactEmails List<String>

Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

operator String

The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.

threshold Integer

Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

enabled Boolean

Should the notification be enabled? Defaults to true.

thresholdType String

The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.

contactEmails string[]

Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

operator string

The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.

threshold number

Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

enabled boolean

Should the notification be enabled? Defaults to true.

thresholdType string

The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.

contact_emails Sequence[str]

Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

operator str

The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.

threshold int

Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

enabled bool

Should the notification be enabled? Defaults to true.

threshold_type str

The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.

contactEmails List<String>

Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

operator String

The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.

threshold Number

Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

enabled Boolean

Should the notification be enabled? Defaults to true.

thresholdType String

The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.

BudgetManagementGroupTimePeriod

StartDate string

The start date for 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. Changing this forces a new resource to be created.

EndDate string

The end date for the budget. If not set this will be 10 years after the start date.

StartDate string

The start date for 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. Changing this forces a new resource to be created.

EndDate string

The end date for the budget. If not set this will be 10 years after the start date.

startDate String

The start date for 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. Changing this forces a new resource to be created.

endDate String

The end date for the budget. If not set this will be 10 years after the start date.

startDate string

The start date for 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. Changing this forces a new resource to be created.

endDate string

The end date for the budget. If not set this will be 10 years after the start date.

start_date str

The start date for 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. Changing this forces a new resource to be created.

end_date str

The end date for the budget. If not set this will be 10 years after the start date.

startDate String

The start date for 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. Changing this forces a new resource to be created.

endDate String

The end date for the budget. If not set this will be 10 years after the start date.

Import

Management Group Consumption Budgets can be imported using the resource id, e.g.

 $ pulumi import azure:consumption/budgetManagementGroup:BudgetManagementGroup example /providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/budget1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.