Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. consumption
  5. BudgetManagementGroup

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.consumption.BudgetManagementGroup

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Consumption Budget for a Management Group.

Example Usage

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

const example = new azure.management.Group("example", {displayName: "example"});
const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    name: "example",
    location: "eastus",
});
const exampleBudgetManagementGroup = new azure.consumption.BudgetManagementGroup("example", {
    name: "example",
    managementGroupId: example.id,
    amount: 1000,
    timeGrain: "Monthly",
    timePeriod: {
        startDate: "2022-06-01T00:00:00Z",
        endDate: "2022-07-01T00:00:00Z",
    },
    filter: {
        dimensions: [{
            name: "ResourceGroupName",
            values: [exampleResourceGroup.name],
        }],
        tags: [{
            name: "foo",
            values: [
                "bar",
                "baz",
            ],
        }],
    },
    notifications: [
        {
            enabled: true,
            threshold: 90,
            operator: "EqualTo",
            contactEmails: [
                "foo@example.com",
                "bar@example.com",
            ],
        },
        {
            enabled: false,
            threshold: 100,
            operator: "GreaterThan",
            thresholdType: "Forecasted",
            contactEmails: [
                "foo@example.com",
                "bar@example.com",
            ],
        },
    ],
});
Copy
import pulumi
import pulumi_azure as azure

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

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/consumption"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/management"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := management.NewGroup(ctx, "example", &management.GroupArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example"),
			Location: pulumi.String("eastus"),
		})
		if err != nil {
			return err
		}
		_, err = consumption.NewBudgetManagementGroup(ctx, "example", &consumption.BudgetManagementGroupArgs{
			Name:              pulumi.String("example"),
			ManagementGroupId: example.ID(),
			Amount:            pulumi.Float64(1000),
			TimeGrain:         pulumi.String("Monthly"),
			TimePeriod: &consumption.BudgetManagementGroupTimePeriodArgs{
				StartDate: pulumi.String("2022-06-01T00:00:00Z"),
				EndDate:   pulumi.String("2022-07-01T00:00:00Z"),
			},
			Filter: &consumption.BudgetManagementGroupFilterArgs{
				Dimensions: consumption.BudgetManagementGroupFilterDimensionArray{
					&consumption.BudgetManagementGroupFilterDimensionArgs{
						Name: pulumi.String("ResourceGroupName"),
						Values: pulumi.StringArray{
							exampleResourceGroup.Name,
						},
					},
				},
				Tags: consumption.BudgetManagementGroupFilterTagArray{
					&consumption.BudgetManagementGroupFilterTagArgs{
						Name: pulumi.String("foo"),
						Values: pulumi.StringArray{
							pulumi.String("bar"),
							pulumi.String("baz"),
						},
					},
				},
			},
			Notifications: consumption.BudgetManagementGroupNotificationArray{
				&consumption.BudgetManagementGroupNotificationArgs{
					Enabled:   pulumi.Bool(true),
					Threshold: pulumi.Int(90),
					Operator:  pulumi.String("EqualTo"),
					ContactEmails: pulumi.StringArray{
						pulumi.String("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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

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

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

    var exampleBudgetManagementGroup = new Azure.Consumption.BudgetManagementGroup("example", new()
    {
        Name = "example",
        ManagementGroupId = example.Id,
        Amount = 1000,
        TimeGrain = "Monthly",
        TimePeriod = new Azure.Consumption.Inputs.BudgetManagementGroupTimePeriodArgs
        {
            StartDate = "2022-06-01T00:00:00Z",
            EndDate = "2022-07-01T00:00:00Z",
        },
        Filter = new Azure.Consumption.Inputs.BudgetManagementGroupFilterArgs
        {
            Dimensions = new[]
            {
                new Azure.Consumption.Inputs.BudgetManagementGroupFilterDimensionArgs
                {
                    Name = "ResourceGroupName",
                    Values = new[]
                    {
                        exampleResourceGroup.Name,
                    },
                },
            },
            Tags = new[]
            {
                new Azure.Consumption.Inputs.BudgetManagementGroupFilterTagArgs
                {
                    Name = "foo",
                    Values = new[]
                    {
                        "bar",
                        "baz",
                    },
                },
            },
        },
        Notifications = new[]
        {
            new Azure.Consumption.Inputs.BudgetManagementGroupNotificationArgs
            {
                Enabled = true,
                Threshold = 90,
                Operator = "EqualTo",
                ContactEmails = new[]
                {
                    "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",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.management.Group;
import com.pulumi.azure.management.GroupArgs;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.consumption.BudgetManagementGroup;
import com.pulumi.azure.consumption.BudgetManagementGroupArgs;
import com.pulumi.azure.consumption.inputs.BudgetManagementGroupTimePeriodArgs;
import com.pulumi.azure.consumption.inputs.BudgetManagementGroupFilterArgs;
import com.pulumi.azure.consumption.inputs.BudgetManagementGroupNotificationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Group("example", GroupArgs.builder()
            .displayName("example")
            .build());

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

        var exampleBudgetManagementGroup = new BudgetManagementGroup("exampleBudgetManagementGroup", BudgetManagementGroupArgs.builder()
            .name("example")
            .managementGroupId(example.id())
            .amount(1000)
            .timeGrain("Monthly")
            .timePeriod(BudgetManagementGroupTimePeriodArgs.builder()
                .startDate("2022-06-01T00:00:00Z")
                .endDate("2022-07-01T00:00:00Z")
                .build())
            .filter(BudgetManagementGroupFilterArgs.builder()
                .dimensions(BudgetManagementGroupFilterDimensionArgs.builder()
                    .name("ResourceGroupName")
                    .values(exampleResourceGroup.name())
                    .build())
                .tags(BudgetManagementGroupFilterTagArgs.builder()
                    .name("foo")
                    .values(                    
                        "bar",
                        "baz")
                    .build())
                .build())
            .notifications(            
                BudgetManagementGroupNotificationArgs.builder()
                    .enabled(true)
                    .threshold(90)
                    .operator("EqualTo")
                    .contactEmails(                    
                        "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());

    }
}
Copy
resources:
  example:
    type: azure:management:Group
    properties:
      displayName: example
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: example
      location: eastus
  exampleBudgetManagementGroup:
    type: azure:consumption:BudgetManagementGroup
    name: example
    properties:
      name: example
      managementGroupId: ${example.id}
      amount: 1000
      timeGrain: Monthly
      timePeriod:
        startDate: 2022-06-01T00:00:00Z
        endDate: 2022-07-01T00:00:00Z
      filter:
        dimensions:
          - name: ResourceGroupName
            values:
              - ${exampleResourceGroup.name}
        tags:
          - name: foo
            values:
              - bar
              - baz
      notifications:
        - enabled: true
          threshold: 90
          operator: EqualTo
          contactEmails:
            - foo@example.com
            - bar@example.com
        - enabled: false
          threshold: 100
          operator: GreaterThan
          thresholdType: Forecasted
          contactEmails:
            - foo@example.com
            - bar@example.com
Copy

Create BudgetManagementGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BudgetManagementGroup(name: string, args: BudgetManagementGroupArgs, opts?: CustomResourceOptions);
@overload
def BudgetManagementGroup(resource_name: str,
                          args: BudgetManagementGroupArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def BudgetManagementGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          amount: Optional[float] = None,
                          management_group_id: Optional[str] = None,
                          notifications: Optional[Sequence[BudgetManagementGroupNotificationArgs]] = None,
                          time_period: Optional[BudgetManagementGroupTimePeriodArgs] = None,
                          etag: Optional[str] = None,
                          filter: Optional[BudgetManagementGroupFilterArgs] = None,
                          name: Optional[str] = None,
                          time_grain: Optional[str] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BudgetManagementGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. BudgetManagementGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BudgetManagementGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BudgetManagementGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var budgetManagementGroupResource = new Azure.Consumption.BudgetManagementGroup("budgetManagementGroupResource", new()
{
    Amount = 0,
    ManagementGroupId = "string",
    Notifications = new[]
    {
        new Azure.Consumption.Inputs.BudgetManagementGroupNotificationArgs
        {
            ContactEmails = new[]
            {
                "string",
            },
            Operator = "string",
            Threshold = 0,
            Enabled = false,
            ThresholdType = "string",
        },
    },
    TimePeriod = new Azure.Consumption.Inputs.BudgetManagementGroupTimePeriodArgs
    {
        StartDate = "string",
        EndDate = "string",
    },
    Etag = "string",
    Filter = new Azure.Consumption.Inputs.BudgetManagementGroupFilterArgs
    {
        Dimensions = new[]
        {
            new Azure.Consumption.Inputs.BudgetManagementGroupFilterDimensionArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
                Operator = "string",
            },
        },
        Tags = new[]
        {
            new Azure.Consumption.Inputs.BudgetManagementGroupFilterTagArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
                Operator = "string",
            },
        },
    },
    Name = "string",
    TimeGrain = "string",
});
Copy
example, err := consumption.NewBudgetManagementGroup(ctx, "budgetManagementGroupResource", &consumption.BudgetManagementGroupArgs{
	Amount:            pulumi.Float64(0),
	ManagementGroupId: pulumi.String("string"),
	Notifications: consumption.BudgetManagementGroupNotificationArray{
		&consumption.BudgetManagementGroupNotificationArgs{
			ContactEmails: pulumi.StringArray{
				pulumi.String("string"),
			},
			Operator:      pulumi.String("string"),
			Threshold:     pulumi.Int(0),
			Enabled:       pulumi.Bool(false),
			ThresholdType: pulumi.String("string"),
		},
	},
	TimePeriod: &consumption.BudgetManagementGroupTimePeriodArgs{
		StartDate: pulumi.String("string"),
		EndDate:   pulumi.String("string"),
	},
	Etag: pulumi.String("string"),
	Filter: &consumption.BudgetManagementGroupFilterArgs{
		Dimensions: consumption.BudgetManagementGroupFilterDimensionArray{
			&consumption.BudgetManagementGroupFilterDimensionArgs{
				Name: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
				Operator: pulumi.String("string"),
			},
		},
		Tags: consumption.BudgetManagementGroupFilterTagArray{
			&consumption.BudgetManagementGroupFilterTagArgs{
				Name: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
				Operator: pulumi.String("string"),
			},
		},
	},
	Name:      pulumi.String("string"),
	TimeGrain: pulumi.String("string"),
})
Copy
var budgetManagementGroupResource = new BudgetManagementGroup("budgetManagementGroupResource", BudgetManagementGroupArgs.builder()
    .amount(0)
    .managementGroupId("string")
    .notifications(BudgetManagementGroupNotificationArgs.builder()
        .contactEmails("string")
        .operator("string")
        .threshold(0)
        .enabled(false)
        .thresholdType("string")
        .build())
    .timePeriod(BudgetManagementGroupTimePeriodArgs.builder()
        .startDate("string")
        .endDate("string")
        .build())
    .etag("string")
    .filter(BudgetManagementGroupFilterArgs.builder()
        .dimensions(BudgetManagementGroupFilterDimensionArgs.builder()
            .name("string")
            .values("string")
            .operator("string")
            .build())
        .tags(BudgetManagementGroupFilterTagArgs.builder()
            .name("string")
            .values("string")
            .operator("string")
            .build())
        .build())
    .name("string")
    .timeGrain("string")
    .build());
Copy
budget_management_group_resource = azure.consumption.BudgetManagementGroup("budgetManagementGroupResource",
    amount=0,
    management_group_id="string",
    notifications=[{
        "contact_emails": ["string"],
        "operator": "string",
        "threshold": 0,
        "enabled": False,
        "threshold_type": "string",
    }],
    time_period={
        "start_date": "string",
        "end_date": "string",
    },
    etag="string",
    filter={
        "dimensions": [{
            "name": "string",
            "values": ["string"],
            "operator": "string",
        }],
        "tags": [{
            "name": "string",
            "values": ["string"],
            "operator": "string",
        }],
    },
    name="string",
    time_grain="string")
Copy
const budgetManagementGroupResource = new azure.consumption.BudgetManagementGroup("budgetManagementGroupResource", {
    amount: 0,
    managementGroupId: "string",
    notifications: [{
        contactEmails: ["string"],
        operator: "string",
        threshold: 0,
        enabled: false,
        thresholdType: "string",
    }],
    timePeriod: {
        startDate: "string",
        endDate: "string",
    },
    etag: "string",
    filter: {
        dimensions: [{
            name: "string",
            values: ["string"],
            operator: "string",
        }],
        tags: [{
            name: "string",
            values: ["string"],
            operator: "string",
        }],
    },
    name: "string",
    timeGrain: "string",
});
Copy
type: azure:consumption:BudgetManagementGroup
properties:
    amount: 0
    etag: string
    filter:
        dimensions:
            - name: string
              operator: string
              values:
                - string
        tags:
            - name: string
              operator: string
              values:
                - string
    managementGroupId: string
    name: string
    notifications:
        - contactEmails:
            - string
          enabled: false
          operator: string
          threshold: 0
          thresholdType: string
    timeGrain: string
    timePeriod:
        endDate: string
        startDate: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BudgetManagementGroup resource accepts the following input properties:

Amount This property is required. double
The total amount of cost to track with the budget.
ManagementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Management Group. Changing this forces a new resource to be created.
Notifications This property is required. List<BudgetManagementGroupNotification>
One or more notification blocks as defined below.
TimePeriod This property is required. BudgetManagementGroupTimePeriod
A time_period block as defined below.
Etag string
(Optional) The ETag of the Management Group Consumption Budget.
Filter BudgetManagementGroupFilter
A filter block as defined below.
Name Changes to this property will trigger replacement. string
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
TimeGrain Changes to this property will trigger replacement. 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 This property is required. float64
The total amount of cost to track with the budget.
ManagementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Management Group. Changing this forces a new resource to be created.
Notifications This property is required. []BudgetManagementGroupNotificationArgs
One or more notification blocks as defined below.
TimePeriod This property is required. 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 Changes to this property will trigger replacement. string
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
TimeGrain Changes to this property will trigger replacement. 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 This property is required. Double
The total amount of cost to track with the budget.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Management Group. Changing this forces a new resource to be created.
notifications This property is required. List<BudgetManagementGroupNotification>
One or more notification blocks as defined below.
timePeriod This property is required. BudgetManagementGroupTimePeriod
A time_period block as defined below.
etag String
(Optional) The ETag of the Management Group Consumption Budget.
filter BudgetManagementGroupFilter
A filter block as defined below.
name Changes to this property will trigger replacement. String
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
timeGrain Changes to this property will trigger replacement. 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 This property is required. number
The total amount of cost to track with the budget.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Management Group. Changing this forces a new resource to be created.
notifications This property is required. BudgetManagementGroupNotification[]
One or more notification blocks as defined below.
timePeriod This property is required. BudgetManagementGroupTimePeriod
A time_period block as defined below.
etag string
(Optional) The ETag of the Management Group Consumption Budget.
filter BudgetManagementGroupFilter
A filter block as defined below.
name Changes to this property will trigger replacement. string
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
timeGrain Changes to this property will trigger replacement. 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 This property is required. float
The total amount of cost to track with the budget.
management_group_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Management Group. Changing this forces a new resource to be created.
notifications This property is required. Sequence[BudgetManagementGroupNotificationArgs]
One or more notification blocks as defined below.
time_period This property is required. 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 Changes to this property will trigger replacement. str
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
time_grain Changes to this property will trigger replacement. 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 This property is required. Number
The total amount of cost to track with the budget.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Management Group. Changing this forces a new resource to be created.
notifications This property is required. List<Property Map>
One or more notification blocks as defined below.
timePeriod This property is required. 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 Changes to this property will trigger replacement. String
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
timeGrain Changes to this property will trigger replacement. 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)
resources:  _:    type: azure:consumption:BudgetManagementGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 BudgetManagementGroupFilter
A filter block as defined below.
ManagementGroupId Changes to this property will trigger replacement. string
The ID of the Management Group. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
Notifications List<BudgetManagementGroupNotification>
One or more notification blocks as defined below.
TimeGrain Changes to this property will trigger replacement. 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 BudgetManagementGroupTimePeriod
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 Changes to this property will trigger replacement. string
The ID of the Management Group. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 BudgetManagementGroupFilter
A filter block as defined below.
managementGroupId Changes to this property will trigger replacement. String
The ID of the Management Group. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
notifications List<BudgetManagementGroupNotification>
One or more notification blocks as defined below.
timeGrain Changes to this property will trigger replacement. 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 BudgetManagementGroupTimePeriod
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 BudgetManagementGroupFilter
A filter block as defined below.
managementGroupId Changes to this property will trigger replacement. string
The ID of the Management Group. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created.
notifications BudgetManagementGroupNotification[]
One or more notification blocks as defined below.
timeGrain Changes to this property will trigger replacement. 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 BudgetManagementGroupTimePeriod
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 Changes to this property will trigger replacement. str
The ID of the Management Group. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The ID of the Management Group. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
, BudgetManagementGroupFilterArgs

Dimensions List<BudgetManagementGroupFilterDimension>
One or more dimension blocks as defined below to filter the budget on.
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.
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.
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.
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.
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.
tags List<Property Map>
One or more tag blocks as defined below to filter the budget on.

BudgetManagementGroupFilterDimension
, BudgetManagementGroupFilterDimensionArgs

Name This property is required. 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 This property is required. List<string>
Specifies a list of values for the column.
Operator string
The operator to use for comparison. The allowed values are In. Defaults to In.
Name This property is required. 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 This property is required. []string
Specifies a list of values for the column.
Operator string
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. 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 This property is required. List<String>
Specifies a list of values for the column.
operator String
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. 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 This property is required. string[]
Specifies a list of values for the column.
operator string
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. 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 This property is required. Sequence[str]
Specifies a list of values for the column.
operator str
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. 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 This property is required. List<String>
Specifies a list of values for the column.
operator String
The operator to use for comparison. The allowed values are In. Defaults to In.

BudgetManagementGroupFilterTag
, BudgetManagementGroupFilterTagArgs

Name This property is required. string
The name of the tag to use for the filter.
Values This property is required. List<string>
Specifies a list of values for the tag.
Operator string
The operator to use for comparison. The allowed values are In. Defaults to In.
Name This property is required. string
The name of the tag to use for the filter.
Values This property is required. []string
Specifies a list of values for the tag.
Operator string
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. String
The name of the tag to use for the filter.
values This property is required. List<String>
Specifies a list of values for the tag.
operator String
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. string
The name of the tag to use for the filter.
values This property is required. string[]
Specifies a list of values for the tag.
operator string
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. str
The name of the tag to use for the filter.
values This property is required. Sequence[str]
Specifies a list of values for the tag.
operator str
The operator to use for comparison. The allowed values are In. Defaults to In.
name This property is required. String
The name of the tag to use for the filter.
values This property is required. List<String>
Specifies a list of values for the tag.
operator String
The operator to use for comparison. The allowed values are In. Defaults to In.

BudgetManagementGroupNotification
, BudgetManagementGroupNotificationArgs

ContactEmails This property is required. List<string>
Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
Operator This property is required. string
The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
Threshold This property is required. 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.
ContactEmails This property is required. []string
Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
Operator This property is required. string
The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
Threshold This property is required. 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.
contactEmails This property is required. List<String>
Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
operator This property is required. String
The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
threshold This property is required. 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.
contactEmails This property is required. string[]
Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
operator This property is required. string
The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
threshold This property is required. 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.
contact_emails This property is required. Sequence[str]
Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
operator This property is required. str
The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
threshold This property is required. 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.
contactEmails This property is required. List<String>
Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
operator This property is required. String
The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
threshold This property is required. 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.

BudgetManagementGroupTimePeriod
, BudgetManagementGroupTimePeriodArgs

StartDate
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure