ModernUsageDetailProperties Class

Package:
com.azure.resourcemanager.consumption.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0
  • java.lang.Object
    • com.azure.resourcemanager.consumption.fluent.models.ModernUsageDetailProperties

Implements

JsonSerializable<ModernUsageDetailProperties>

public final class ModernUsageDetailProperties
implements JsonSerializable<ModernUsageDetailProperties>

The properties of the usage detail.

Constructor Summary

Constructor Description
ModernUsageDetailProperties()

Creates an instance of ModernUsageDetailProperties class.

Method Summary

Modifier and Type Method and Description
String additionalInfo()

Get the additionalInfo property: Additional details of this usage item.
String benefitId()

Get the benefitId property: Unique identifier for the applicable benefit.
String benefitName()

Get the benefitName property: Name of the applicable benefit.
String billingAccountId()

Get the billingAccountId property: Billing Account identifier.
String billingAccountName()

Get the billingAccountName property: Name of the Billing Account.
String billingCurrencyCode()

Get the billingCurrencyCode property: The currency defining the billed cost.
OffsetDateTime billingPeriodEndDate()

Get the billingPeriodEndDate property: Billing Period End Date as in the invoice.
OffsetDateTime billingPeriodStartDate()

Get the billingPeriodStartDate property: Billing Period Start Date as in the invoice.
String billingProfileId()

Get the billingProfileId property: 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.
String billingProfileName()

Get the billingProfileName property: 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.
String chargeType()

Get the chargeType property: Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.
String consumedService()

Get the consumedService property: Consumed service name.
String costAllocationRuleName()

Get the costAllocationRuleName property: Name for Cost Allocation Rule.
String costCenter()

Get the costCenter property: The cost center of this department if it is a department and a cost center is provided.
BigDecimal costInBillingCurrency()

Get the costInBillingCurrency property: ExtendedCost or blended cost before tax in billed currency.
BigDecimal costInPricingCurrency()

Get the costInPricingCurrency property: ExtendedCost or blended cost before tax in pricing currency to correlate with prices.
BigDecimal costInUsd()

Get the costInUsd property: Estimated extendedCost or blended cost before tax in USD.
String customerName()

Get the customerName property: Name of the customer's AAD tenant.
String customerTenantId()

Get the customerTenantId property: Identifier of the customer's AAD tenant.
OffsetDateTime date()

Get the date property: Date for the usage record.
BigDecimal effectivePrice()

Get the effectivePrice property: Effective Price that's charged for the usage.
String exchangeRate()

Get the exchangeRate property: Exchange rate used in conversion from pricing currency to billing currency.
OffsetDateTime exchangeRateDate()

Get the exchangeRateDate property: Date on which exchange rate used in conversion from pricing currency to billing currency.
BigDecimal exchangeRatePricingToBilling()

Get the exchangeRatePricingToBilling property: Exchange Rate from pricing currency to billing currency.
String frequency()

Get the frequency property: Indicates how frequently this charge will occur.
static ModernUsageDetailProperties fromJson(JsonReader jsonReader)

Reads an instance of ModernUsageDetailProperties from the JsonReader.
String instanceName()

Get the instanceName property: Instance Name.
String invoiceId()

Get the invoiceId property: Invoice ID as on the invoice where the specific transaction appears.
String invoiceSectionId()

Get the invoiceSectionId property: Identifier of the project that is being charged in the invoice.
String invoiceSectionName()

Get the invoiceSectionName property: Name of the project that is being charged in the invoice.
Boolean isAzureCreditEligible()

Get the isAzureCreditEligible property: Determines if the cost is eligible to be paid for using Azure credits.
BigDecimal marketPrice()

Get the marketPrice property: Market Price that's charged for the usage.
String meterCategory()

Get the meterCategory property: Identifies the top-level service for the usage.
UUID meterId()

Get the meterId property: The meter id (GUID).
String meterName()

Get the meterName property: Identifies the name of the meter against which consumption is measured.
String meterRegion()

Get the meterRegion property: Identifies the location of the datacenter for certain services that are priced based on datacenter location.
String meterSubCategory()

Get the meterSubCategory property: Defines the type or sub-category of Azure service that can affect the rate.
String partnerEarnedCreditApplied()

Get the partnerEarnedCreditApplied property: Flag to indicate if partner earned credit has been applied or not.
BigDecimal partnerEarnedCreditRate()

Get the partnerEarnedCreditRate property: Rate of discount applied if there is a partner earned credit (PEC) based on partner admin link access.
String partnerName()

Get the partnerName property: Name of the partner' AAD tenant.
String partnerTenantId()

Get the partnerTenantId property: Identifier for the partner's AAD tenant.
BigDecimal paygCostInBillingCurrency()

Get the paygCostInBillingCurrency property: The amount of PayG cost before tax in billing currency.
BigDecimal paygCostInUsd()

Get the paygCostInUsd property: The amount of PayG cost before tax in US Dollar currency.
BigDecimal payGPrice()

Get the payGPrice property: Retail price for the resource.
String previousInvoiceId()

Get the previousInvoiceId property: Reference to an original invoice there is a refund (negative cost).
String pricingCurrencyCode()

Get the pricingCurrencyCode property: Pricing Billing Currency.
PricingModelType pricingModel()

Get the pricingModel property: Identifier that indicates how the meter is priced.
String product()

Get the product property: Name of the product that has accrued charges by consumption or purchase as listed in the invoice.
String productIdentifier()

Get the productIdentifier property: Identifier for the product that has accrued charges by consumption or purchase .
String productOrderId()

Get the productOrderId property: The identifier for the asset or Azure plan name that the subscription belongs to.
String productOrderName()

Get the productOrderName property: Product Order Name.
String provider()

Get the provider property: Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c.
String publisherId()

Get the publisherId property: Publisher Id.
String publisherName()

Get the publisherName property: Name of the publisher of the service including Microsoft or Third Party publishers.
String publisherType()

Get the publisherType property: Type of publisher that identifies if the publisher is first party, third party reseller or third party agency.
BigDecimal quantity()

Get the quantity property: Measure the quantity purchased or consumed.The amount of the meter used during the billing period.
String resellerMpnId()

Get the resellerMpnId property: MPNId for the reseller associated with the subscription.
String resellerName()

Get the resellerName property: Reseller Name.
String reservationId()

Get the reservationId property: ARM resource id of the reservation.
String reservationName()

Get the reservationName property: User provided display name of the reservation.
String resourceGroup()

Get the resourceGroup property: Name of the Azure resource group used for cohesive lifecycle management of resources.
String resourceLocation()

Get the resourceLocation property: Name of the resource location.
String resourceLocationNormalized()

Get the resourceLocationNormalized property: Resource Location Normalized.
String serviceFamily()

Get the serviceFamily property: List the service family for the product purchased or charged (Example: Storage ; Compute).
String serviceInfo1()

Get the serviceInfo1 property: Service-specific metadata.
String serviceInfo2()

Get the serviceInfo2 property: Legacy field with optional service-specific metadata.
OffsetDateTime servicePeriodEndDate()

Get the servicePeriodEndDate property: End date for the period when the service usage was rated for charges.
OffsetDateTime servicePeriodStartDate()

Get the servicePeriodStartDate property: Start date for the rating period when the service usage was rated for charges.
String subscriptionGuid()

Get the subscriptionGuid property: Unique Microsoft generated identifier for the Azure Subscription.
String subscriptionName()

Get the subscriptionName property: Name of the Azure Subscription.
String term()

Get the term property: Term (in months).
JsonWriter toJson(JsonWriter jsonWriter)
String unitOfMeasure()

Get the unitOfMeasure property: Identifies the Unit that the service is charged in.
BigDecimal unitPrice()

Get the unitPrice property: Unit Price is the price applicable to you.
void validate()

Validates the instance.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ModernUsageDetailProperties

public ModernUsageDetailProperties()

Creates an instance of ModernUsageDetailProperties class.

Method Details

additionalInfo

public String additionalInfo()

Get the additionalInfo property: 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.

Returns:

the additionalInfo value.

benefitId

public String benefitId()

Get the benefitId property: Unique identifier for the applicable benefit.

Returns:

the benefitId value.

benefitName

public String benefitName()

Get the benefitName property: Name of the applicable benefit.

Returns:

the benefitName value.

billingAccountId

public String billingAccountId()

Get the billingAccountId property: Billing Account identifier.

Returns:

the billingAccountId value.

billingAccountName

public String billingAccountName()

Get the billingAccountName property: Name of the Billing Account.

Returns:

the billingAccountName value.

billingCurrencyCode

public String billingCurrencyCode()

Get the billingCurrencyCode property: The currency defining the billed cost.

Returns:

the billingCurrencyCode value.

billingPeriodEndDate

public OffsetDateTime billingPeriodEndDate()

Get the billingPeriodEndDate property: Billing Period End Date as in the invoice.

Returns:

the billingPeriodEndDate value.

billingPeriodStartDate

public OffsetDateTime billingPeriodStartDate()

Get the billingPeriodStartDate property: Billing Period Start Date as in the invoice.

Returns:

the billingPeriodStartDate value.

billingProfileId

public String billingProfileId()

Get the billingProfileId property: 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.

Returns:

the billingProfileId value.

billingProfileName

public String billingProfileName()

Get the billingProfileName property: 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.

Returns:

the billingProfileName value.

chargeType

public String chargeType()

Get the chargeType property: Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.

Returns:

the chargeType value.

consumedService

public String consumedService()

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

Returns:

the consumedService value.

costAllocationRuleName

public String costAllocationRuleName()

Get the costAllocationRuleName property: Name for Cost Allocation Rule.

Returns:

the costAllocationRuleName value.

costCenter

public String costCenter()

Get the costCenter property: The cost center of this department if it is a department and a cost center is provided.

Returns:

the costCenter value.

costInBillingCurrency

public BigDecimal costInBillingCurrency()

Get the costInBillingCurrency property: ExtendedCost or blended cost before tax in billed currency.

Returns:

the costInBillingCurrency value.

costInPricingCurrency

public BigDecimal costInPricingCurrency()

Get the costInPricingCurrency property: ExtendedCost or blended cost before tax in pricing currency to correlate with prices.

Returns:

the costInPricingCurrency value.

costInUsd

public BigDecimal costInUsd()

Get the costInUsd property: Estimated extendedCost or blended cost before tax in USD.

Returns:

the costInUsd value.

customerName

public String customerName()

Get the customerName property: Name of the customer's AAD tenant.

Returns:

the customerName value.

customerTenantId

public String customerTenantId()

Get the customerTenantId property: Identifier of the customer's AAD tenant.

Returns:

the customerTenantId value.

date

public OffsetDateTime date()

Get the date property: Date for the usage record.

Returns:

the date value.

effectivePrice

public BigDecimal effectivePrice()

Get the effectivePrice property: Effective Price that's charged for the usage.

Returns:

the effectivePrice value.

exchangeRate

public String exchangeRate()

Get the exchangeRate property: Exchange rate used in conversion from pricing currency to billing currency.

Returns:

the exchangeRate value.

exchangeRateDate

public OffsetDateTime exchangeRateDate()

Get the exchangeRateDate property: Date on which exchange rate used in conversion from pricing currency to billing currency.

Returns:

the exchangeRateDate value.

exchangeRatePricingToBilling

public BigDecimal exchangeRatePricingToBilling()

Get the exchangeRatePricingToBilling property: Exchange Rate from pricing currency to billing currency.

Returns:

the exchangeRatePricingToBilling value.

frequency

public String frequency()

Get the frequency property: 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.

Returns:

the frequency value.

fromJson

public static ModernUsageDetailProperties fromJson(JsonReader jsonReader)

Reads an instance of ModernUsageDetailProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ModernUsageDetailProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ModernUsageDetailProperties.

instanceName

public String instanceName()

Get the instanceName property: Instance Name.

Returns:

the instanceName value.

invoiceId

public String invoiceId()

Get the invoiceId property: Invoice ID as on the invoice where the specific transaction appears.

Returns:

the invoiceId value.

invoiceSectionId

public String invoiceSectionId()

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

Returns:

the invoiceSectionId value.

invoiceSectionName

public String invoiceSectionName()

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

Returns:

the invoiceSectionName value.

isAzureCreditEligible

public Boolean isAzureCreditEligible()

Get the isAzureCreditEligible property: Determines if the cost is eligible to be paid for using Azure credits.

Returns:

the isAzureCreditEligible value.

marketPrice

public BigDecimal marketPrice()

Get the marketPrice property: Market Price that's charged for the usage.

Returns:

the marketPrice value.

meterCategory

public String meterCategory()

Get the meterCategory property: Identifies the top-level service for the usage.

Returns:

the meterCategory value.

meterId

public UUID meterId()

Get the meterId property: 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.

Returns:

the meterId value.

meterName

public String meterName()

Get the meterName property: Identifies the name of the meter against which consumption is measured.

Returns:

the meterName value.

meterRegion

public String meterRegion()

Get the meterRegion property: Identifies the location of the datacenter for certain services that are priced based on datacenter location.

Returns:

the meterRegion value.

meterSubCategory

public String meterSubCategory()

Get the meterSubCategory property: Defines the type or sub-category of Azure service that can affect the rate.

Returns:

the meterSubCategory value.

partnerEarnedCreditApplied

public String partnerEarnedCreditApplied()

Get the partnerEarnedCreditApplied property: Flag to indicate if partner earned credit has been applied or not.

Returns:

the partnerEarnedCreditApplied value.

partnerEarnedCreditRate

public BigDecimal partnerEarnedCreditRate()

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

Returns:

the partnerEarnedCreditRate value.

partnerName

public String partnerName()

Get the partnerName property: Name of the partner' AAD tenant.

Returns:

the partnerName value.

partnerTenantId

public String partnerTenantId()

Get the partnerTenantId property: Identifier for the partner's AAD tenant.

Returns:

the partnerTenantId value.

paygCostInBillingCurrency

public BigDecimal paygCostInBillingCurrency()

Get the paygCostInBillingCurrency property: The amount of PayG cost before tax in billing currency.

Returns:

the paygCostInBillingCurrency value.

paygCostInUsd

public BigDecimal paygCostInUsd()

Get the paygCostInUsd property: The amount of PayG cost before tax in US Dollar currency.

Returns:

the paygCostInUsd value.

payGPrice

public BigDecimal payGPrice()

Get the payGPrice property: Retail price for the resource.

Returns:

the payGPrice value.

previousInvoiceId

public String previousInvoiceId()

Get the previousInvoiceId property: Reference to an original invoice there is a refund (negative cost). This is populated only when there is a refund.

Returns:

the previousInvoiceId value.

pricingCurrencyCode

public String pricingCurrencyCode()

Get the pricingCurrencyCode property: Pricing Billing Currency.

Returns:

the pricingCurrencyCode value.

pricingModel

public PricingModelType pricingModel()

Get the pricingModel property: Identifier that indicates how the meter is priced.

Returns:

the pricingModel value.

product

public String product()

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

Returns:

the product value.

productIdentifier

public String productIdentifier()

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

Returns:

the productIdentifier value.

productOrderId

public String productOrderId()

Get the productOrderId property: 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.

Returns:

the productOrderId value.

productOrderName

public String productOrderName()

Get the productOrderName property: Product Order Name. For reservations this is the SKU that was purchased.

Returns:

the productOrderName value.

provider

public String provider()

Get the provider property: Identifier for Product Category or Line Of Business, Ex - Azure, Microsoft 365, AWS e.t.c.

Returns:

the provider value.

publisherId

public String publisherId()

Get the publisherId property: Publisher Id.

Returns:

the publisherId value.

publisherName

public String publisherName()

Get the publisherName property: Name of the publisher of the service including Microsoft or Third Party publishers.

Returns:

the publisherName value.

publisherType

public String publisherType()

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

Returns:

the publisherType value.

quantity

public BigDecimal quantity()

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

Returns:

the quantity value.

resellerMpnId

public String resellerMpnId()

Get the resellerMpnId property: MPNId for the reseller associated with the subscription.

Returns:

the resellerMpnId value.

resellerName

public String resellerName()

Get the resellerName property: Reseller Name.

Returns:

the resellerName value.

reservationId

public String reservationId()

Get the reservationId property: ARM resource id of the reservation. Only applies to records relevant to reservations.

Returns:

the reservationId value.

reservationName

public String reservationName()

Get the reservationName property: 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.

Returns:

the reservationName value.

resourceGroup

public String resourceGroup()

Get the resourceGroup property: Name of the Azure resource group used for cohesive lifecycle management of resources.

Returns:

the resourceGroup value.

resourceLocation

public String resourceLocation()

Get the resourceLocation property: Name of the resource location.

Returns:

the resourceLocation value.

resourceLocationNormalized

public String resourceLocationNormalized()

Get the resourceLocationNormalized property: Resource Location Normalized.

Returns:

the resourceLocationNormalized value.

serviceFamily

public String serviceFamily()

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

Returns:

the serviceFamily value.

serviceInfo1

public String serviceInfo1()

Get the serviceInfo1 property: Service-specific metadata.

Returns:

the serviceInfo1 value.

serviceInfo2

public String serviceInfo2()

Get the serviceInfo2 property: Legacy field with optional service-specific metadata.

Returns:

the serviceInfo2 value.

servicePeriodEndDate

public OffsetDateTime servicePeriodEndDate()

Get the servicePeriodEndDate property: 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.

Returns:

the servicePeriodEndDate value.

servicePeriodStartDate

public OffsetDateTime servicePeriodStartDate()

Get the servicePeriodStartDate property: 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.

Returns:

the servicePeriodStartDate value.

subscriptionGuid

public String subscriptionGuid()

Get the subscriptionGuid property: Unique Microsoft generated identifier for the Azure Subscription.

Returns:

the subscriptionGuid value.

subscriptionName

public String subscriptionName()

Get the subscriptionName property: Name of the Azure Subscription.

Returns:

the subscriptionName value.

term

public String term()

Get the term property: 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.

Returns:

the term value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

unitOfMeasure

public String unitOfMeasure()

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

Returns:

the unitOfMeasure value.

unitPrice

public BigDecimal unitPrice()

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

Returns:

the unitPrice value.

validate

public void validate()

Validates the instance.

Applies to