BudgetData Class

Definition

A budget resource.

public class BudgetData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CostManagement.BudgetData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CostManagement.BudgetData>
type BudgetData = class
    inherit ResourceData
    interface IJsonModel<BudgetData>
    interface IPersistableModel<BudgetData>
Public Class BudgetData
Inherits ResourceData
Implements IJsonModel(Of BudgetData), IPersistableModel(Of BudgetData)
Inheritance
BudgetData
Implements

Constructors

Name Description
BudgetData()

Initializes a new instance of BudgetData.

Properties

Name Description
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.

Id

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

(Inherited from ResourceData)
Name

The name of the resource.

(Inherited from ResourceData)
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.
ResourceType

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

(Inherited from ResourceData)
SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BudgetData>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<BudgetData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<BudgetData>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<BudgetData>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<BudgetData>.Write(ModelReaderWriterOptions)

Applies to