Budget Interface

Package:

com.azure.resourcemanager.consumption.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0-beta.4

public interface Budget

An immutable client-side representation of Budget.

Method Summary

Modifier and Type	Method and Description
abstract BigDecimal	amount() Gets the amount property: The total amount of cost to track with the budget.
abstract CategoryType	category() Gets the category property: The category of the budget, whether the budget tracks cost or usage.
abstract CurrentSpend	currentSpend() Gets the currentSpend property: The current amount of cost which is being tracked for a budget.
abstract String	etag() Gets the etag property: eTag of the resource.
abstract BudgetFilter	filter() Gets the filter property: May be used to filter budgets by user-specified dimensions and/or tags.
abstract ForecastSpend	forecastSpend() Gets the forecastSpend property: The forecasted cost which is being tracked for a budget.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract BudgetInner	innerModel() Gets the inner com.azure.resourcemanager.consumption.fluent.models.BudgetInner object.
abstract String	name() Gets the name property: The name of the resource.
abstract Map<String,Notification>	notifications() Gets the notifications property: Dictionary of notifications associated with the budget.
abstract Budget	refresh() Refreshes the resource to sync with Azure.
abstract Budget	refresh(Context context) Refreshes the resource to sync with Azure.
abstract TimeGrainType	timeGrain() Gets the timeGrain property: The time covered by a budget.
abstract BudgetTimePeriod	timePeriod() Gets the timePeriod property: Has start and end date of the budget.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the Budget resource.

Method Details

amount

public abstract BigDecimal amount()

Gets the amount property: The total amount of cost to track with the budget.

Returns:

the amount value.

category

public abstract CategoryType category()

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

Returns:

the category value.

currentSpend

public abstract CurrentSpend currentSpend()

Gets the currentSpend property: The current amount of cost which is being tracked for a budget.

Returns:

the currentSpend value.

etag

public abstract String etag()

Gets the etag property: 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.

Returns:

the etag value.

filter

public abstract BudgetFilter filter()

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

Returns:

the filter value.

forecastSpend

public abstract ForecastSpend forecastSpend()

Gets the forecastSpend property: The forecasted cost which is being tracked for a budget.

Returns:

the forecastSpend value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract BudgetInner innerModel()

Gets the inner com.azure.resourcemanager.consumption.fluent.models.BudgetInner object.

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

notifications

public abstract Map notifications()

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

Returns:

the notifications value.

refresh

public abstract Budget refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Budget refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

timeGrain

public abstract TimeGrainType timeGrain()

Gets the timeGrain property: 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.

Returns:

the timeGrain value.

timePeriod

public abstract BudgetTimePeriod timePeriod()

Gets the timePeriod property: 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.

Returns:

the timePeriod value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Budget.Update update()

Begins update for the Budget resource.

Returns:

the stage of resource update.