ModernUsageDetailProperties interface

Package:

@azure/arm-consumption

The properties of the usage detail.

Properties

additionalInfo	Additional details of this usage item. 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	Name of the Billing Account.
billingCurrencyCode	The currency defining the billed cost.
billingPeriodEndDate	Billing Period End Date as in the invoice.
billingPeriodStartDate	Billing Period Start Date as in the invoice.
billingProfileId	Identifier for the billing profile that groups costs across invoices in the a singular billing currency across across the customers who have onboarded the Microsoft customer agreement and the customers in CSP who have made entitlement purchases like SaaS, Marketplace, RI, etc.
billingProfileName	Name of the billing profile that groups costs across invoices in the a singular billing currency across across the customers who have onboarded the Microsoft customer agreement and the customers in CSP who have made entitlement purchases like SaaS, Marketplace, RI, etc.
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.
costAllocationRuleName	Name for Cost Allocation Rule.
costCenter	The cost center of this department if it is a department and a cost center is provided.
costInBillingCurrency	ExtendedCost or blended cost before tax in billed currency.
costInPricingCurrency	ExtendedCost or blended cost before tax in pricing currency to correlate with prices.
costInUSD	Estimated extendedCost or blended cost before tax in USD.
customerName	Name of the customer's AAD tenant.
customerTenantId	Identifier of the customer's AAD tenant.
date	Date for the usage record.
effectivePrice	Effective Price that's charged for the usage.
exchangeRate	Exchange rate used in conversion from pricing currency to billing currency.
exchangeRateDate	Date on which exchange rate used in conversion from pricing currency to billing currency.
exchangeRatePricingToBilling	Exchange Rate from pricing currency to billing currency.
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.
instanceName	Instance Name.
invoiceId	Invoice ID as on the invoice where the specific transaction appears.
invoiceSectionId	Identifier of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners.
invoiceSectionName	Name of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners.
isAzureCreditEligible	Determines if the cost is eligible to be paid for using Azure credits.
marketPrice	Market Price that's charged for the usage.
meterCategory	Identifies the top-level service for the usage.
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.
meterName	Identifies the name of the meter against which consumption is measured.
meterRegion	Identifies the location of the datacenter for certain services that are priced based on datacenter location.
meterSubCategory	Defines the type or sub-category of Azure service that can affect the rate.
partnerEarnedCreditApplied	Flag to indicate if partner earned credit has been applied or not.
partnerEarnedCreditRate	Rate of discount applied if there is a partner earned credit (PEC) based on partner admin link access.
partnerName	Name of the partner' AAD tenant.
partnerTenantId	Identifier for the partner's AAD tenant.
paygCostInBillingCurrency	The amount of PayG cost before tax in billing currency.
paygCostInUSD	The amount of PayG cost before tax in US Dollar currency.
payGPrice	Retail price for the resource.
previousInvoiceId	Reference to an original invoice there is a refund (negative cost). This is populated only when there is a refund.
pricingCurrencyCode	Pricing Billing Currency.
pricingModel	Identifier that indicates how the meter is priced
product	Name of the product that has accrued charges by consumption or purchase as listed in the invoice. Not available for Marketplace.
productIdentifier	Identifier for the product that has accrued charges by consumption or purchase . This is the concatenated key of productId and SkuId in partner center.
productOrderId	The identifier for the asset or Azure plan name that the subscription belongs to. For example: Azure Plan. For reservations this is the Reservation Order ID.
productOrderName	Product Order Name. For reservations this is the SKU that was purchased.
provider	Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c
publisherId	Publisher Id.
publisherName	Name of the publisher of the service including Microsoft or Third Party publishers.
publisherType	Type of publisher that identifies if the publisher is first party, third party reseller or third party agency.
quantity	Measure the quantity purchased or consumed.The amount of the meter used during the billing period.
resellerMpnId	MPNId for the reseller associated with the subscription.
resellerName	Reseller Name.
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	Name of the Azure resource group used for cohesive lifecycle management of resources.
resourceLocation	Name of the resource location.
resourceLocationNormalized	Resource Location Normalized.
serviceFamily	List the service family for the product purchased or charged (Example: Storage ; Compute).
serviceInfo1	Service-specific metadata.
serviceInfo2	Legacy field with optional service-specific metadata.
servicePeriodEndDate	End date for the period when the service usage was rated for charges. The prices for Azure services are determined based on the rating period.
servicePeriodStartDate	Start date for the rating period when the service usage was rated for charges. The prices for Azure services are determined for the rating period.
subscriptionGuid	Unique Microsoft generated identifier for the Azure Subscription.
subscriptionName	Name of the Azure Subscription.
term	Term (in months). Displays the term for the validity of the offer. For example. In case of reserved instances it displays 12 months for yearly term of reserved instance. For one time purchases or recurring purchases, the terms displays 1 month; This is not applicable for Azure consumption.
unitOfMeasure	Identifies the Unit that the service is charged in. For example, GB, hours, 10,000 s.
unitPrice	Unit Price is the price applicable to you. (your EA or other contract price).

Property Details

additionalInfo

Additional details of this usage item. 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

Name of the Billing Account.

billingAccountName?: string

Property Value

string

billingCurrencyCode

The currency defining the billed cost.

billingCurrencyCode?: string

Property Value

string

billingPeriodEndDate

Billing Period End Date as in the invoice.

billingPeriodEndDate?: Date

Property Value

Date

billingPeriodStartDate

Billing Period Start Date as in the invoice.

billingPeriodStartDate?: Date

Property Value

Date

billingProfileId

Identifier for the billing profile that groups costs across invoices in the a singular billing currency across across the customers who have onboarded the Microsoft customer agreement and the customers in CSP who have made entitlement purchases like SaaS, Marketplace, RI, etc.

billingProfileId?: string

Property Value

string

billingProfileName

Name of the billing profile that groups costs across invoices in the a singular billing currency across across the customers who have onboarded the Microsoft customer agreement and the customers in CSP who have made entitlement purchases like SaaS, Marketplace, RI, etc.

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

costAllocationRuleName

Name for Cost Allocation Rule.

costAllocationRuleName?: string

Property Value

string

costCenter

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

costCenter?: string

Property Value

string

costInBillingCurrency

ExtendedCost or blended cost before tax in billed currency.

costInBillingCurrency?: number

Property Value

number

costInPricingCurrency

ExtendedCost or blended cost before tax in pricing currency to correlate with prices.

costInPricingCurrency?: number

Property Value

number

costInUSD

Estimated extendedCost or blended cost before tax in USD.

costInUSD?: number

Property Value

number

customerName

Name of the customer's AAD tenant.

customerName?: string

Property Value

string

customerTenantId

Identifier of the customer's AAD tenant.

customerTenantId?: 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

exchangeRate

Exchange rate used in conversion from pricing currency to billing currency.

exchangeRate?: string

Property Value

string

exchangeRateDate

Date on which exchange rate used in conversion from pricing currency to billing currency.

exchangeRateDate?: Date

Property Value

Date

exchangeRatePricingToBilling

Exchange Rate from pricing currency to billing currency.

exchangeRatePricingToBilling?: 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

instanceName

Instance Name.

instanceName?: string

Property Value

string

invoiceId

Invoice ID as on the invoice where the specific transaction appears.

invoiceId?: string

Property Value

string

invoiceSectionId

Identifier of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners.

invoiceSectionId?: string

Property Value

string

invoiceSectionName

Name of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners.

invoiceSectionName?: string

Property Value

string

isAzureCreditEligible

Determines if the cost is eligible to be paid for using Azure credits.

isAzureCreditEligible?: boolean

Property Value

boolean

marketPrice

Market Price that's charged for the usage.

marketPrice?: number

Property Value

number

meterCategory

Identifies the top-level service for the usage.

meterCategory?: string

Property Value

string

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

meterName

Identifies the name of the meter against which consumption is measured.

meterName?: string

Property Value

string

meterRegion

Identifies the location of the datacenter for certain services that are priced based on datacenter location.

meterRegion?: string

Property Value

string

meterSubCategory

Defines the type or sub-category of Azure service that can affect the rate.

meterSubCategory?: string

Property Value

string

partnerEarnedCreditApplied

Flag to indicate if partner earned credit has been applied or not.

partnerEarnedCreditApplied?: string

Property Value

string

partnerEarnedCreditRate

Rate of discount applied if there is a partner earned credit (PEC) based on partner admin link access.

partnerEarnedCreditRate?: number

Property Value

number

partnerName

Name of the partner' AAD tenant.

partnerName?: string

Property Value

string

partnerTenantId

Identifier for the partner's AAD tenant.

partnerTenantId?: string

Property Value

string

paygCostInBillingCurrency

The amount of PayG cost before tax in billing currency.

paygCostInBillingCurrency?: number

Property Value

number

paygCostInUSD

The amount of PayG cost before tax in US Dollar currency.

paygCostInUSD?: number

Property Value

number

payGPrice

Retail price for the resource.

payGPrice?: number

Property Value

number

previousInvoiceId

Reference to an original invoice there is a refund (negative cost). This is populated only when there is a refund.

previousInvoiceId?: string

Property Value

string

pricingCurrencyCode

Pricing Billing Currency.

pricingCurrencyCode?: string

Property Value

string

pricingModel

Identifier that indicates how the meter is priced

pricingModel?: string

Property Value

string

product

Name of the product that has accrued charges by consumption or purchase as listed in the invoice. Not available for Marketplace.

product?: string

Property Value

string

productIdentifier

Identifier for the product that has accrued charges by consumption or purchase . This is the concatenated key of productId and SkuId in partner center.

productIdentifier?: string

Property Value

string

productOrderId

The identifier for the asset or Azure plan name that the subscription belongs to. For example: Azure Plan. 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

provider

Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c

provider?: string

Property Value

string

publisherId

Publisher Id.

publisherId?: string

Property Value

string

publisherName

Name of the publisher of the service including Microsoft or Third Party publishers.

publisherName?: string

Property Value

string

publisherType

Type of publisher that identifies if the publisher is first party, third party reseller or third party agency.

publisherType?: string

Property Value

string

quantity

Measure the quantity purchased or consumed.The amount of the meter used during the billing period.

quantity?: number

Property Value

number

resellerMpnId

MPNId for the reseller associated with the subscription.

resellerMpnId?: string

Property Value

string

resellerName

Reseller Name.

resellerName?: string

Property Value

string

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

Name of the Azure resource group used for cohesive lifecycle management of resources.

resourceGroup?: string

Property Value

string

resourceLocation

Name of the resource location.

resourceLocation?: string

Property Value

string

resourceLocationNormalized

Resource Location Normalized.

resourceLocationNormalized?: string

Property Value

string

serviceFamily

List the service family for the product purchased or charged (Example: Storage ; Compute).

serviceFamily?: 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

servicePeriodEndDate

End date for the period when the service usage was rated for charges. The prices for Azure services are determined based on the rating period.

servicePeriodEndDate?: Date

Property Value

Date

servicePeriodStartDate

Start date for the rating period when the service usage was rated for charges. The prices for Azure services are determined for the rating period.

servicePeriodStartDate?: Date

Property Value

Date

subscriptionGuid

Unique Microsoft generated identifier for the Azure Subscription.

subscriptionGuid?: string

Property Value

string

subscriptionName

Name of the Azure Subscription.

subscriptionName?: string

Property Value

string

term

Term (in months). Displays the term for the validity of the offer. For example. In case of reserved instances it displays 12 months for yearly term of reserved instance. For one time purchases or recurring purchases, the terms displays 1 month; This is not applicable for Azure consumption.

term?: string

Property Value

string

unitOfMeasure

Identifies the Unit that the service is charged in. For example, GB, hours, 10,000 s.

unitOfMeasure?: string

Property Value

string

unitPrice

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

unitPrice?: number

Property Value

number