getBudgets

This data source provides the list of Budgets in Oracle Cloud Infrastructure Budget service.

Gets a list of budgets in a compartment.

By default, ListBudgets returns budgets of the ‘COMPARTMENT’ target type, and the budget records with only one target compartment OCID.

To list all budgets, set the targetType query parameter to ALL (for example: ’targetType=ALL’).

Additional targetTypes would be available in future releases. Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testBudgets = Oci.Budget.GetBudgets.Invoke(new()
    {
        CompartmentId = @var.Tenancy_ocid,
        DisplayName = @var.Budget_display_name,
        State = @var.Budget_state,
        TargetType = @var.Budget_target_type,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Budget"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Budget.GetBudgets(ctx, &budget.GetBudgetsArgs{
			CompartmentId: _var.Tenancy_ocid,
			DisplayName:   pulumi.StringRef(_var.Budget_display_name),
			State:         pulumi.StringRef(_var.Budget_state),
			TargetType:    pulumi.StringRef(_var.Budget_target_type),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Budget.BudgetFunctions;
import com.pulumi.oci.Budget.inputs.GetBudgetsArgs;
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 testBudgets = BudgetFunctions.getBudgets(GetBudgetsArgs.builder()
            .compartmentId(var_.tenancy_ocid())
            .displayName(var_.budget_display_name())
            .state(var_.budget_state())
            .targetType(var_.budget_target_type())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_budgets = oci.Budget.get_budgets(compartment_id=var["tenancy_ocid"],
    display_name=var["budget_display_name"],
    state=var["budget_state"],
    target_type=var["budget_target_type"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testBudgets = oci.Budget.getBudgets({
    compartmentId: _var.tenancy_ocid,
    displayName: _var.budget_display_name,
    state: _var.budget_state,
    targetType: _var.budget_target_type,
});
variables:
  testBudgets:
    Fn::Invoke:
      Function: oci:Budget:getBudgets
      Arguments:
        compartmentId: ${var.tenancy_ocid}
        displayName: ${var.budget_display_name}
        state: ${var.budget_state}
        targetType: ${var.budget_target_type}

Using getBudgets

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 getBudgets(args: GetBudgetsArgs, opts?: InvokeOptions): Promise<GetBudgetsResult>
function getBudgetsOutput(args: GetBudgetsOutputArgs, opts?: InvokeOptions): Output<GetBudgetsResult>
def get_budgets(compartment_id: Optional[str] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_budget.GetBudgetsFilter]] = None,
                state: Optional[str] = None,
                target_type: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBudgetsResult
def get_budgets_output(compartment_id: Optional[pulumi.Input[str]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_budget.GetBudgetsFilterArgs]]]] = None,
                state: Optional[pulumi.Input[str]] = None,
                target_type: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBudgetsResult]
func GetBudgets(ctx *Context, args *GetBudgetsArgs, opts ...InvokeOption) (*GetBudgetsResult, error)
func GetBudgetsOutput(ctx *Context, args *GetBudgetsOutputArgs, opts ...InvokeOption) GetBudgetsResultOutput

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

public static class GetBudgets 
{
    public static Task<GetBudgetsResult> InvokeAsync(GetBudgetsArgs args, InvokeOptions? opts = null)
    public static Output<GetBudgetsResult> Invoke(GetBudgetsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBudgetsResult> getBudgets(GetBudgetsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Budget/getBudgets:getBudgets
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

The ID of the compartment in which to list resources.

DisplayName string

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

Filters List<GetBudgetsFilter>
State string

The current state of the resource to filter by.

TargetType string

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
CompartmentId string

The ID of the compartment in which to list resources.

DisplayName string

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

Filters []GetBudgetsFilter
State string

The current state of the resource to filter by.

TargetType string

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
compartmentId String

The ID of the compartment in which to list resources.

displayName String

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

filters List<GetsFilter>
state String

The current state of the resource to filter by.

targetType String

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
compartmentId string

The ID of the compartment in which to list resources.

displayName string

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

filters GetBudgetsFilter[]
state string

The current state of the resource to filter by.

targetType string

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
compartment_id str

The ID of the compartment in which to list resources.

display_name str

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

filters GetBudgetsFilter]
state str

The current state of the resource to filter by.

target_type str

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
compartmentId String

The ID of the compartment in which to list resources.

displayName String

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

filters List<Property Map>
state String

The current state of the resource to filter by.

targetType String

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"

getBudgets Result

The following output properties are available:

Budgets List<GetBudgetsBudget>

The list of budgets.

CompartmentId string

The OCID of the compartment.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The display name of the budget. Avoid entering confidential information.

Filters List<GetBudgetsFilter>
State string

The current state of the budget.

TargetType string

The type of target on which the budget is applied.

Budgets []GetBudgetsBudget

The list of budgets.

CompartmentId string

The OCID of the compartment.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The display name of the budget. Avoid entering confidential information.

Filters []GetBudgetsFilter
State string

The current state of the budget.

TargetType string

The type of target on which the budget is applied.

budgets List<Gets>

The list of budgets.

compartmentId String

The OCID of the compartment.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The display name of the budget. Avoid entering confidential information.

filters List<GetsFilter>
state String

The current state of the budget.

targetType String

The type of target on which the budget is applied.

budgets GetBudgetsBudget[]

The list of budgets.

compartmentId string

The OCID of the compartment.

id string

The provider-assigned unique ID for this managed resource.

displayName string

The display name of the budget. Avoid entering confidential information.

filters GetBudgetsFilter[]
state string

The current state of the budget.

targetType string

The type of target on which the budget is applied.

budgets GetBudgetsBudget]

The list of budgets.

compartment_id str

The OCID of the compartment.

id str

The provider-assigned unique ID for this managed resource.

display_name str

The display name of the budget. Avoid entering confidential information.

filters GetBudgetsFilter]
state str

The current state of the budget.

target_type str

The type of target on which the budget is applied.

budgets List<Property Map>

The list of budgets.

compartmentId String

The OCID of the compartment.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The display name of the budget. Avoid entering confidential information.

filters List<Property Map>
state String

The current state of the budget.

targetType String

The type of target on which the budget is applied.

Supporting Types

GetBudgetsBudget

ActualSpend double

The actual spend in currency for the current budget cycle.

AlertRuleCount int

The total number of alert rules in the budget.

Amount int

The amount of the budget, expressed in the currency of the customer's rate card.

BudgetProcessingPeriodStartOffset int

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

CompartmentId string

The ID of the compartment in which to list resources.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

The description of the budget.

DisplayName string

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

ForecastedSpend double

The forecasted spend in currency by the end of the current budget cycle.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the budget.

ProcessingPeriodType string

The type of the budget processing period. Valid values are INVOICE and MONTH.

ResetPeriod string

The reset period for the budget.

State string

The current state of the resource to filter by.

TargetCompartmentId string

This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

TargetType string

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
Targets List<string>

The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

TimeCreated string

The time that the budget was created.

TimeSpendComputed string

The time that the budget spend was last computed.

TimeUpdated string

The time that the budget was updated.

Version int

The version of the budget. Starts from 1 and increments by 1.

ActualSpend float64

The actual spend in currency for the current budget cycle.

AlertRuleCount int

The total number of alert rules in the budget.

Amount int

The amount of the budget, expressed in the currency of the customer's rate card.

BudgetProcessingPeriodStartOffset int

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

CompartmentId string

The ID of the compartment in which to list resources.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

The description of the budget.

DisplayName string

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

ForecastedSpend float64

The forecasted spend in currency by the end of the current budget cycle.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the budget.

ProcessingPeriodType string

The type of the budget processing period. Valid values are INVOICE and MONTH.

ResetPeriod string

The reset period for the budget.

State string

The current state of the resource to filter by.

TargetCompartmentId string

This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

TargetType string

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
Targets []string

The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

TimeCreated string

The time that the budget was created.

TimeSpendComputed string

The time that the budget spend was last computed.

TimeUpdated string

The time that the budget was updated.

Version int

The version of the budget. Starts from 1 and increments by 1.

actualSpend Double

The actual spend in currency for the current budget cycle.

alertRuleCount Integer

The total number of alert rules in the budget.

amount Integer

The amount of the budget, expressed in the currency of the customer's rate card.

budgetProcessingPeriodStartOffset Integer

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartmentId String

The ID of the compartment in which to list resources.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

The description of the budget.

displayName String

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

forecastedSpend Double

The forecasted spend in currency by the end of the current budget cycle.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the budget.

processingPeriodType String

The type of the budget processing period. Valid values are INVOICE and MONTH.

resetPeriod String

The reset period for the budget.

state String

The current state of the resource to filter by.

targetCompartmentId String

This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType String

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
targets List<String>

The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

timeCreated String

The time that the budget was created.

timeSpendComputed String

The time that the budget spend was last computed.

timeUpdated String

The time that the budget was updated.

version Integer

The version of the budget. Starts from 1 and increments by 1.

actualSpend number

The actual spend in currency for the current budget cycle.

alertRuleCount number

The total number of alert rules in the budget.

amount number

The amount of the budget, expressed in the currency of the customer's rate card.

budgetProcessingPeriodStartOffset number

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartmentId string

The ID of the compartment in which to list resources.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description string

The description of the budget.

displayName string

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

forecastedSpend number

The forecasted spend in currency by the end of the current budget cycle.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of the budget.

processingPeriodType string

The type of the budget processing period. Valid values are INVOICE and MONTH.

resetPeriod string

The reset period for the budget.

state string

The current state of the resource to filter by.

targetCompartmentId string

This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType string

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
targets string[]

The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

timeCreated string

The time that the budget was created.

timeSpendComputed string

The time that the budget spend was last computed.

timeUpdated string

The time that the budget was updated.

version number

The version of the budget. Starts from 1 and increments by 1.

actual_spend float

The actual spend in currency for the current budget cycle.

alert_rule_count int

The total number of alert rules in the budget.

amount int

The amount of the budget, expressed in the currency of the customer's rate card.

budget_processing_period_start_offset int

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartment_id str

The ID of the compartment in which to list resources.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description str

The description of the budget.

display_name str

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

forecasted_spend float

The forecasted spend in currency by the end of the current budget cycle.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of the budget.

processing_period_type str

The type of the budget processing period. Valid values are INVOICE and MONTH.

reset_period str

The reset period for the budget.

state str

The current state of the resource to filter by.

target_compartment_id str

This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

target_type str

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
targets Sequence[str]

The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

time_created str

The time that the budget was created.

time_spend_computed str

The time that the budget spend was last computed.

time_updated str

The time that the budget was updated.

version int

The version of the budget. Starts from 1 and increments by 1.

actualSpend Number

The actual spend in currency for the current budget cycle.

alertRuleCount Number

The total number of alert rules in the budget.

amount Number

The amount of the budget, expressed in the currency of the customer's rate card.

budgetProcessingPeriodStartOffset Number

The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

compartmentId String

The ID of the compartment in which to list resources.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

The description of the budget.

displayName String

A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource

forecastedSpend Number

The forecasted spend in currency by the end of the current budget cycle.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the budget.

processingPeriodType String

The type of the budget processing period. Valid values are INVOICE and MONTH.

resetPeriod String

The reset period for the budget.

state String

The current state of the resource to filter by.

targetCompartmentId String

This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Deprecated:

The 'target_compartment_id' field has been deprecated. Please use 'target_type' instead.

targetType String

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"
targets List<String>

The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".

timeCreated String

The time that the budget was created.

timeSpendComputed String

The time that the budget spend was last computed.

timeUpdated String

The time that the budget was updated.

version Number

The version of the budget. Starts from 1 and increments by 1.

GetBudgetsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

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

This Pulumi package is based on the oci Terraform Provider.