Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. getBudgetAlerts
Viewing docs for vantage 0.3.19
published on Thursday, Sep 10, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.getBudgetAlerts

Viewing docs for vantage 0.3.19
published on Thursday, Sep 10, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Example Usage

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

const demo = vantage.getBudgetAlerts({
    budgetToken: demoBudget.token,
});

    import pulumi
import pulumi_vantage as vantage

demo = vantage.get_budget_alerts(budget_token=demo_budget["token"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vantage/vantage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vantage.GetBudgetAlerts(ctx, &vantage.GetBudgetAlertsArgs{
			BudgetToken: pulumi.StringRef(demoBudget.Token),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var demo = Vantage.GetBudgetAlerts.Invoke(new()
    {
        BudgetToken = demoBudget.Token,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.VantageFunctions;
import com.pulumi.vantage.inputs.GetBudgetAlertsArgs;
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 demo = VantageFunctions.getBudgetAlerts(GetBudgetAlertsArgs.builder()
            .budgetToken(demoBudget.token())
            .build());

    }
}

    variables:
  demo:
    fn::invoke:
      function: vantage:getBudgetAlerts
      arguments:
        budgetToken: ${demoBudget.token}

    Example coming soon!

    Using getBudgetAlerts

    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 getBudgetAlerts(args: GetBudgetAlertsArgs, opts?: InvokeOptions): Promise<GetBudgetAlertsResult>
function getBudgetAlertsOutput(args: GetBudgetAlertsOutputArgs, opts?: InvokeOutputOptions): Output<GetBudgetAlertsResult>
    def get_budget_alerts(budget_token: Optional[str] = None,
                      workspace_token: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBudgetAlertsResult
def get_budget_alerts_output(budget_token: pulumi.Input[Optional[str]] = None,
                      workspace_token: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetBudgetAlertsResult]
    func GetBudgetAlerts(ctx *Context, args *GetBudgetAlertsArgs, opts ...InvokeOption) (*GetBudgetAlertsResult, error)
func GetBudgetAlertsOutput(ctx *Context, args *GetBudgetAlertsOutputArgs, opts ...InvokeOption) GetBudgetAlertsResultOutput

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

    public static class GetBudgetAlerts 
{
    public static Task<GetBudgetAlertsResult> InvokeAsync(GetBudgetAlertsArgs args, InvokeOptions? opts = null)
    public static Output<GetBudgetAlertsResult> Invoke(GetBudgetAlertsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBudgetAlertsResult> Invoke(GetBudgetAlertsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBudgetAlertsResult> getBudgetAlerts(GetBudgetAlertsArgs args, InvokeOptions options)
public static Output<GetBudgetAlertsResult> getBudgetAlerts(GetBudgetAlertsArgs args, InvokeOptions options)
public static Output<GetBudgetAlertsResult> getBudgetAlerts(GetBudgetAlertsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: vantage:index/getBudgetAlerts:getBudgetAlerts
  arguments:
    # arguments dictionary
    data "vantage_get_budget_alerts" "name" {
    # arguments
}

    The following arguments are supported:

    BudgetToken string
    Filter by budget token.
    WorkspaceToken string
    Filter by workspace token.
    BudgetToken string
    Filter by budget token.
    WorkspaceToken string
    Filter by workspace token.
    budget_token string
    Filter by budget token.
    workspace_token string
    Filter by workspace token.
    budgetToken String
    Filter by budget token.
    workspaceToken String
    Filter by workspace token.
    budgetToken string
    Filter by budget token.
    workspaceToken string
    Filter by workspace token.
    budget_token str
    Filter by budget token.
    workspace_token str
    Filter by workspace token.
    budgetToken String
    Filter by budget token.
    workspaceToken String
    Filter by workspace token.

    getBudgetAlerts Result

    The following output properties are available:

    BudgetAlerts List<GetBudgetAlertsBudgetAlert>
    BudgetToken string
    Filter by budget token.
    Id string
    The provider-assigned unique ID for this managed resource.
    WorkspaceToken string
    Filter by workspace token.
    BudgetAlerts []GetBudgetAlertsBudgetAlert
    BudgetToken string
    Filter by budget token.
    Id string
    The provider-assigned unique ID for this managed resource.
    WorkspaceToken string
    Filter by workspace token.
    budget_alerts list(object)
    budget_token string
    Filter by budget token.
    id string
    The provider-assigned unique ID for this managed resource.
    workspace_token string
    Filter by workspace token.
    budgetAlerts List<GetBudgetAlertsBudgetAlert>
    budgetToken String
    Filter by budget token.
    id String
    The provider-assigned unique ID for this managed resource.
    workspaceToken String
    Filter by workspace token.
    budgetAlerts GetBudgetAlertsBudgetAlert[]
    budgetToken string
    Filter by budget token.
    id string
    The provider-assigned unique ID for this managed resource.
    workspaceToken string
    Filter by workspace token.
    budget_alerts Sequence[GetBudgetAlertsBudgetAlert]
    budget_token str
    Filter by budget token.
    id str
    The provider-assigned unique ID for this managed resource.
    workspace_token str
    Filter by workspace token.
    budgetAlerts List<Property Map>
    budgetToken String
    Filter by budget token.
    id String
    The provider-assigned unique ID for this managed resource.
    workspaceToken String
    Filter by workspace token.

    Supporting Types

    GetBudgetAlertsBudgetAlert

    BudgetTokens List<string>
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    CreatedAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    DurationInDays double
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    Id string
    The id of the resource
    IntegrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    PeriodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    RecipientChannels List<string>
    The channels receiving the alerts. Requires an integration provider to be connected.
    RecipientEmails List<string>
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    Threshold double
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    Token string
    UserToken string
    The token for the User who created this BudgetAlert.
    UserTokens List<string>
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    WorkspaceToken string
    The token for the Workspace the ResourceReport is a part of.
    BudgetTokens []string
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    CreatedAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    DurationInDays float64
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    Id string
    The id of the resource
    IntegrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    PeriodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    RecipientChannels []string
    The channels receiving the alerts. Requires an integration provider to be connected.
    RecipientEmails []string
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    Threshold float64
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    Token string
    UserToken string
    The token for the User who created this BudgetAlert.
    UserTokens []string
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    WorkspaceToken string
    The token for the Workspace the ResourceReport is a part of.
    budget_tokens list(string)
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    created_at string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    duration_in_days number
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    id string
    The id of the resource
    integration_provider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    period_to_track string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    recipient_channels list(string)
    The channels receiving the alerts. Requires an integration provider to be connected.
    recipient_emails list(string)
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    threshold number
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    token string
    user_token string
    The token for the User who created this BudgetAlert.
    user_tokens list(string)
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    workspace_token string
    The token for the Workspace the ResourceReport is a part of.
    budgetTokens List<String>
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    createdAt String
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    durationInDays Double
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    id String
    The id of the resource
    integrationProvider String
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    periodToTrack String
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    recipientChannels List<String>
    The channels receiving the alerts. Requires an integration provider to be connected.
    recipientEmails List<String>
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    threshold Double
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    token String
    userToken String
    The token for the User who created this BudgetAlert.
    userTokens List<String>
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    workspaceToken String
    The token for the Workspace the ResourceReport is a part of.
    budgetTokens string[]
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    createdAt string
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    durationInDays number
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    id string
    The id of the resource
    integrationProvider string
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    periodToTrack string
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    recipientChannels string[]
    The channels receiving the alerts. Requires an integration provider to be connected.
    recipientEmails string[]
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    threshold number
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    token string
    userToken string
    The token for the User who created this BudgetAlert.
    userTokens string[]
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    workspaceToken string
    The token for the Workspace the ResourceReport is a part of.
    budget_tokens Sequence[str]
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    created_at str
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    duration_in_days float
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    id str
    The id of the resource
    integration_provider str
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    period_to_track str
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    recipient_channels Sequence[str]
    The channels receiving the alerts. Requires an integration provider to be connected.
    recipient_emails Sequence[str]
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    threshold float
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    token str
    user_token str
    The token for the User who created this BudgetAlert.
    user_tokens Sequence[str]
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    workspace_token str
    The token for the Workspace the ResourceReport is a part of.
    budgetTokens List<String>
    The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.
    createdAt String
    The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
    durationInDays Number
    The API's nullable integer duration. A null value means the full month; the vantage.BudgetAlert resource writes the same state as "".
    id String
    The id of the resource
    integrationProvider String
    The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.
    periodToTrack String
    The period tracked on the alert. Used with durationindays to determine the time window of the alert. Possible values: startofthemonth, endofthemonth.
    recipientChannels List<String>
    The channels receiving the alerts. Requires an integration provider to be connected.
    recipientEmails List<String>
    The complete recipient address list, including organization users and freeform addresses on verified domains.
    threshold Number
    Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.
    token String
    userToken String
    The token for the User who created this BudgetAlert.
    userTokens List<String>
    The organization-user subset of recipients. Freeform verified-domain addresses are excluded; recipient_emails contains the complete address list.
    workspaceToken String
    The token for the Workspace the ResourceReport is a part of.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    Viewing docs for vantage 0.3.19
    published on Thursday, Sep 10, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial