ModernUsageDetail interface
Modern usage detail.
- Extends
Properties
additional |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
benefit |
Unique identifier for the applicable benefit. NOTE: This property will not be serialized. It can only be populated by the server. |
benefit |
Name of the applicable benefit. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
Billing Account identifier. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
Name of the Billing Account. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
The currency defining the billed cost. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
Billing Period End Date as in the invoice. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
Billing Period Start Date as in the invoice. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
billing |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
charge |
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. |
consumed |
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 |
Name for Cost Allocation Rule. NOTE: This property will not be serialized. It can only be populated by the server. |
cost |
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. |
cost |
ExtendedCost or blended cost before tax in billed currency. NOTE: This property will not be serialized. It can only be populated by the server. |
cost |
ExtendedCost or blended cost before tax in pricing currency to correlate with prices. NOTE: This property will not be serialized. It can only be populated by the server. |
cost |
Estimated extendedCost or blended cost before tax in USD. NOTE: This property will not be serialized. It can only be populated by the server. |
customer |
Name of the customer's AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server. |
customer |
Identifier of the customer's AAD tenant. 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. |
effective |
Effective Price that's charged for the usage. NOTE: This property will not be serialized. It can only be populated by the server. |
exchange |
Exchange rate used in conversion from pricing currency to billing currency. NOTE: This property will not be serialized. It can only be populated by the server. |
exchange |
Date on which exchange rate used in conversion from pricing currency to billing currency. NOTE: This property will not be serialized. It can only be populated by the server. |
exchange |
Exchange Rate from pricing currency to billing currency. 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. |
instance |
Instance Name. NOTE: This property will not be serialized. It can only be populated by the server. |
invoice |
Invoice ID as on the invoice where the specific transaction appears. NOTE: This property will not be serialized. It can only be populated by the server. |
invoice |
Identifier of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners. NOTE: This property will not be serialized. It can only be populated by the server. |
invoice |
Name of the project that is being charged in the invoice. Not applicable for Microsoft Customer Agreements onboarded by partners. NOTE: This property will not be serialized. It can only be populated by the server. |
is |
Determines if the cost is eligible to be paid for using Azure credits. 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 |
market |
Market Price that's charged for the usage. NOTE: This property will not be serialized. It can only be populated by the server. |
meter |
Identifies the top-level service for the usage. NOTE: This property will not be serialized. It can only be populated by the server. |
meter |
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. |
meter |
Identifies the name of the meter against which consumption is measured. NOTE: This property will not be serialized. It can only be populated by the server. |
meter |
Identifies the location of the datacenter for certain services that are priced based on datacenter location. NOTE: This property will not be serialized. It can only be populated by the server. |
meter |
Defines the type or sub-category of Azure service that can affect the rate. NOTE: This property will not be serialized. It can only be populated by the server. |
partner |
Flag to indicate if partner earned credit has been applied or not. NOTE: This property will not be serialized. It can only be populated by the server. |
partner |
Rate of discount applied if there is a partner earned credit (PEC) based on partner admin link access. NOTE: This property will not be serialized. It can only be populated by the server. |
partner |
Name of the partner' AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server. |
partner |
Identifier for the partner's AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server. |
payg |
The amount of PayG cost before tax in billing currency. NOTE: This property will not be serialized. It can only be populated by the server. |
payg |
The amount of PayG cost before tax in US Dollar currency. NOTE: This property will not be serialized. It can only be populated by the server. |
pay |
Retail price for the resource. NOTE: This property will not be serialized. It can only be populated by the server. |
previous |
Reference to an original invoice there is a refund (negative cost). This is populated only when there is a refund. NOTE: This property will not be serialized. It can only be populated by the server. |
pricing |
Pricing Billing Currency. NOTE: This property will not be serialized. It can only be populated by the server. |
pricing |
Identifier that indicates how the meter is priced NOTE: This property will not be serialized. It can only be populated by the server. |
product | Name of the product that has accrued charges by consumption or purchase as listed in the invoice. Not available for Marketplace. NOTE: This property will not be serialized. It can only be populated by the server. |
product |
Identifier for the product that has accrued charges by consumption or purchase . This is the concatenated key of productId and SkuId in partner center. NOTE: This property will not be serialized. It can only be populated by the server. |
product |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
product |
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. |
provider | Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c NOTE: This property will not be serialized. It can only be populated by the server. |
publisher |
Publisher Id. NOTE: This property will not be serialized. It can only be populated by the server. |
publisher |
Name of the publisher of the service including Microsoft or Third Party publishers. NOTE: This property will not be serialized. It can only be populated by the server. |
publisher |
Type of publisher that identifies if the publisher is first party, third party reseller or third party agency. NOTE: This property will not be serialized. It can only be populated by the server. |
quantity | Measure the quantity purchased or consumed.The amount of the meter used during the billing period. NOTE: This property will not be serialized. It can only be populated by the server. |
reseller |
MPNId for the reseller associated with the subscription. NOTE: This property will not be serialized. It can only be populated by the server. |
reseller |
Reseller Name. NOTE: This property will not be serialized. It can only be populated by the server. |
reservation |
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. |
reservation |
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. |
resource |
Name of the Azure resource group used for cohesive lifecycle management of resources. NOTE: This property will not be serialized. It can only be populated by the server. |
resource |
Name of the resource location. NOTE: This property will not be serialized. It can only be populated by the server. |
resource |
Resource Location Normalized. NOTE: This property will not be serialized. It can only be populated by the server. |
service |
List the service family for the product purchased or charged (Example: Storage ; Compute). NOTE: This property will not be serialized. It can only be populated by the server. |
service |
Service-specific metadata. NOTE: This property will not be serialized. It can only be populated by the server. |
service |
Legacy field with optional service-specific metadata. NOTE: This property will not be serialized. It can only be populated by the server. |
service |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
service |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
subscription |
Unique Microsoft generated identifier for the Azure Subscription. NOTE: This property will not be serialized. It can only be populated by the server. |
subscription |
Name of the Azure Subscription. NOTE: This property will not be serialized. It can only be populated by the server. |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
unit |
Identifies the Unit that the service is charged in. For example, GB, hours, 10,000 s. NOTE: This property will not be serialized. It can only be populated by the server. |
unit |
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
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. NOTE: This property will not be serialized. It can only be populated by the server.
additionalInfo?: string
Property Value
string
benefitId
Unique identifier for the applicable benefit. NOTE: This property will not be serialized. It can only be populated by the server.
benefitId?: string
Property Value
string
benefitName
Name of the applicable benefit. NOTE: This property will not be serialized. It can only be populated by the server.
benefitName?: 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
Name of the Billing Account. NOTE: This property will not be serialized. It can only be populated by the server.
billingAccountName?: string
Property Value
string
billingCurrencyCode
The currency defining the billed cost. NOTE: This property will not be serialized. It can only be populated by the server.
billingCurrencyCode?: string
Property Value
string
billingPeriodEndDate
Billing Period End Date as in the invoice. NOTE: This property will not be serialized. It can only be populated by the server.
billingPeriodEndDate?: Date
Property Value
Date
billingPeriodStartDate
Billing Period Start Date as in the invoice. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. 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
costAllocationRuleName
Name for Cost Allocation Rule. NOTE: This property will not be serialized. It can only be populated by the server.
costAllocationRuleName?: string
Property Value
string
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
costInBillingCurrency
ExtendedCost or blended cost before tax in billed currency. NOTE: This property will not be serialized. It can only be populated by the server.
costInBillingCurrency?: number
Property Value
number
costInPricingCurrency
ExtendedCost or blended cost before tax in pricing currency to correlate with prices. NOTE: This property will not be serialized. It can only be populated by the server.
costInPricingCurrency?: number
Property Value
number
costInUSD
Estimated extendedCost or blended cost before tax in USD. NOTE: This property will not be serialized. It can only be populated by the server.
costInUSD?: number
Property Value
number
customerName
Name of the customer's AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server.
customerName?: string
Property Value
string
customerTenantId
Identifier of the customer's AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server.
customerTenantId?: 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
exchangeRate
Exchange rate used in conversion from pricing currency to billing currency. NOTE: This property will not be serialized. It can only be populated by the server.
exchangeRate?: string
Property Value
string
exchangeRateDate
Date on which exchange rate used in conversion from pricing currency to billing currency. NOTE: This property will not be serialized. It can only be populated by the server.
exchangeRateDate?: Date
Property Value
Date
exchangeRatePricingToBilling
Exchange Rate from pricing currency to billing currency. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
frequency?: string
Property Value
string
instanceName
Instance Name. NOTE: This property will not be serialized. It can only be populated by the server.
instanceName?: string
Property Value
string
invoiceId
Invoice ID as on the invoice where the specific transaction appears. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
invoiceSectionName?: string
Property Value
string
isAzureCreditEligible
Determines if the cost is eligible to be paid for using Azure credits. 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: "modern"
Property Value
"modern"
marketPrice
Market Price that's charged for the usage. NOTE: This property will not be serialized. It can only be populated by the server.
marketPrice?: number
Property Value
number
meterCategory
Identifies the top-level service for the usage. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
meterId?: string
Property Value
string
meterName
Identifies the name of the meter against which consumption is measured. NOTE: This property will not be serialized. It can only be populated by the server.
meterName?: string
Property Value
string
meterRegion
Identifies the location of the datacenter for certain services that are priced based on datacenter location. NOTE: This property will not be serialized. It can only be populated by the server.
meterRegion?: string
Property Value
string
meterSubCategory
Defines the type or sub-category of Azure service that can affect the rate. NOTE: This property will not be serialized. It can only be populated by the server.
meterSubCategory?: string
Property Value
string
partnerEarnedCreditApplied
Flag to indicate if partner earned credit has been applied or not. NOTE: This property will not be serialized. It can only be populated by the server.
partnerEarnedCreditApplied?: string
Property Value
string
partnerEarnedCreditRate
Rate of discount applied if there is a partner earned credit (PEC) based on partner admin link access. NOTE: This property will not be serialized. It can only be populated by the server.
partnerEarnedCreditRate?: number
Property Value
number
partnerName
Name of the partner' AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server.
partnerName?: string
Property Value
string
partnerTenantId
Identifier for the partner's AAD tenant. NOTE: This property will not be serialized. It can only be populated by the server.
partnerTenantId?: string
Property Value
string
paygCostInBillingCurrency
The amount of PayG cost before tax in billing currency. NOTE: This property will not be serialized. It can only be populated by the server.
paygCostInBillingCurrency?: number
Property Value
number
paygCostInUSD
The amount of PayG cost before tax in US Dollar currency. NOTE: This property will not be serialized. It can only be populated by the server.
paygCostInUSD?: number
Property Value
number
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
previousInvoiceId
Reference to an original invoice there is a refund (negative cost). This is populated only when there is a refund. NOTE: This property will not be serialized. It can only be populated by the server.
previousInvoiceId?: string
Property Value
string
pricingCurrencyCode
Pricing Billing Currency. NOTE: This property will not be serialized. It can only be populated by the server.
pricingCurrencyCode?: 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
Name of the product that has accrued charges by consumption or purchase as listed in the invoice. Not available for Marketplace. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. 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
provider
Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c NOTE: This property will not be serialized. It can only be populated by the server.
provider?: string
Property Value
string
publisherId
Publisher Id. NOTE: This property will not be serialized. It can only be populated by the server.
publisherId?: string
Property Value
string
publisherName
Name of the publisher of the service including Microsoft or Third Party publishers. NOTE: This property will not be serialized. It can only be populated by the server.
publisherName?: string
Property Value
string
publisherType
Type of publisher that identifies if the publisher is first party, third party reseller or third party agency. NOTE: This property will not be serialized. It can only be populated by the server.
publisherType?: string
Property Value
string
quantity
Measure the quantity purchased or consumed.The amount of the meter used during the billing period. NOTE: This property will not be serialized. It can only be populated by the server.
quantity?: number
Property Value
number
resellerMpnId
MPNId for the reseller associated with the subscription. NOTE: This property will not be serialized. It can only be populated by the server.
resellerMpnId?: string
Property Value
string
resellerName
Reseller Name. NOTE: This property will not be serialized. It can only be populated by the server.
resellerName?: string
Property Value
string
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
Name of the Azure resource group used for cohesive lifecycle management of resources. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGroup?: string
Property Value
string
resourceLocation
Name of the resource location. NOTE: This property will not be serialized. It can only be populated by the server.
resourceLocation?: string
Property Value
string
resourceLocationNormalized
Resource Location Normalized. NOTE: This property will not be serialized. It can only be populated by the server.
resourceLocationNormalized?: string
Property Value
string
serviceFamily
List the service family for the product purchased or charged (Example: Storage ; Compute). NOTE: This property will not be serialized. It can only be populated by the server.
serviceFamily?: 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
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
servicePeriodStartDate?: Date
Property Value
Date
subscriptionGuid
Unique Microsoft generated identifier for the Azure Subscription. NOTE: This property will not be serialized. It can only be populated by the server.
subscriptionGuid?: string
Property Value
string
subscriptionName
Name of the Azure Subscription. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
term?: string
Property Value
string
unitOfMeasure
Identifies the Unit that the service is charged in. For example, GB, hours, 10,000 s. NOTE: This property will not be serialized. It can only be populated by the server.
unitOfMeasure?: 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