Azure Classic

v5.19.0 published on Friday, Sep 16, 2022 by Pulumi

getBudgetResourceGroup

Use this data source to access information about an existing Consumption Budget for a specific resource group.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Azure.Consumption.GetBudgetResourceGroup.Invoke(new()
    {
        Name = "existing",
        ResourceGroupId = azurerm_resource_group.Example.Id,
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getBudgetResourceGroupResult => getBudgetResourceGroupResult.Id),
    };
});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/consumption"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := consumption.LookupBudgetResourceGroup(ctx, &consumption.LookupBudgetResourceGroupArgs{
			Name:            "existing",
			ResourceGroupId: azurerm_resource_group.Example.Id,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.consumption.ConsumptionFunctions;
import com.pulumi.azure.consumption.inputs.GetBudgetResourceGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var example = ConsumptionFunctions.getBudgetResourceGroup(GetBudgetResourceGroupArgs.builder()
            .name("existing")
            .resourceGroupId(azurerm_resource_group.example().id())
            .build());

        ctx.export("id", example.applyValue(getBudgetResourceGroupResult -> getBudgetResourceGroupResult.id()));
    }
}
import pulumi
import pulumi_azure as azure

example = azure.consumption.get_budget_resource_group(name="existing",
    resource_group_id=azurerm_resource_group["example"]["id"])
pulumi.export("id", example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.consumption.getBudgetResourceGroup({
    name: "existing",
    resourceGroupId: azurerm_resource_group.example.id,
});
export const id = example.then(example => example.id);
variables:
  example:
    Fn::Invoke:
      Function: azure:consumption:getBudgetResourceGroup
      Arguments:
        name: existing
        resourceGroupId: ${azurerm_resource_group.example.id}
outputs:
  id: ${example.id}

Using getBudgetResourceGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBudgetResourceGroup(args: GetBudgetResourceGroupArgs, opts?: InvokeOptions): Promise<GetBudgetResourceGroupResult>
function getBudgetResourceGroupOutput(args: GetBudgetResourceGroupOutputArgs, opts?: InvokeOptions): Output<GetBudgetResourceGroupResult>
def get_budget_resource_group(name: Optional[str] = None,
                              resource_group_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBudgetResourceGroupResult
def get_budget_resource_group_output(name: Optional[pulumi.Input[str]] = None,
                              resource_group_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBudgetResourceGroupResult]
func LookupBudgetResourceGroup(ctx *Context, args *LookupBudgetResourceGroupArgs, opts ...InvokeOption) (*LookupBudgetResourceGroupResult, error)
func LookupBudgetResourceGroupOutput(ctx *Context, args *LookupBudgetResourceGroupOutputArgs, opts ...InvokeOption) LookupBudgetResourceGroupResultOutput

> Note: This function is named LookupBudgetResourceGroup in the Go SDK.

public static class GetBudgetResourceGroup 
{
    public static Task<GetBudgetResourceGroupResult> InvokeAsync(GetBudgetResourceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetBudgetResourceGroupResult> Invoke(GetBudgetResourceGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBudgetResourceGroupResult> getBudgetResourceGroup(GetBudgetResourceGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure:consumption/getBudgetResourceGroup:getBudgetResourceGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The name of this Consumption Budget.

ResourceGroupId string

The ID of the subscription.

Name string

The name of this Consumption Budget.

ResourceGroupId string

The ID of the subscription.

name String

The name of this Consumption Budget.

resourceGroupId String

The ID of the subscription.

name string

The name of this Consumption Budget.

resourceGroupId string

The ID of the subscription.

name str

The name of this Consumption Budget.

resource_group_id str

The ID of the subscription.

name String

The name of this Consumption Budget.

resourceGroupId String

The ID of the subscription.

getBudgetResourceGroup Result

The following output properties are available:

Amount double

The total amount of cost to track with the budget.

Filters List<GetBudgetResourceGroupFilter>

A filter block as defined below.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the tag used for the filter.

Notifications List<GetBudgetResourceGroupNotification>

A notification block as defined below.

ResourceGroupId string
TimeGrain string

The time covered by a budget.

TimePeriods List<GetBudgetResourceGroupTimePeriod>

A time_period block as defined below.

Amount float64

The total amount of cost to track with the budget.

Filters []GetBudgetResourceGroupFilter

A filter block as defined below.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the tag used for the filter.

Notifications []GetBudgetResourceGroupNotification

A notification block as defined below.

ResourceGroupId string
TimeGrain string

The time covered by a budget.

TimePeriods []GetBudgetResourceGroupTimePeriod

A time_period block as defined below.

amount Double

The total amount of cost to track with the budget.

filters List<GetBudgetResourceGroupFilter>

A filter block as defined below.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the tag used for the filter.

notifications List<GetBudgetResourceGroupNotification>

A notification block as defined below.

resourceGroupId String
timeGrain String

The time covered by a budget.

timePeriods List<GetBudgetResourceGroupTimePeriod>

A time_period block as defined below.

amount number

The total amount of cost to track with the budget.

filters GetBudgetResourceGroupFilter[]

A filter block as defined below.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the tag used for the filter.

notifications GetBudgetResourceGroupNotification[]

A notification block as defined below.

resourceGroupId string
timeGrain string

The time covered by a budget.

timePeriods GetBudgetResourceGroupTimePeriod[]

A time_period block as defined below.

amount float

The total amount of cost to track with the budget.

filters Sequence[GetBudgetResourceGroupFilter]

A filter block as defined below.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the tag used for the filter.

notifications Sequence[GetBudgetResourceGroupNotification]

A notification block as defined below.

resource_group_id str
time_grain str

The time covered by a budget.

time_periods Sequence[GetBudgetResourceGroupTimePeriod]

A time_period block as defined below.

amount Number

The total amount of cost to track with the budget.

filters List<Property Map>

A filter block as defined below.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the tag used for the filter.

notifications List<Property Map>

A notification block as defined below.

resourceGroupId String
timeGrain String

The time covered by a budget.

timePeriods List<Property Map>

A time_period block as defined below.

Supporting Types

GetBudgetResourceGroupFilter

Dimensions List<GetBudgetResourceGroupFilterDimension>

A dimension block as defined below.

Nots List<GetBudgetResourceGroupFilterNot>

A not block as defined below.

Tags List<GetBudgetResourceGroupFilterTag>

A tag block as defined below.

Dimensions []GetBudgetResourceGroupFilterDimension

A dimension block as defined below.

Nots []GetBudgetResourceGroupFilterNot

A not block as defined below.

Tags []GetBudgetResourceGroupFilterTag

A tag block as defined below.

dimensions List<GetBudgetResourceGroupFilterDimension>

A dimension block as defined below.

nots List<GetBudgetResourceGroupFilterNot>

A not block as defined below.

tags List<GetBudgetResourceGroupFilterTag>

A tag block as defined below.

dimensions GetBudgetResourceGroupFilterDimension[]

A dimension block as defined below.

nots GetBudgetResourceGroupFilterNot[]

A not block as defined below.

tags GetBudgetResourceGroupFilterTag[]

A tag block as defined below.

dimensions List<Property Map>

A dimension block as defined below.

nots List<Property Map>

A not block as defined below.

tags List<Property Map>

A tag block as defined below.

GetBudgetResourceGroupFilterDimension

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values List<string>

A list of values for the tag.

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values []string

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

name string

The name of this Consumption Budget.

operator string

The operator used for comparison.

values string[]

A list of values for the tag.

name str

The name of this Consumption Budget.

operator str

The operator used for comparison.

values Sequence[str]

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

GetBudgetResourceGroupFilterNot

Dimensions []GetBudgetResourceGroupFilterNotDimension

A dimension block as defined below.

Tags []GetBudgetResourceGroupFilterNotTag

A tag block as defined below.

dimensions GetBudgetResourceGroupFilterNotDimension[]

A dimension block as defined below.

tags GetBudgetResourceGroupFilterNotTag[]

A tag block as defined below.

dimensions List<Property Map>

A dimension block as defined below.

tags List<Property Map>

A tag block as defined below.

GetBudgetResourceGroupFilterNotDimension

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values List<string>

A list of values for the tag.

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values []string

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

name string

The name of this Consumption Budget.

operator string

The operator used for comparison.

values string[]

A list of values for the tag.

name str

The name of this Consumption Budget.

operator str

The operator used for comparison.

values Sequence[str]

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

GetBudgetResourceGroupFilterNotTag

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values List<string>

A list of values for the tag.

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values []string

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

name string

The name of this Consumption Budget.

operator string

The operator used for comparison.

values string[]

A list of values for the tag.

name str

The name of this Consumption Budget.

operator str

The operator used for comparison.

values Sequence[str]

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

GetBudgetResourceGroupFilterTag

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values List<string>

A list of values for the tag.

Name string

The name of this Consumption Budget.

Operator string

The operator used for comparison.

Values []string

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

name string

The name of this Consumption Budget.

operator string

The operator used for comparison.

values string[]

A list of values for the tag.

name str

The name of this Consumption Budget.

operator str

The operator used for comparison.

values Sequence[str]

A list of values for the tag.

name String

The name of this Consumption Budget.

operator String

The operator used for comparison.

values List<String>

A list of values for the tag.

GetBudgetResourceGroupNotification

ContactEmails List<string>

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

ContactGroups List<string>

A list of Action Group IDs to send the budget notification to when the threshold is exceeded.

ContactRoles List<string>

A list of contact roles to send the budget notification to when the threshold is exceeded.

Enabled bool

Whether the notification is enabled.

Operator string

The operator used for comparison.

Threshold int

Threshold value associated with the notification.

ThresholdType string
ContactEmails []string

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

ContactGroups []string

A list of Action Group IDs to send the budget notification to when the threshold is exceeded.

ContactRoles []string

A list of contact roles to send the budget notification to when the threshold is exceeded.

Enabled bool

Whether the notification is enabled.

Operator string

The operator used for comparison.

Threshold int

Threshold value associated with the notification.

ThresholdType string
contactEmails List<String>

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

contactGroups List<String>

A list of Action Group IDs to send the budget notification to when the threshold is exceeded.

contactRoles List<String>

A list of contact roles to send the budget notification to when the threshold is exceeded.

enabled Boolean

Whether the notification is enabled.

operator String

The operator used for comparison.

threshold Integer

Threshold value associated with the notification.

thresholdType String
contactEmails string[]

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

contactGroups string[]

A list of Action Group IDs to send the budget notification to when the threshold is exceeded.

contactRoles string[]

A list of contact roles to send the budget notification to when the threshold is exceeded.

enabled boolean

Whether the notification is enabled.

operator string

The operator used for comparison.

threshold number

Threshold value associated with the notification.

thresholdType string
contact_emails Sequence[str]

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

contact_groups Sequence[str]

A list of Action Group IDs to send the budget notification to when the threshold is exceeded.

contact_roles Sequence[str]

A list of contact roles to send the budget notification to when the threshold is exceeded.

enabled bool

Whether the notification is enabled.

operator str

The operator used for comparison.

threshold int

Threshold value associated with the notification.

threshold_type str
contactEmails List<String>

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

contactGroups List<String>

A list of Action Group IDs to send the budget notification to when the threshold is exceeded.

contactRoles List<String>

A list of contact roles to send the budget notification to when the threshold is exceeded.

enabled Boolean

Whether the notification is enabled.

operator String

The operator used for comparison.

threshold Number

Threshold value associated with the notification.

thresholdType String

GetBudgetResourceGroupTimePeriod

EndDate string

The end date for the budget.

StartDate string

The start date for the budget.

EndDate string

The end date for the budget.

StartDate string

The start date for the budget.

endDate String

The end date for the budget.

startDate String

The start date for the budget.

endDate string

The end date for the budget.

startDate string

The start date for the budget.

end_date str

The end date for the budget.

start_date str

The start date for the budget.

endDate String

The end date for the budget.

startDate String

The start date for the budget.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.