Balance interface

Package:

@azure/arm-consumption

A balance resource.

Extends

Resource

Properties

adjustmentDetails	List of Adjustments (Promo credit, SIE credit etc.).
adjustments	Total adjustment amount.
azureMarketplaceServiceCharges	Total charges for Azure Marketplace.
beginningBalance	The beginning balance for the billing period.
billingFrequency	The billing frequency.
chargesBilledSeparately	Charges Billed separately.
currency	The ISO currency in which the meter is charged, for example, USD.
endingBalance	The ending balance for the billing period (for open periods this will be updated daily).
etag	The etag for the resource.
newPurchases	Total new purchase amount.
newPurchasesDetails	List of new purchases.
overageRefund	Overage Refunds
priceHidden	Price is hidden or not.
serviceOverage	Overage for Azure services.
tags	Resource tags.
totalOverage	serviceOverage + chargesBilledSeparately.
totalUsage	Azure service commitment + total Overage.
utilized	Total Commitment usage.

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

adjustmentDetails

List of Adjustments (Promo credit, SIE credit etc.).

adjustmentDetails?: BalancePropertiesAdjustmentDetailsItem[]

Property Value

BalancePropertiesAdjustmentDetailsItem[]

adjustments

Total adjustment amount.

adjustments?: number

Property Value

number

azureMarketplaceServiceCharges

Total charges for Azure Marketplace.

azureMarketplaceServiceCharges?: number

Property Value

number

beginningBalance

The beginning balance for the billing period.

beginningBalance?: number

Property Value

number

billingFrequency

The billing frequency.

billingFrequency?: string

Property Value

string

chargesBilledSeparately

Charges Billed separately.

chargesBilledSeparately?: number

Property Value

number

currency

The ISO currency in which the meter is charged, for example, USD.

currency?: string

Property Value

string

endingBalance

The ending balance for the billing period (for open periods this will be updated daily).

endingBalance?: number

Property Value

number

etag

The etag for the resource.

etag?: string

Property Value

string

newPurchases

Total new purchase amount.

newPurchases?: number

Property Value

number

newPurchasesDetails

List of new purchases.

newPurchasesDetails?: BalancePropertiesNewPurchasesDetailsItem[]

Property Value

BalancePropertiesNewPurchasesDetailsItem[]

overageRefund

Overage Refunds

overageRefund?: number

Property Value

number

priceHidden

Price is hidden or not.

priceHidden?: boolean

Property Value

boolean

serviceOverage

Overage for Azure services.

serviceOverage?: number

Property Value

number

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

totalOverage

serviceOverage + chargesBilledSeparately.

totalOverage?: number

Property Value

number

totalUsage

Azure service commitment + total Overage.

totalUsage?: number

Property Value

number

utilized

Total Commitment usage.

utilized?: number

Property Value

number

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 Resource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From Resource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

type

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

type?: string

Property Value

string

Inherited From Resource.type