We recommend using Azure Native.
azure.consumption.BudgetResourceGroup
Explore with Pulumi AI
Manages a Resource Group Consumption Budget.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example",
location: "eastus",
});
const exampleActionGroup = new azure.monitoring.ActionGroup("example", {
name: "example",
resourceGroupName: example.name,
shortName: "example",
});
const exampleBudgetResourceGroup = new azure.consumption.BudgetResourceGroup("example", {
name: "example",
resourceGroupId: example.id,
amount: 1000,
timeGrain: "Monthly",
timePeriod: {
startDate: "2022-06-01T00:00:00Z",
endDate: "2022-07-01T00:00:00Z",
},
filter: {
dimensions: [{
name: "ResourceId",
values: [exampleActionGroup.id],
}],
tags: [{
name: "foo",
values: [
"bar",
"baz",
],
}],
},
notifications: [
{
enabled: true,
threshold: 90,
operator: "EqualTo",
thresholdType: "Forecasted",
contactEmails: [
"foo@example.com",
"bar@example.com",
],
contactGroups: [exampleActionGroup.id],
contactRoles: ["Owner"],
},
{
enabled: false,
threshold: 100,
operator: "GreaterThan",
contactEmails: [
"foo@example.com",
"bar@example.com",
],
},
],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example",
location="eastus")
example_action_group = azure.monitoring.ActionGroup("example",
name="example",
resource_group_name=example.name,
short_name="example")
example_budget_resource_group = azure.consumption.BudgetResourceGroup("example",
name="example",
resource_group_id=example.id,
amount=1000,
time_grain="Monthly",
time_period={
"start_date": "2022-06-01T00:00:00Z",
"end_date": "2022-07-01T00:00:00Z",
},
filter={
"dimensions": [{
"name": "ResourceId",
"values": [example_action_group.id],
}],
"tags": [{
"name": "foo",
"values": [
"bar",
"baz",
],
}],
},
notifications=[
{
"enabled": True,
"threshold": 90,
"operator": "EqualTo",
"threshold_type": "Forecasted",
"contact_emails": [
"foo@example.com",
"bar@example.com",
],
"contact_groups": [example_action_group.id],
"contact_roles": ["Owner"],
},
{
"enabled": False,
"threshold": 100,
"operator": "GreaterThan",
"contact_emails": [
"foo@example.com",
"bar@example.com",
],
},
])
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/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example"),
Location: pulumi.String("eastus"),
})
if err != nil {
return err
}
exampleActionGroup, err := monitoring.NewActionGroup(ctx, "example", &monitoring.ActionGroupArgs{
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
ShortName: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = consumption.NewBudgetResourceGroup(ctx, "example", &consumption.BudgetResourceGroupArgs{
Name: pulumi.String("example"),
ResourceGroupId: example.ID(),
Amount: pulumi.Float64(1000),
TimeGrain: pulumi.String("Monthly"),
TimePeriod: &consumption.BudgetResourceGroupTimePeriodArgs{
StartDate: pulumi.String("2022-06-01T00:00:00Z"),
EndDate: pulumi.String("2022-07-01T00:00:00Z"),
},
Filter: &consumption.BudgetResourceGroupFilterArgs{
Dimensions: consumption.BudgetResourceGroupFilterDimensionArray{
&consumption.BudgetResourceGroupFilterDimensionArgs{
Name: pulumi.String("ResourceId"),
Values: pulumi.StringArray{
exampleActionGroup.ID(),
},
},
},
Tags: consumption.BudgetResourceGroupFilterTagArray{
&consumption.BudgetResourceGroupFilterTagArgs{
Name: pulumi.String("foo"),
Values: pulumi.StringArray{
pulumi.String("bar"),
pulumi.String("baz"),
},
},
},
},
Notifications: consumption.BudgetResourceGroupNotificationArray{
&consumption.BudgetResourceGroupNotificationArgs{
Enabled: pulumi.Bool(true),
Threshold: pulumi.Int(90),
Operator: pulumi.String("EqualTo"),
ThresholdType: pulumi.String("Forecasted"),
ContactEmails: pulumi.StringArray{
pulumi.String("foo@example.com"),
pulumi.String("bar@example.com"),
},
ContactGroups: pulumi.StringArray{
exampleActionGroup.ID(),
},
ContactRoles: pulumi.StringArray{
pulumi.String("Owner"),
},
},
&consumption.BudgetResourceGroupNotificationArgs{
Enabled: pulumi.Bool(false),
Threshold: pulumi.Int(100),
Operator: pulumi.String("GreaterThan"),
ContactEmails: pulumi.StringArray{
pulumi.String("foo@example.com"),
pulumi.String("bar@example.com"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example",
Location = "eastus",
});
var exampleActionGroup = new Azure.Monitoring.ActionGroup("example", new()
{
Name = "example",
ResourceGroupName = example.Name,
ShortName = "example",
});
var exampleBudgetResourceGroup = new Azure.Consumption.BudgetResourceGroup("example", new()
{
Name = "example",
ResourceGroupId = example.Id,
Amount = 1000,
TimeGrain = "Monthly",
TimePeriod = new Azure.Consumption.Inputs.BudgetResourceGroupTimePeriodArgs
{
StartDate = "2022-06-01T00:00:00Z",
EndDate = "2022-07-01T00:00:00Z",
},
Filter = new Azure.Consumption.Inputs.BudgetResourceGroupFilterArgs
{
Dimensions = new[]
{
new Azure.Consumption.Inputs.BudgetResourceGroupFilterDimensionArgs
{
Name = "ResourceId",
Values = new[]
{
exampleActionGroup.Id,
},
},
},
Tags = new[]
{
new Azure.Consumption.Inputs.BudgetResourceGroupFilterTagArgs
{
Name = "foo",
Values = new[]
{
"bar",
"baz",
},
},
},
},
Notifications = new[]
{
new Azure.Consumption.Inputs.BudgetResourceGroupNotificationArgs
{
Enabled = true,
Threshold = 90,
Operator = "EqualTo",
ThresholdType = "Forecasted",
ContactEmails = new[]
{
"foo@example.com",
"bar@example.com",
},
ContactGroups = new[]
{
exampleActionGroup.Id,
},
ContactRoles = new[]
{
"Owner",
},
},
new Azure.Consumption.Inputs.BudgetResourceGroupNotificationArgs
{
Enabled = false,
Threshold = 100,
Operator = "GreaterThan",
ContactEmails = new[]
{
"foo@example.com",
"bar@example.com",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.monitoring.ActionGroup;
import com.pulumi.azure.monitoring.ActionGroupArgs;
import com.pulumi.azure.consumption.BudgetResourceGroup;
import com.pulumi.azure.consumption.BudgetResourceGroupArgs;
import com.pulumi.azure.consumption.inputs.BudgetResourceGroupTimePeriodArgs;
import com.pulumi.azure.consumption.inputs.BudgetResourceGroupFilterArgs;
import com.pulumi.azure.consumption.inputs.BudgetResourceGroupNotificationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example")
.location("eastus")
.build());
var exampleActionGroup = new ActionGroup("exampleActionGroup", ActionGroupArgs.builder()
.name("example")
.resourceGroupName(example.name())
.shortName("example")
.build());
var exampleBudgetResourceGroup = new BudgetResourceGroup("exampleBudgetResourceGroup", BudgetResourceGroupArgs.builder()
.name("example")
.resourceGroupId(example.id())
.amount(1000)
.timeGrain("Monthly")
.timePeriod(BudgetResourceGroupTimePeriodArgs.builder()
.startDate("2022-06-01T00:00:00Z")
.endDate("2022-07-01T00:00:00Z")
.build())
.filter(BudgetResourceGroupFilterArgs.builder()
.dimensions(BudgetResourceGroupFilterDimensionArgs.builder()
.name("ResourceId")
.values(exampleActionGroup.id())
.build())
.tags(BudgetResourceGroupFilterTagArgs.builder()
.name("foo")
.values(
"bar",
"baz")
.build())
.build())
.notifications(
BudgetResourceGroupNotificationArgs.builder()
.enabled(true)
.threshold(90)
.operator("EqualTo")
.thresholdType("Forecasted")
.contactEmails(
"foo@example.com",
"bar@example.com")
.contactGroups(exampleActionGroup.id())
.contactRoles("Owner")
.build(),
BudgetResourceGroupNotificationArgs.builder()
.enabled(false)
.threshold(100)
.operator("GreaterThan")
.contactEmails(
"foo@example.com",
"bar@example.com")
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example
location: eastus
exampleActionGroup:
type: azure:monitoring:ActionGroup
name: example
properties:
name: example
resourceGroupName: ${example.name}
shortName: example
exampleBudgetResourceGroup:
type: azure:consumption:BudgetResourceGroup
name: example
properties:
name: example
resourceGroupId: ${example.id}
amount: 1000
timeGrain: Monthly
timePeriod:
startDate: 2022-06-01T00:00:00Z
endDate: 2022-07-01T00:00:00Z
filter:
dimensions:
- name: ResourceId
values:
- ${exampleActionGroup.id}
tags:
- name: foo
values:
- bar
- baz
notifications:
- enabled: true
threshold: 90
operator: EqualTo
thresholdType: Forecasted
contactEmails:
- foo@example.com
- bar@example.com
contactGroups:
- ${exampleActionGroup.id}
contactRoles:
- Owner
- enabled: false
threshold: 100
operator: GreaterThan
contactEmails:
- foo@example.com
- bar@example.com
Create BudgetResourceGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BudgetResourceGroup(name: string, args: BudgetResourceGroupArgs, opts?: CustomResourceOptions);
@overload
def BudgetResourceGroup(resource_name: str,
args: BudgetResourceGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BudgetResourceGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
amount: Optional[float] = None,
notifications: Optional[Sequence[BudgetResourceGroupNotificationArgs]] = None,
resource_group_id: Optional[str] = None,
time_period: Optional[BudgetResourceGroupTimePeriodArgs] = None,
etag: Optional[str] = None,
filter: Optional[BudgetResourceGroupFilterArgs] = None,
name: Optional[str] = None,
time_grain: Optional[str] = None)
func NewBudgetResourceGroup(ctx *Context, name string, args BudgetResourceGroupArgs, opts ...ResourceOption) (*BudgetResourceGroup, error)
public BudgetResourceGroup(string name, BudgetResourceGroupArgs args, CustomResourceOptions? opts = null)
public BudgetResourceGroup(String name, BudgetResourceGroupArgs args)
public BudgetResourceGroup(String name, BudgetResourceGroupArgs args, CustomResourceOptions options)
type: azure:consumption:BudgetResourceGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BudgetResourceGroupArgs
- 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 BudgetResourceGroupArgs
- 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 BudgetResourceGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BudgetResourceGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BudgetResourceGroupArgs
- 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 budgetResourceGroupResource = new Azure.Consumption.BudgetResourceGroup("budgetResourceGroupResource", new()
{
Amount = 0,
Notifications = new[]
{
new Azure.Consumption.Inputs.BudgetResourceGroupNotificationArgs
{
Operator = "string",
Threshold = 0,
ContactEmails = new[]
{
"string",
},
ContactGroups = new[]
{
"string",
},
ContactRoles = new[]
{
"string",
},
Enabled = false,
ThresholdType = "string",
},
},
ResourceGroupId = "string",
TimePeriod = new Azure.Consumption.Inputs.BudgetResourceGroupTimePeriodArgs
{
StartDate = "string",
EndDate = "string",
},
Etag = "string",
Filter = new Azure.Consumption.Inputs.BudgetResourceGroupFilterArgs
{
Dimensions = new[]
{
new Azure.Consumption.Inputs.BudgetResourceGroupFilterDimensionArgs
{
Name = "string",
Values = new[]
{
"string",
},
Operator = "string",
},
},
Tags = new[]
{
new Azure.Consumption.Inputs.BudgetResourceGroupFilterTagArgs
{
Name = "string",
Values = new[]
{
"string",
},
Operator = "string",
},
},
},
Name = "string",
TimeGrain = "string",
});
example, err := consumption.NewBudgetResourceGroup(ctx, "budgetResourceGroupResource", &consumption.BudgetResourceGroupArgs{
Amount: pulumi.Float64(0),
Notifications: consumption.BudgetResourceGroupNotificationArray{
&consumption.BudgetResourceGroupNotificationArgs{
Operator: pulumi.String("string"),
Threshold: pulumi.Int(0),
ContactEmails: pulumi.StringArray{
pulumi.String("string"),
},
ContactGroups: pulumi.StringArray{
pulumi.String("string"),
},
ContactRoles: pulumi.StringArray{
pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
ThresholdType: pulumi.String("string"),
},
},
ResourceGroupId: pulumi.String("string"),
TimePeriod: &consumption.BudgetResourceGroupTimePeriodArgs{
StartDate: pulumi.String("string"),
EndDate: pulumi.String("string"),
},
Etag: pulumi.String("string"),
Filter: &consumption.BudgetResourceGroupFilterArgs{
Dimensions: consumption.BudgetResourceGroupFilterDimensionArray{
&consumption.BudgetResourceGroupFilterDimensionArgs{
Name: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Operator: pulumi.String("string"),
},
},
Tags: consumption.BudgetResourceGroupFilterTagArray{
&consumption.BudgetResourceGroupFilterTagArgs{
Name: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Operator: pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
TimeGrain: pulumi.String("string"),
})
var budgetResourceGroupResource = new BudgetResourceGroup("budgetResourceGroupResource", BudgetResourceGroupArgs.builder()
.amount(0)
.notifications(BudgetResourceGroupNotificationArgs.builder()
.operator("string")
.threshold(0)
.contactEmails("string")
.contactGroups("string")
.contactRoles("string")
.enabled(false)
.thresholdType("string")
.build())
.resourceGroupId("string")
.timePeriod(BudgetResourceGroupTimePeriodArgs.builder()
.startDate("string")
.endDate("string")
.build())
.etag("string")
.filter(BudgetResourceGroupFilterArgs.builder()
.dimensions(BudgetResourceGroupFilterDimensionArgs.builder()
.name("string")
.values("string")
.operator("string")
.build())
.tags(BudgetResourceGroupFilterTagArgs.builder()
.name("string")
.values("string")
.operator("string")
.build())
.build())
.name("string")
.timeGrain("string")
.build());
budget_resource_group_resource = azure.consumption.BudgetResourceGroup("budgetResourceGroupResource",
amount=0,
notifications=[{
"operator": "string",
"threshold": 0,
"contactEmails": ["string"],
"contactGroups": ["string"],
"contactRoles": ["string"],
"enabled": False,
"thresholdType": "string",
}],
resource_group_id="string",
time_period={
"startDate": "string",
"endDate": "string",
},
etag="string",
filter={
"dimensions": [{
"name": "string",
"values": ["string"],
"operator": "string",
}],
"tags": [{
"name": "string",
"values": ["string"],
"operator": "string",
}],
},
name="string",
time_grain="string")
const budgetResourceGroupResource = new azure.consumption.BudgetResourceGroup("budgetResourceGroupResource", {
amount: 0,
notifications: [{
operator: "string",
threshold: 0,
contactEmails: ["string"],
contactGroups: ["string"],
contactRoles: ["string"],
enabled: false,
thresholdType: "string",
}],
resourceGroupId: "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",
});
type: azure:consumption:BudgetResourceGroup
properties:
amount: 0
etag: string
filter:
dimensions:
- name: string
operator: string
values:
- string
tags:
- name: string
operator: string
values:
- string
name: string
notifications:
- contactEmails:
- string
contactGroups:
- string
contactRoles:
- string
enabled: false
operator: string
threshold: 0
thresholdType: string
resourceGroupId: string
timeGrain: string
timePeriod:
endDate: string
startDate: string
BudgetResourceGroup 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 BudgetResourceGroup resource accepts the following input properties:
- Amount double
- The total amount of cost to track with the budget.
- Notifications
List<Budget
Resource Group Notification> - One or more
notification
blocks as defined below. - Resource
Group stringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- Time
Period BudgetResource Group Time Period - A
time_period
block as defined below. - Etag string
- (Optional) The ETag of the Resource Group Consumption Budget
- Filter
Budget
Resource Group Filter - A
filter
block as defined below. - Name string
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- Time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created.
- Amount float64
- The total amount of cost to track with the budget.
- Notifications
[]Budget
Resource Group Notification Args - One or more
notification
blocks as defined below. - Resource
Group stringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- Time
Period BudgetResource Group Time Period Args - A
time_period
block as defined below. - Etag string
- (Optional) The ETag of the Resource Group Consumption Budget
- Filter
Budget
Resource Group Filter Args - A
filter
block as defined below. - Name string
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- Time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created.
- amount Double
- The total amount of cost to track with the budget.
- notifications
List<Budget
Resource Group Notification> - One or more
notification
blocks as defined below. - resource
Group StringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Period BudgetResource Group Time Period - A
time_period
block as defined below. - etag String
- (Optional) The ETag of the Resource Group Consumption Budget
- filter
Budget
Resource Group Filter - A
filter
block as defined below. - name String
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created.
- amount number
- The total amount of cost to track with the budget.
- notifications
Budget
Resource Group Notification[] - One or more
notification
blocks as defined below. - resource
Group stringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Period BudgetResource Group Time Period - A
time_period
block as defined below. - etag string
- (Optional) The ETag of the Resource Group Consumption Budget
- filter
Budget
Resource Group Filter - A
filter
block as defined below. - name string
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created.
- amount float
- The total amount of cost to track with the budget.
- notifications
Sequence[Budget
Resource Group Notification Args] - One or more
notification
blocks as defined below. - resource_
group_ strid - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time_
period BudgetResource Group Time Period Args - A
time_period
block as defined below. - etag str
- (Optional) The ETag of the Resource Group Consumption Budget
- filter
Budget
Resource Group Filter Args - A
filter
block as defined below. - name str
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created.
- amount Number
- The total amount of cost to track with the budget.
- notifications List<Property Map>
- One or more
notification
blocks as defined below. - resource
Group StringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Period Property Map - A
time_period
block as defined below. - etag String
- (Optional) The ETag of the Resource Group Consumption Budget
- filter Property Map
- A
filter
block as defined below. - name String
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the BudgetResourceGroup 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 BudgetResourceGroup Resource
Get an existing BudgetResourceGroup 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?: BudgetResourceGroupState, opts?: CustomResourceOptions): BudgetResourceGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
amount: Optional[float] = None,
etag: Optional[str] = None,
filter: Optional[BudgetResourceGroupFilterArgs] = None,
name: Optional[str] = None,
notifications: Optional[Sequence[BudgetResourceGroupNotificationArgs]] = None,
resource_group_id: Optional[str] = None,
time_grain: Optional[str] = None,
time_period: Optional[BudgetResourceGroupTimePeriodArgs] = None) -> BudgetResourceGroup
func GetBudgetResourceGroup(ctx *Context, name string, id IDInput, state *BudgetResourceGroupState, opts ...ResourceOption) (*BudgetResourceGroup, error)
public static BudgetResourceGroup Get(string name, Input<string> id, BudgetResourceGroupState? state, CustomResourceOptions? opts = null)
public static BudgetResourceGroup get(String name, Output<String> id, BudgetResourceGroupState 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.
- Amount double
- The total amount of cost to track with the budget.
- Etag string
- (Optional) The ETag of the Resource Group Consumption Budget
- Filter
Budget
Resource Group Filter - A
filter
block as defined below. - Name string
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- Notifications
List<Budget
Resource Group Notification> - One or more
notification
blocks as defined below. - Resource
Group stringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- Time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created. - Time
Period BudgetResource Group Time Period - 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 Resource Group Consumption Budget
- Filter
Budget
Resource Group Filter Args - A
filter
block as defined below. - Name string
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- Notifications
[]Budget
Resource Group Notification Args - One or more
notification
blocks as defined below. - Resource
Group stringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- Time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created. - Time
Period BudgetResource Group Time Period Args - 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 Resource Group Consumption Budget
- filter
Budget
Resource Group Filter - A
filter
block as defined below. - name String
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- notifications
List<Budget
Resource Group Notification> - One or more
notification
blocks as defined below. - resource
Group StringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created. - time
Period BudgetResource Group Time Period - 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 Resource Group Consumption Budget
- filter
Budget
Resource Group Filter - A
filter
block as defined below. - name string
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- notifications
Budget
Resource Group Notification[] - One or more
notification
blocks as defined below. - resource
Group stringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created. - time
Period BudgetResource Group Time Period - 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 Resource Group Consumption Budget
- filter
Budget
Resource Group Filter Args - A
filter
block as defined below. - name str
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- notifications
Sequence[Budget
Resource Group Notification Args] - One or more
notification
blocks as defined below. - resource_
group_ strid - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created. - time_
period BudgetResource Group Time Period Args - 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 Resource Group Consumption Budget
- filter Property Map
- A
filter
block as defined below. - name String
- The name which should be used for this Resource Group Consumption Budget. Changing this forces a new Resource Group Consumption Budget to be created.
- notifications List<Property Map>
- One or more
notification
blocks as defined below. - resource
Group StringId - The ID of the Resource Group to create the consumption budget for in the form of /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1. Changing this forces a new Resource Group Consumption Budget to be created.
- time
Grain 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
andQuarterly
. Defaults toMonthly
. Changing this forces a new resource to be created. - time
Period Property Map - A
time_period
block as defined below.
Supporting Types
BudgetResourceGroupFilter, BudgetResourceGroupFilterArgs
- Dimensions
List<Budget
Resource Group Filter Dimension> - One or more
dimension
blocks as defined below to filter the budget on. - List<Budget
Resource Group Filter Tag> - One or more
tag
blocks as defined below to filter the budget on.
- Dimensions
[]Budget
Resource Group Filter Dimension - One or more
dimension
blocks as defined below to filter the budget on. - []Budget
Resource Group Filter Tag - One or more
tag
blocks as defined below to filter the budget on.
- dimensions
List<Budget
Resource Group Filter Dimension> - One or more
dimension
blocks as defined below to filter the budget on. - List<Budget
Resource Group Filter Tag> - One or more
tag
blocks as defined below to filter the budget on.
- dimensions
Budget
Resource Group Filter Dimension[] - One or more
dimension
blocks as defined below to filter the budget on. - Budget
Resource Group Filter Tag[] - One or more
tag
blocks as defined below to filter the budget on.
- dimensions
Sequence[Budget
Resource Group Filter Dimension] - One or more
dimension
blocks as defined below to filter the budget on. - Sequence[Budget
Resource Group Filter Tag] - 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. - List<Property Map>
- One or more
tag
blocks as defined below to filter the budget on.
BudgetResourceGroupFilterDimension, BudgetResourceGroupFilterDimensionArgs
- 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
. Defaults toIn
.
- 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
. Defaults toIn
.
- 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
. Defaults toIn
.
- 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
. Defaults toIn
.
- 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
. Defaults toIn
.
- 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
. Defaults toIn
.
BudgetResourceGroupFilterTag, BudgetResourceGroupFilterTagArgs
BudgetResourceGroupNotification, BudgetResourceGroupNotificationArgs
- Operator string
- The comparison operator for the notification. Must be one of
EqualTo
,GreaterThan
, orGreaterThanOrEqualTo
. - 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.
- Contact
Emails List<string> - Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
- Contact
Groups List<string> - Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
- Contact
Roles List<string> - Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
- Enabled bool
Should the notification be enabled? Defaults to
true
.NOTE: A
notification
block cannot have all ofcontact_emails
,contact_roles
, andcontact_groups
empty. This means that at least one of the three must be specified.- Threshold
Type 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
andForecasted
. Default isActual
. Changing this forces a new resource to be created.
- Operator string
- The comparison operator for the notification. Must be one of
EqualTo
,GreaterThan
, orGreaterThanOrEqualTo
. - 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.
- Contact
Emails []string - Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
- Contact
Groups []string - Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
- Contact
Roles []string - Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
- Enabled bool
Should the notification be enabled? Defaults to
true
.NOTE: A
notification
block cannot have all ofcontact_emails
,contact_roles
, andcontact_groups
empty. This means that at least one of the three must be specified.- Threshold
Type 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
andForecasted
. Default isActual
. Changing this forces a new resource to be created.
- operator String
- The comparison operator for the notification. Must be one of
EqualTo
,GreaterThan
, orGreaterThanOrEqualTo
. - 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.
- contact
Emails List<String> - Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
- contact
Groups List<String> - Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
- contact
Roles List<String> - Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
- enabled Boolean
Should the notification be enabled? Defaults to
true
.NOTE: A
notification
block cannot have all ofcontact_emails
,contact_roles
, andcontact_groups
empty. This means that at least one of the three must be specified.- threshold
Type 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
andForecasted
. Default isActual
. Changing this forces a new resource to be created.
- operator string
- The comparison operator for the notification. Must be one of
EqualTo
,GreaterThan
, orGreaterThanOrEqualTo
. - 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.
- contact
Emails string[] - Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
- contact
Groups string[] - Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
- contact
Roles string[] - Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
- enabled boolean
Should the notification be enabled? Defaults to
true
.NOTE: A
notification
block cannot have all ofcontact_emails
,contact_roles
, andcontact_groups
empty. This means that at least one of the three must be specified.- threshold
Type 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
andForecasted
. Default isActual
. Changing this forces a new resource to be created.
- operator str
- The comparison operator for the notification. Must be one of
EqualTo
,GreaterThan
, orGreaterThanOrEqualTo
. - 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.
- contact_
emails Sequence[str] - Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
- contact_
groups Sequence[str] - Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
- contact_
roles Sequence[str] - Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
- enabled bool
Should the notification be enabled? Defaults to
true
.NOTE: A
notification
block cannot have all ofcontact_emails
,contact_roles
, andcontact_groups
empty. This means that at least one of the three must be specified.- 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
andForecasted
. Default isActual
. Changing this forces a new resource to be created.
- operator String
- The comparison operator for the notification. Must be one of
EqualTo
,GreaterThan
, orGreaterThanOrEqualTo
. - 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.
- contact
Emails List<String> - Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
- contact
Groups List<String> - Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
- contact
Roles List<String> - Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
- enabled Boolean
Should the notification be enabled? Defaults to
true
.NOTE: A
notification
block cannot have all ofcontact_emails
,contact_roles
, andcontact_groups
empty. This means that at least one of the three must be specified.- threshold
Type 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
andForecasted
. Default isActual
. Changing this forces a new resource to be created.
BudgetResourceGroupTimePeriod, BudgetResourceGroupTimePeriodArgs
- Start
Date 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 Group Consumption Budget to be created.
- End
Date string - The end date for the budget. If not set this will be 10 years after the start date.
- Start
Date 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 Group Consumption Budget to be created.
- End
Date string - The end date for the budget. If not set this will be 10 years after the start date.
- start
Date 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 Group Consumption Budget to be created.
- end
Date String - The end date for the budget. If not set this will be 10 years after the start date.
- start
Date 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 Group Consumption Budget to be created.
- end
Date 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 Group Consumption Budget to be created.
- end_
date str - The end date for the budget. If not set this will be 10 years after the start date.
- start
Date 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 Group Consumption Budget to be created.
- end
Date String - The end date for the budget. If not set this will be 10 years after the start date.
Import
Resource Group Consumption Budgets can be imported using the resource id
, e.g.
$ pulumi import azure:consumption/budgetResourceGroup:BudgetResourceGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Consumption/budgets/resourceGroup1
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.