@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* A budget resource.
*
* Uses Azure REST API version 2024-08-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
*
* Other available API versions: 2023-05-01, 2023-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native consumption [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Budget extends pulumi.CustomResource {
/**
* Get an existing Budget resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Budget;
/**
* Returns true if the given object is an instance of Budget. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Budget;
/**
* The total amount of cost to track with the budget
*/
readonly amount: pulumi.Output<number>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The category of the budget, whether the budget tracks cost or usage.
*/
readonly category: pulumi.Output<string>;
/**
* The current amount of cost which is being tracked for a budget.
*/
readonly currentSpend: pulumi.Output<outputs.consumption.CurrentSpendResponse>;
/**
* eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
*/
readonly eTag: pulumi.Output<string | undefined>;
/**
* May be used to filter budgets by user-specified dimensions and/or tags.
*/
readonly filter: pulumi.Output<outputs.consumption.BudgetFilterResponse | undefined>;
/**
* The forecasted cost which is being tracked for a budget.
*/
readonly forecastSpend: pulumi.Output<outputs.consumption.ForecastSpendResponse>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* Dictionary of notifications associated with the budget. Budget can have up to five notifications.
*/
readonly notifications: pulumi.Output<{
[key: string]: outputs.consumption.NotificationResponse;
} | undefined>;
/**
* The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers
*/
readonly timeGrain: pulumi.Output<string>;
/**
* Has start and end date of 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. There are no restrictions on the end date.
*/
readonly timePeriod: pulumi.Output<outputs.consumption.BudgetTimePeriodResponse>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Budget resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BudgetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Budget resource.
*/
export interface BudgetArgs {
/**
* The total amount of cost to track with the budget
*/
amount: pulumi.Input<number>;
/**
* Budget Name.
*/
budgetName?: pulumi.Input<string>;
/**
* The category of the budget, whether the budget tracks cost or usage.
*/
category: pulumi.Input<string | enums.consumption.CategoryType>;
/**
* eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
*/
eTag?: pulumi.Input<string>;
/**
* May be used to filter budgets by user-specified dimensions and/or tags.
*/
filter?: pulumi.Input<inputs.consumption.BudgetFilterArgs>;
/**
* Dictionary of notifications associated with the budget. Budget can have up to five notifications.
*/
notifications?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.consumption.NotificationArgs>;
}>;
/**
* The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.
*/
scope: pulumi.Input<string>;
/**
* The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers
*/
timeGrain: pulumi.Input<string | enums.consumption.TimeGrainType>;
/**
* Has start and end date of 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. There are no restrictions on the end date.
*/
timePeriod: pulumi.Input<inputs.consumption.BudgetTimePeriodArgs>;
}