Budget Class

  • Reference

A budget resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.consumption.models._models_py3.ProxyResource
Budget

Constructor

Budget(*, e_tag: str | None = None, category: str | _models.CategoryType | None = None, amount: float | None = None, time_grain: str | _models.TimeGrainType | None = None, time_period: _models.BudgetTimePeriod | None = None, filter: _models.BudgetFilter | None = None, notifications: Dict[str, _models.Notification] | None = None, **kwargs)

Keyword-Only Parameters

Name Description
e_tag
str

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.
category
str or CategoryType

The category of the budget, whether the budget tracks cost or usage. Known values are: "Cost".
amount
float

The total amount of cost to track with the budget.
time_grain
str or TimeGrainType

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. Known values are: "Monthly", "Quarterly", "Annually", "BillingMonth", "BillingQuarter", "BillingAnnual".
time_period
BudgetTimePeriod

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.
filter
BudgetFilter

May be used to filter budgets by user-specified dimensions and/or tags.
notifications
dict[str, Notification]

Dictionary of notifications associated with the budget. Budget can have up to five notifications.

Variables

Name Description
id
str

Resource Id.
name
str

Resource name.
type
str

Resource type.
e_tag
str

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.
category
str or CategoryType

The category of the budget, whether the budget tracks cost or usage. Known values are: "Cost".
amount
float

The total amount of cost to track with the budget.
time_grain
str or TimeGrainType

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. Known values are: "Monthly", "Quarterly", "Annually", "BillingMonth", "BillingQuarter", "BillingAnnual".
time_period
BudgetTimePeriod

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.
filter
BudgetFilter

May be used to filter budgets by user-specified dimensions and/or tags.
current_spend
CurrentSpend

The current amount of cost which is being tracked for a budget.
notifications
dict[str, Notification]

Dictionary of notifications associated with the budget. Budget can have up to five notifications.
forecast_spend
ForecastSpend

The forecasted cost which is being tracked for a budget.