ModernUsageDetail Class

Modern usage detail.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.consumption.models._models_py3.UsageDetail
ModernUsageDetail

Constructor

ModernUsageDetail(**kwargs)

Variables

Name Description
id
str

The full qualified ARM ID of an event.

name
str

The ID that uniquely identifies an event.

type
str

Resource type.

etag
str

The etag for the resource.

tags

A set of tags. Resource tags.

kind

Required. Specifies the kind of usage details.Constant filled by server. Known values are: "legacy", "modern".

billing_account_id
str

Billing Account identifier.

effective_price

Effective Price that's charged for the usage.

pricing_model

Identifier that indicates how the meter is priced. Known values are: "On Demand", "Reservation", "Spot".

billing_account_name
str

Name of the Billing Account.

billing_period_start_date

Billing Period Start Date as in the invoice.

billing_period_end_date

Billing Period End Date as in the invoice.

billing_profile_id
str

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.

billing_profile_name
str

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.

subscription_guid
str

Unique Microsoft generated identifier for the Azure Subscription.

subscription_name
str

Name of the Azure Subscription.

date

Date for the usage record.

product
str

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

meter_id
str

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.

meter_name
str

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

meter_region
str

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

meter_category
str

Identifies the top-level service for the usage.

meter_sub_category
str

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

service_family
str

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

quantity

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

unit_of_measure
str

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

instance_name
str

Instance Name.

cost_in_usd

Estimated extendedCost or blended cost before tax in USD.

unit_price

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

billing_currency_code
str

The currency defining the billed cost.

resource_location
str

Name of the resource location.

consumed_service
str

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

service_info1
str

Service-specific metadata.

service_info2
str

Legacy field with optional service-specific metadata.

additional_info
str

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.

invoice_section_id
str

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

invoice_section_name
str

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

cost_center
str

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

resource_group
str

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

reservation_id
str

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

reservation_name
str

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.

product_order_id
str

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.

product_order_name
str

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

is_azure_credit_eligible

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

term
str

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.

publisher_name
str

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

publisher_type
str

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

charge_type
str

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

frequency
str

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.

cost_in_billing_currency

ExtendedCost or blended cost before tax in billed currency.

cost_in_pricing_currency

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

exchange_rate
str

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

exchange_rate_date

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

invoice_id
str

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

previous_invoice_id
str

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

pricing_currency_code
str

Pricing Billing Currency.

product_identifier
str

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

resource_location_normalized
str

Resource Location Normalized.

service_period_start_date

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.

service_period_end_date

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.

customer_tenant_id
str

Identifier of the customer's AAD tenant.

customer_name
str

Name of the customer's AAD tenant.

partner_tenant_id
str

Identifier for the partner's AAD tenant.

partner_name
str

Name of the partner' AAD tenant.

reseller_mpn_id
str

MPNId for the reseller associated with the subscription.

reseller_name
str

Reseller Name.

publisher_id
str

Publisher Id.

market_price

Market Price that's charged for the usage.

exchange_rate_pricing_to_billing

Exchange Rate from pricing currency to billing currency.

payg_cost_in_billing_currency

The amount of PayG cost before tax in billing currency.

payg_cost_in_usd

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

partner_earned_credit_rate

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

partner_earned_credit_applied
str

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

pay_g_price

Retail price for the resource.

benefit_id
str

Unique identifier for the applicable benefit.

benefit_name
str

Name of the applicable benefit.

provider
str

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

cost_allocation_rule_name
str

Name for Cost Allocation Rule.