Budget interface

Package:
@azure/arm-costmanagement

A budget resource.

Extends
ExtensionResource

Properties

amount

The total amount of cost to track with the budget.

Supported for CategoryType(s): Cost.

Required for CategoryType(s): Cost.
category

The category of the budget.

  • 'Cost' defines a Budget.
  • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
currentSpend

The current amount of cost which is being tracked for a budget.

Supported for CategoryType(s): Cost.
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.
filter

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

Supported for CategoryType(s): Cost, ReservationUtilization.
forecastSpend

The forecasted cost which is being tracked for a budget.

Supported for CategoryType(s): Cost.
notifications

Dictionary of notifications associated with the budget.

Supported for CategoryType(s): Cost, ReservationUtilization.

  • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
  • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
timeGrain

The time covered by a budget. Tracking of the amount will be reset based on the time grain.

Supported for CategoryType(s): Cost, ReservationUtilization.

Supported timeGrainTypes for CategoryType: Cost

  • Monthly
  • Quarterly
  • Annually
  • BillingMonth*
  • BillingQuarter*
  • BillingAnnual*

*only supported for Web Direct customers.

Supported timeGrainTypes for CategoryType: ReservationUtilization

  • Last7Days
  • Last30Days

Required for CategoryType(s): Cost, ReservationUtilization.
timePeriod

The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

Supported for CategoryType(s): Cost, ReservationUtilization.

Required for CategoryType(s): Cost, ReservationUtilization.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

amount

The total amount of cost to track with the budget.

Supported for CategoryType(s): Cost.

Required for CategoryType(s): Cost.

amount?: number

Property Value

number

category

The category of the budget.

  • 'Cost' defines a Budget.
  • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
category?: string

Property Value

string

currentSpend

The current amount of cost which is being tracked for a budget.

Supported for CategoryType(s): Cost.

currentSpend?: CurrentSpend

Property Value

CurrentSpend

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

filter

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

Supported for CategoryType(s): Cost, ReservationUtilization.

filter?: BudgetFilter

Property Value

BudgetFilter

forecastSpend

The forecasted cost which is being tracked for a budget.

Supported for CategoryType(s): Cost.

forecastSpend?: ForecastSpend

Property Value

ForecastSpend

notifications

Dictionary of notifications associated with the budget.

Supported for CategoryType(s): Cost, ReservationUtilization.

  • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
  • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
notifications?: Record<string, Notification>

Property Value

Record<string, Notification>

timeGrain

The time covered by a budget. Tracking of the amount will be reset based on the time grain.

Supported for CategoryType(s): Cost, ReservationUtilization.

Supported timeGrainTypes for CategoryType: Cost

  • Monthly
  • Quarterly
  • Annually
  • BillingMonth*
  • BillingQuarter*
  • BillingAnnual*

*only supported for Web Direct customers.

Supported timeGrainTypes for CategoryType: ReservationUtilization

  • Last7Days
  • Last30Days

Required for CategoryType(s): Cost, ReservationUtilization.

timeGrain?: string

Property Value

string

timePeriod

The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

Supported for CategoryType(s): Cost, ReservationUtilization.

Required for CategoryType(s): Cost, ReservationUtilization.

timePeriod?: BudgetTimePeriod

Property Value

BudgetTimePeriod

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ExtensionResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ExtensionResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ExtensionResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ExtensionResource.type