LegacyUsageDetail interface

Package:
@azure/arm-consumption

Legacy usage detail.

Extends
UsageDetail

Properties

accountName

Account Name.
accountOwnerId

Account Owner Id.
additionalInfo

Additional details of this usage item. By default this is not populated, unless it's specified in $expand. Use this field to get usage line item specific details such as the actual VM Size (ServiceType) or the ratio in which the reservation discount is applied.
benefitId

Unique identifier for the applicable benefit.
benefitName

Name of the applicable benefit.
billingAccountId

Billing Account identifier.
billingAccountName

Billing Account Name.
billingCurrency

Billing Currency.
billingPeriodEndDate

The billing period end date.
billingPeriodStartDate

The billing period start date.
billingProfileId

Billing Profile identifier.
billingProfileName

Billing Profile Name.
chargeType

Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.
consumedService

Consumed service name. Name of the azure resource provider that emits the usage or was purchased. This value is not provided for marketplace usage.
cost

The amount of cost before tax.
costCenter

The cost center of this department if it is a department and a cost center is provided.
date

Date for the usage record.
effectivePrice

Effective Price that's charged for the usage.
frequency

Indicates how frequently this charge will occur. OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.
invoiceSection

Invoice Section Name.
isAzureCreditEligible

Is Azure Credit Eligible.
kind

Specifies the kind of usage details.
meterDetails

The details about the meter. By default this is not populated, unless it's specified in $expand.
meterId

The meter id (GUID). Not available for marketplace. For reserved instance this represents the primary meter for which the reservation was purchased. For the actual VM Size for which the reservation is purchased see productOrderName.
offerId

Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.
partNumber

Part Number of the service used. Can be used to join with the price sheet. Not available for marketplace.
payGPrice

Retail price for the resource.
planName

Plan Name.
pricingModel

Identifier that indicates how the meter is priced.
product

Product name for the consumed service or purchase. Not available for Marketplace.
productOrderId

Product Order Id. For reservations this is the Reservation Order ID.
productOrderName

Product Order Name. For reservations this is the SKU that was purchased.
publisherName

Publisher Name.
publisherType

Publisher Type.
quantity

The usage quantity.
reservationId

ARM resource id of the reservation. Only applies to records relevant to reservations.
reservationName

User provided display name of the reservation. Last known name for a particular day is populated in the daily data. Only applies to records relevant to reservations.
resourceGroup

Resource Group Name.
resourceId

Unique identifier of the Azure Resource Manager usage detail resource.
resourceLocation

Resource Location.
resourceName

Resource Name.
serviceInfo1

Service-specific metadata.
serviceInfo2

Legacy field with optional service-specific metadata.
subscriptionId

Subscription guid.
subscriptionName

Subscription name.
term

Term (in months). 1 month for monthly recurring purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation.
unitPrice

Unit Price is the price applicable to you. (your EA or other contract price).

Inherited Properties

etag

The etag for the resource.
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.
tags

Resource tags.
type

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

Property Details

accountName

Account Name.

accountName?: string

Property Value

string

accountOwnerId

Account Owner Id.

accountOwnerId?: string

Property Value

string

additionalInfo

Additional details of this usage item. By default this is not populated, unless it's specified in $expand. Use this field to get usage line item specific details such as the actual VM Size (ServiceType) or the ratio in which the reservation discount is applied.

additionalInfo?: string

Property Value

string

benefitId

Unique identifier for the applicable benefit.

benefitId?: string

Property Value

string

benefitName

Name of the applicable benefit.

benefitName?: string

Property Value

string

billingAccountId

Billing Account identifier.

billingAccountId?: string

Property Value

string

billingAccountName

Billing Account Name.

billingAccountName?: string

Property Value

string

billingCurrency

Billing Currency.

billingCurrency?: string

Property Value

string

billingPeriodEndDate

The billing period end date.

billingPeriodEndDate?: Date

Property Value

Date

billingPeriodStartDate

The billing period start date.

billingPeriodStartDate?: Date

Property Value

Date

billingProfileId

Billing Profile identifier.

billingProfileId?: string

Property Value

string

billingProfileName

Billing Profile Name.

billingProfileName?: string

Property Value

string

chargeType

Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.

chargeType?: string

Property Value

string

consumedService

Consumed service name. Name of the azure resource provider that emits the usage or was purchased. This value is not provided for marketplace usage.

consumedService?: string

Property Value

string

cost

The amount of cost before tax.

cost?: number

Property Value

number

costCenter

The cost center of this department if it is a department and a cost center is provided.

costCenter?: string

Property Value

string

date

Date for the usage record.

date?: Date

Property Value

Date

effectivePrice

Effective Price that's charged for the usage.

effectivePrice?: number

Property Value

number

frequency

Indicates how frequently this charge will occur. OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.

frequency?: string

Property Value

string

invoiceSection

Invoice Section Name.

invoiceSection?: string

Property Value

string

isAzureCreditEligible

Is Azure Credit Eligible.

isAzureCreditEligible?: boolean

Property Value

boolean

kind

Specifies the kind of usage details.

kind: "legacy"

Property Value

"legacy"

meterDetails

The details about the meter. By default this is not populated, unless it's specified in $expand.

meterDetails?: MeterDetailsResponse

Property Value

MeterDetailsResponse

meterId

The meter id (GUID). Not available for marketplace. For reserved instance this represents the primary meter for which the reservation was purchased. For the actual VM Size for which the reservation is purchased see productOrderName.

meterId?: string

Property Value

string

offerId

Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.

offerId?: string

Property Value

string

partNumber

Part Number of the service used. Can be used to join with the price sheet. Not available for marketplace.

partNumber?: string

Property Value

string

payGPrice

Retail price for the resource.

payGPrice?: number

Property Value

number

planName

Plan Name.

planName?: string

Property Value

string

pricingModel

Identifier that indicates how the meter is priced.

pricingModel?: string

Property Value

string

product

Product name for the consumed service or purchase. Not available for Marketplace.

product?: string

Property Value

string

productOrderId

Product Order Id. For reservations this is the Reservation Order ID.

productOrderId?: string

Property Value

string

productOrderName

Product Order Name. For reservations this is the SKU that was purchased.

productOrderName?: string

Property Value

string

publisherName

Publisher Name.

publisherName?: string

Property Value

string

publisherType

Publisher Type.

publisherType?: string

Property Value

string

quantity

The usage quantity.

quantity?: number

Property Value

number

reservationId

ARM resource id of the reservation. Only applies to records relevant to reservations.

reservationId?: string

Property Value

string

reservationName

User provided display name of the reservation. Last known name for a particular day is populated in the daily data. Only applies to records relevant to reservations.

reservationName?: string

Property Value

string

resourceGroup

Resource Group Name.

resourceGroup?: string

Property Value

string

resourceId

Unique identifier of the Azure Resource Manager usage detail resource.

resourceId?: string

Property Value

string

resourceLocation

Resource Location.

resourceLocation?: string

Property Value

string

resourceName

Resource Name.

resourceName?: string

Property Value

string

serviceInfo1

Service-specific metadata.

serviceInfo1?: string

Property Value

string

serviceInfo2

Legacy field with optional service-specific metadata.

serviceInfo2?: string

Property Value

string

subscriptionId

Subscription guid.

subscriptionId?: string

Property Value

string

subscriptionName

Subscription name.

subscriptionName?: string

Property Value

string

term

Term (in months). 1 month for monthly recurring purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation.

term?: string

Property Value

string

unitPrice

Unit Price is the price applicable to you. (your EA or other contract price).

unitPrice?: number

Property Value

number

Inherited Property Details

etag

The etag for the resource.

etag?: string

Property Value

string

Inherited From UsageDetail.etag

id

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

id?: string

Property Value

string

Inherited From UsageDetail.id

name

The name of the resource

name?: string

Property Value

string

Inherited From UsageDetail.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From UsageDetail.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From UsageDetail.tags

type

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

type?: string

Property Value

string

Inherited From UsageDetail.type