Budget interface

Package:

@azure/arm-consumption

A budget resource.

Extends

ProxyResource

Properties

amount	The total amount of cost to track with the budget
category	The category of the budget, whether the budget tracks cost or usage.
currentSpend	The current amount of cost which is being tracked for a budget. NOTE: This property will not be serialized. It can only be populated by the server.
filter	May be used to filter budgets by user-specified dimensions and/or tags.
forecastSpend	The forecasted cost which is being tracked for a budget. NOTE: This property will not be serialized. It can only be populated by the server.
notifications	Dictionary of notifications associated with the budget. Budget can have up to five notifications.
timeGrain	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
timePeriod	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.

Inherited Properties

eTag	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.
id	Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

amount

The total amount of cost to track with the budget

amount?: number

Property Value

number

category

The category of the budget, whether the budget tracks cost or usage.

category?: string

Property Value

string

currentSpend

The current amount of cost which is being tracked for a budget. NOTE: This property will not be serialized. It can only be populated by the server.

currentSpend?: CurrentSpend

Property Value

CurrentSpend

filter

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

filter?: BudgetFilter

Property Value

BudgetFilter

forecastSpend

The forecasted cost which is being tracked for a budget. NOTE: This property will not be serialized. It can only be populated by the server.

forecastSpend?: ForecastSpend

Property Value

ForecastSpend

notifications

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

notifications?: {[propertyName: string]: Notification_2}

Property Value

{[propertyName: string]: Notification}

timeGrain

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?: string

Property Value

string

timePeriod

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?: BudgetTimePeriod

Property Value

BudgetTimePeriod

Inherited Property Details

eTag

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?: string

Property Value

string

Inherited From ProxyResource.eTag

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type