Share via

LegacyUsageDetail interface

  • Reference
Package:
@azure/arm-consumption

Legacy usage detail.

Extends
UsageDetail

Properties

accountName

Account Name. NOTE: This property will not be serialized. It can only be populated by the server.
accountOwnerId

Account Owner Id. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
billingAccountId

Billing Account identifier. NOTE: This property will not be serialized. It can only be populated by the server.
billingAccountName

Billing Account Name. NOTE: This property will not be serialized. It can only be populated by the server.
billingCurrency

Billing Currency. NOTE: This property will not be serialized. It can only be populated by the server.
billingPeriodEndDate

The billing period end date. NOTE: This property will not be serialized. It can only be populated by the server.
billingPeriodStartDate

The billing period start date. NOTE: This property will not be serialized. It can only be populated by the server.
billingProfileId

Billing Profile identifier. NOTE: This property will not be serialized. It can only be populated by the server.
billingProfileName

Billing Profile Name. NOTE: This property will not be serialized. It can only be populated by the server.
chargeType

Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
cost

The amount of cost before tax. NOTE: This property will not be serialized. It can only be populated by the server.
costCenter

The cost center of this department if it is a department and a cost center is provided. NOTE: This property will not be serialized. It can only be populated by the server.
date

Date for the usage record. NOTE: This property will not be serialized. It can only be populated by the server.
effectivePrice

Effective Price that's charged for the usage. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
invoiceSection

Invoice Section Name. NOTE: This property will not be serialized. It can only be populated by the server.
isAzureCreditEligible

Is Azure Credit Eligible. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Polymorphic discriminator, which specifies the different types this object can be
meterDetails

The details about the meter. By default this is not populated, unless it's specified in $expand. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
offerId

Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P. NOTE: This property will not be serialized. It can only be populated by the server.
partNumber

Part Number of the service used. Can be used to join with the price sheet. Not available for marketplace. NOTE: This property will not be serialized. It can only be populated by the server.
payGPrice

Retail price for the resource. NOTE: This property will not be serialized. It can only be populated by the server.
planName

Plan Name. NOTE: This property will not be serialized. It can only be populated by the server.
pricingModel

Identifier that indicates how the meter is priced. NOTE: This property will not be serialized. It can only be populated by the server.
product

Product name for the consumed service or purchase. Not available for Marketplace. NOTE: This property will not be serialized. It can only be populated by the server.
productOrderId

Product Order Id. For reservations this is the Reservation Order ID. NOTE: This property will not be serialized. It can only be populated by the server.
productOrderName

Product Order Name. For reservations this is the SKU that was purchased. NOTE: This property will not be serialized. It can only be populated by the server.
publisherName

Publisher Name. NOTE: This property will not be serialized. It can only be populated by the server.
publisherType

Publisher Type. NOTE: This property will not be serialized. It can only be populated by the server.
quantity

The usage quantity. NOTE: This property will not be serialized. It can only be populated by the server.
reservationId

ARM resource id of the reservation. Only applies to records relevant to reservations. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGroup

Resource Group Name. NOTE: This property will not be serialized. It can only be populated by the server.
resourceId

Unique identifier of the Azure Resource Manager usage detail resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceLocation

Resource Location. NOTE: This property will not be serialized. It can only be populated by the server.
resourceName

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
serviceInfo1

Service-specific metadata. NOTE: This property will not be serialized. It can only be populated by the server.
serviceInfo2

Legacy field with optional service-specific metadata. NOTE: This property will not be serialized. It can only be populated by the server.
subscriptionId

Subscription guid. NOTE: This property will not be serialized. It can only be populated by the server.
subscriptionName

Subscription name. NOTE: This property will not be serialized. It can only be populated by the server.
term

Term (in months). 1 month for monthly recurring purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation. NOTE: This property will not be serialized. It can only be populated by the server.
unitPrice

Unit Price is the price applicable to you. (your EA or other contract price). NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

etag

The etag for the resource. NOTE: This property will not be serialized. It can only be populated by the server.
id

The full qualified ARM ID of an event. NOTE: This property will not be serialized. It can only be populated by the server.
name

The ID that uniquely identifies an event. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accountName

Account Name. NOTE: This property will not be serialized. It can only be populated by the server.

accountName?: string

Property Value

string

accountOwnerId

Account Owner Id. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

additionalInfo?: string

Property Value

string

billingAccountId

Billing Account identifier. NOTE: This property will not be serialized. It can only be populated by the server.

billingAccountId?: string

Property Value

string

billingAccountName

Billing Account Name. NOTE: This property will not be serialized. It can only be populated by the server.

billingAccountName?: string

Property Value

string

billingCurrency

Billing Currency. NOTE: This property will not be serialized. It can only be populated by the server.

billingCurrency?: string

Property Value

string

billingPeriodEndDate

The billing period end date. NOTE: This property will not be serialized. It can only be populated by the server.

billingPeriodEndDate?: Date

Property Value

Date

billingPeriodStartDate

The billing period start date. NOTE: This property will not be serialized. It can only be populated by the server.

billingPeriodStartDate?: Date

Property Value

Date

billingProfileId

Billing Profile identifier. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileId?: string

Property Value

string

billingProfileName

Billing Profile Name. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileName?: string

Property Value

string

chargeType

Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

consumedService?: string

Property Value

string

cost

The amount of cost before tax. NOTE: This property will not be serialized. It can only be populated by the server.

cost?: number

Property Value

number

costCenter

The cost center of this department if it is a department and a cost center is provided. NOTE: This property will not be serialized. It can only be populated by the server.

costCenter?: string

Property Value

string

date

Date for the usage record. NOTE: This property will not be serialized. It can only be populated by the server.

date?: Date

Property Value

Date

effectivePrice

Effective Price that's charged for the usage. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

frequency?: string

Property Value

string

invoiceSection

Invoice Section Name. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSection?: string

Property Value

string

isAzureCreditEligible

Is Azure Credit Eligible. NOTE: This property will not be serialized. It can only be populated by the server.

isAzureCreditEligible?: boolean

Property Value

boolean

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "legacy"

Property Value

"legacy"

meterDetails

The details about the meter. By default this is not populated, unless it's specified in $expand. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

meterId?: string

Property Value

string

offerId

Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

partNumber?: string

Property Value

string

payGPrice

Retail price for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

payGPrice?: number

Property Value

number

planName

Plan Name. NOTE: This property will not be serialized. It can only be populated by the server.

planName?: string

Property Value

string

pricingModel

Identifier that indicates how the meter is priced. NOTE: This property will not be serialized. It can only be populated by the server.

pricingModel?: string

Property Value

string

product

Product name for the consumed service or purchase. Not available for Marketplace. NOTE: This property will not be serialized. It can only be populated by the server.

product?: string

Property Value

string

productOrderId

Product Order Id. For reservations this is the Reservation Order ID. NOTE: This property will not be serialized. It can only be populated by the server.

productOrderId?: string

Property Value

string

productOrderName

Product Order Name. For reservations this is the SKU that was purchased. NOTE: This property will not be serialized. It can only be populated by the server.

productOrderName?: string

Property Value

string

publisherName

Publisher Name. NOTE: This property will not be serialized. It can only be populated by the server.

publisherName?: string

Property Value

string

publisherType

Publisher Type. NOTE: This property will not be serialized. It can only be populated by the server.

publisherType?: string

Property Value

string

quantity

The usage quantity. NOTE: This property will not be serialized. It can only be populated by the server.

quantity?: number

Property Value

number

reservationId

ARM resource id of the reservation. Only applies to records relevant to reservations. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

reservationName?: string

Property Value

string

resourceGroup

Resource Group Name. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGroup?: string

Property Value

string

resourceId

Unique identifier of the Azure Resource Manager usage detail resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId?: string

Property Value

string

resourceLocation

Resource Location. NOTE: This property will not be serialized. It can only be populated by the server.

resourceLocation?: string

Property Value

string

resourceName

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

resourceName?: string

Property Value

string

serviceInfo1

Service-specific metadata. NOTE: This property will not be serialized. It can only be populated by the server.

serviceInfo1?: string

Property Value

string

serviceInfo2

Legacy field with optional service-specific metadata. NOTE: This property will not be serialized. It can only be populated by the server.

serviceInfo2?: string

Property Value

string

subscriptionId

Subscription guid. NOTE: This property will not be serialized. It can only be populated by the server.

subscriptionId?: string

Property Value

string

subscriptionName

Subscription name. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

term?: string

Property Value

string

unitPrice

Unit Price is the price applicable to you. (your EA or other contract price). NOTE: This property will not be serialized. It can only be populated by the server.

unitPrice?: number

Property Value

number

Inherited Property Details

etag

The etag for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From UsageDetail.etag

id

The full qualified ARM ID of an event. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From UsageDetail.id

name

The ID that uniquely identifies an event. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From UsageDetail.name

tags

Resource tags. NOTE: This property will not be serialized. It can only be populated by the server.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From UsageDetail.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From UsageDetail.type