# azure.mgmt.consumption.models module

exception `azure.mgmt.consumption.models.``ErrorResponseException`(deserialize, response, *args)

  Bases: `msrest.exceptions.HttpOperationError`

  Server responsed with exception of type: ‘ErrorResponse’.

  Parameters:

  - deserialize – A deserializer
  - response – Server response to be deserialized.

class `azure.mgmt.consumption.models.``MeterDetails`(**kwargs)

  Bases: `msrest.serialization.Model`

  The properties of the meter detail.

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

  Variables:

  - meter_name (str) – The name of the meter, within the given meter category
  - meter_category (str) – The category of the meter, for example, ‘Cloud services’, ‘Networking’, etc..
  - meter_sub_category (str) – The subcategory of the meter, for example, ‘A6 Cloud services’, ‘ExpressRoute (IXP)’, etc..
  - unit (str) – The unit in which the meter consumption is charged, for example, ‘Hours’, ‘GB’, etc.
  - meter_location (str) – The location in which the Azure service is available.
  - total_included_quantity (decimal.Decimal) – The total included quantity associated with the offer.
  - pretax_standard_rate (decimal.Decimal) – The pretax listing price.
  - service_name (str) – The name of the service.
  - service_tier (str) – The service tier.

class `azure.mgmt.consumption.models.``MeterDetailsResponse`(**kwargs)

  Bases: `msrest.serialization.Model`

  The properties of the meter detail.

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

  Variables:

  - meter_name (str) – The name of the meter, within the given meter category
  - meter_category (str) – The category of the meter, for example, ‘Cloud services’, ‘Networking’, etc..
  - meter_sub_category (str) – The subcategory of the meter, for example, ‘A6 Cloud services’, ‘ExpressRoute (IXP)’, etc..
  - unit_of_measure (str) – The unit in which the meter consumption is charged, for example, ‘Hours’, ‘GB’, etc.
  - service_family (str) – The service family.

class `azure.mgmt.consumption.models.``UsageDetail`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  An usage detail resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - billing_account_id (str) – Billing Account identifier.
  - billing_account_name (str) – Billing Account Name.
  - billing_period_start_date (datetime) – The billing period start date.
  - billing_period_end_date (datetime) – The billing period end date.
  - billing_profile_id (str) – Billing Profile identifier.
  - billing_profile_name (str) – Billing Profile Name.
  - account_owner_id (str) – Account Owner Id.
  - account_name (str) – Account Name.
  - subscription_id (str) – Subscription guid.
  - subscription_name (str) – Subscription name.
  - date_property (datetime) – Date for the usage record.
  - product (str) – Product name for the consumed service or purchase. Not available for Marketplace.
  - part_number (str) – Part Number of the service used. Can be used to join with the price sheet. 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_details (MeterDetailsResponse) – The details about the meter. By default this is not populated, unless it’s specified in $expand.
  - quantity (decimal.Decimal) – The usage quantity.
  - effective_price (decimal.Decimal) – Effective Price that’s charged for the usage.
  - cost (decimal.Decimal) – The amount of cost before tax.
  - unit_price (decimal.Decimal) – Unit Price is the price applicable to you. (your EA or other contract price).
  - billing_currency (str) – Billing Currency.
  - resource_location (str) – 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.
  - resource_id (str) – Azure resource manager resource identifier.
  - resource_name (str) – Resource Name.
  - service_info1 (str) – Service Info 1.
  - service_info2 (str) – Service Info 2.
  - additional_info (str) – 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.
  - invoice_section (str) – Invoice Section Name.
  - cost_center (str) – The cost center of this department if it is a department and a cost center is provided.
  - resource_group (str) – Resource Group Name.
  - 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) – Product Order Id. For reservations this is the Reservation Order ID.
  - product_order_name (str) – Product Order Name. For reservations this is the SKU that was purchased.
  - offer_id (str) – Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.
  - is_azure_credit_eligible (bool) – Is Azure Credit Eligible.
  - term (str) – Term (in months). 1 month for monthly recurring purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation.
  - publisher_name (str) – Publisher Name.
  - publisher_type (str) – Publisher Type.
  - plan_name (str) – Plan Name.
  - 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.

class `azure.mgmt.consumption.models.``UsageDetailsDownloadResponse`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  Download response of Usage Details.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - download_url (str) – The URL to the csv file.
  - valid_till (str) – The time in UTC at which this download URL will expire.

class `azure.mgmt.consumption.models.``Marketplace`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  An marketplace resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - billing_period_id (str) – The id of the billing period resource that the usage belongs to.
  - usage_start (datetime) – The start of the date time range covered by the usage detail.
  - usage_end (datetime) – The end of the date time range covered by the usage detail.
  - resource_rate (decimal.Decimal) – The marketplace resource rate.
  - offer_name (str) – The type of offer.
  - resource_group (str) – The name of resource group.
  - order_number (str) – The order number.
  - instance_name (str) – The name of the resource instance that the usage is about.
  - instance_id (str) – The uri of the resource instance that the usage is about.
  - currency (str) – The ISO currency in which the meter is charged, for example, USD.
  - consumed_quantity (decimal.Decimal) – The quantity of usage.
  - unit_of_measure (str) – The unit of measure.
  - pretax_cost (decimal.Decimal) – The amount of cost before tax.
  - is_estimated (bool) – The estimated usage is subject to change.
  - meter_id (str) – The meter id (GUID).
  - subscription_guid (str) – Subscription guid.
  - subscription_name (str) – Subscription name.
  - account_name (str) – Account name.
  - department_name (str) – Department name.
  - consumed_service (str) – Consumed service name.
  - cost_center (str) – The cost center of this department if it is a department and a costcenter exists
  - additional_properties (str) – Additional details of this usage item. By default this is not populated, unless it’s specified in $expand.
  - publisher_name (str) – The name of publisher.
  - plan_name (str) – The name of plan.
  - is_recurring_charge (bool) – Flag indicating whether this is a recurring charge or not.

class `azure.mgmt.consumption.models.``BalancePropertiesNewPurchasesDetailsItem`(**kwargs)

  Bases: `msrest.serialization.Model`

  BalancePropertiesNewPurchasesDetailsItem.

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

  Variables:

  - name (str) – the name of new purchase.
  - value (decimal.Decimal) – the value of new purchase.

class `azure.mgmt.consumption.models.``BalancePropertiesAdjustmentDetailsItem`(**kwargs)

  Bases: `msrest.serialization.Model`

  BalancePropertiesAdjustmentDetailsItem.

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

  Variables:

  - name (str) – the name of new adjustment.
  - value (decimal.Decimal) – the value of new adjustment.

class `azure.mgmt.consumption.models.``Balance`(*, billing_frequency=None, **kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  A balance resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - currency (str) – The ISO currency in which the meter is charged, for example, USD.
  - beginning_balance (decimal.Decimal) – The beginning balance for the billing period.
  - ending_balance (decimal.Decimal) – The ending balance for the billing period (for open periods this will be updated daily).
  - new_purchases (decimal.Decimal) – Total new purchase amount.
  - adjustments (decimal.Decimal) – Total adjustment amount.
  - utilized (decimal.Decimal) – Total Commitment usage.
  - service_overage (decimal.Decimal) – Overage for Azure services.
  - charges_billed_separately (decimal.Decimal) – Charges Billed separately.
  - total_overage (decimal.Decimal) – serviceOverage + chargesBilledSeparately.
  - total_usage (decimal.Decimal) – Azure service commitment + total Overage.
  - azure_marketplace_service_charges (decimal.Decimal) – Total charges for Azure Marketplace.
  - price_hidden (bool) – Price is hidden or not.
  - new_purchases_details (list[BalancePropertiesNewPurchasesDetailsItem]) – List of new purchases.
  - adjustment_details (list[BalancePropertiesAdjustmentDetailsItem]) – List of Adjustments (Promo credit, SIE credit etc.).

  Parameters: | billing_frequency (str or BillingFrequency) – The billing frequency. Possible values include: ‘Month’, ‘Quarter’, ‘Year’

class `azure.mgmt.consumption.models.``ReservationSummary`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  reservation summary resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - reservation_order_id (str) – The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.
  - reservation_id (str) – The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.
  - sku_name (str) – This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
  - reserved_hours (decimal.Decimal) – This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days
  - usage_date (datetime) – Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.
  - used_hours (decimal.Decimal) – Total used hours by the reservation
  - min_utilization_percentage (decimal.Decimal) – This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day
  - avg_utilization_percentage (decimal.Decimal) – This is average utilization for the entire time range. (day or month depending on the grain)
  - max_utilization_percentage (decimal.Decimal) – This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.

class `azure.mgmt.consumption.models.``ReservationDetail`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  reservation detail resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - reservation_order_id (str) – The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.
  - reservation_id (str) – The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.
  - sku_name (str) – This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
  - reserved_hours (decimal.Decimal) – This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.
  - usage_date (datetime) – The date on which consumption occurred.
  - used_hours (decimal.Decimal) – This is the total hours used by the instance.
  - instance_id (str) – This identifier is the name of the resource or the fully qualified Resource ID.
  - total_reserved_quantity (decimal.Decimal) – This is the total count of instances that are reserved for the reservationId.

class `azure.mgmt.consumption.models.``ReservationRecommendation`(**kwargs)

  Bases: `msrest.serialization.Model`

  Reservation recommendation resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - location (str) – Resource location
  - sku (str) – Resource sku
  - look_back_period (str) – The number of days of usage to look back for recommendation.
  - meter_id (str) – The meter id (GUID)
  - term (str) – RI recommendations in one or three year terms.
  - cost_with_no_reserved_instances (decimal.Decimal) – The total amount of cost without reserved instances.
  - recommended_quantity (decimal.Decimal) – Recommended quality for reserved instances.
  - total_cost_with_reserved_instances (decimal.Decimal) – The total amount of cost with reserved instances.
  - net_savings (decimal.Decimal) – Total estimated savings with reserved instances.
  - first_usage_date (datetime) – The usage date for looking back.
  - scope (str) – Shared or single recommendation.

class `azure.mgmt.consumption.models.``Tag`(*, key: str = None, **kwargs)

  Bases: `msrest.serialization.Model`

  The tag resource.

  Parameters: | key (str) – Tag key.

class `azure.mgmt.consumption.models.``TagsResult`(*, e_tag: str = None, tags=None, **kwargs)

  Bases: `azure.mgmt.consumption.models.proxy_resource_py3.ProxyResource`

  A resource listing all tags.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.

  Parameters:

  - e_tag (str) – eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
  - tags (list[Tag]) – A list of Tag.

class `azure.mgmt.consumption.models.``BudgetTimePeriod`(*, start_date, end_date=None, **kwargs)

  Bases: `msrest.serialization.Model`

  The start and end date for a budget.

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

  Parameters:

  - start_date (datetime) – Required. The start date for the budget.
  - end_date (datetime) – The end date for the budget. If not provided, we default this to 10 years from the start date.

class `azure.mgmt.consumption.models.``Filters`(*, resource_groups=None, resources=None, meters=None, tags=None, **kwargs)

  Bases: `msrest.serialization.Model`

  May be used to filter budgets by resource group, resource, or meter.

  Parameters:

  - resource_groups (list[str]) – The list of filters on resource groups, allowed at subscription level only.
  - resources (list[str]) – The list of filters on resources.
  - meters (list[str]) – The list of filters on meters (GUID), mandatory for budgets of usage category.
  - tags (dict[str, list[str]]) – The dictionary of filters on tags.

class `azure.mgmt.consumption.models.``CurrentSpend`(**kwargs)

  Bases: `msrest.serialization.Model`

  The current amount of cost which is being tracked for a budget.

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

  Variables:

  - amount (decimal.Decimal) – The total amount of cost which is being tracked by the budget.
  - unit (str) – The unit of measure for the budget amount.

class `azure.mgmt.consumption.models.``Notification`(*, enabled: bool, operator, threshold, contact_emails, contact_roles=None, contact_groups=None, **kwargs)

  Bases: `msrest.serialization.Model`

  The notification associated with a budget.

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

  Parameters:

  - enabled (bool) – Required. The notification is enabled or not.
  - operator (str or OperatorType) – Required. The comparison operator. Possible values include: ‘EqualTo’, ‘GreaterThan’, ‘GreaterThanOrEqualTo’
  - threshold (decimal.Decimal) – Required. Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
  - contact_emails (list[str]) – Required. Email addresses to send the budget notification to when the threshold is exceeded.
  - contact_roles (list[str]) – Contact roles to send the budget notification to when the threshold is exceeded.
  - contact_groups (list[str]) – Action groups to send the budget notification to when the threshold is exceeded.

class `azure.mgmt.consumption.models.``Budget`(*, category, amount, time_grain, time_period, e_tag: str = None, filters=None, notifications=None, **kwargs)

  Bases: `azure.mgmt.consumption.models.proxy_resource_py3.ProxyResource`

  A budget resource.

  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.

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - current_spend (CurrentSpend) – The current amount of cost which is being tracked for a budget.

  Parameters:

  - e_tag (str) – eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
  - category (str or CategoryType) – Required. The category of the budget, whether the budget tracks cost or usage. Possible values include: ‘Cost’, ‘Usage’
  - amount (decimal.Decimal) – Required. The total amount of cost to track with the budget
  - time_grain (str or TimeGrainType) – Required. The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values include: ‘Monthly’, ‘Quarterly’, ‘Annually’
  - time_period (BudgetTimePeriod) – Required. Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.
  - filters (Filters) – May be used to filter budgets by resource group, resource, or meter.
  - notifications (dict[str, Notification]) – Dictionary of notifications associated with the budget. Budget can have up to five notifications.

class `azure.mgmt.consumption.models.``PriceSheetProperties`(**kwargs)

  Bases: `msrest.serialization.Model`

  The properties of the price sheet.

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

  Variables:

  - billing_period_id (str) – The id of the billing period resource that the usage belongs to.
  - meter_id (str) – The meter id (GUID)
  - meter_details (MeterDetails) – The details about the meter. By default this is not populated, unless it’s specified in $expand.
  - unit_of_measure (str) – Unit of measure
  - included_quantity (decimal.Decimal) – Included quality for an offer
  - part_number (str) – Part Number
  - unit_price (decimal.Decimal) – Unit Price
  - currency_code (str) – Currency Code
  - offer_id (str) – Offer Id

class `azure.mgmt.consumption.models.``PriceSheetResult`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  An pricesheet resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - pricesheets (list[PriceSheetProperties]) – Price sheet
  - next_link (str) – The link (url) to the next page of results.

class `azure.mgmt.consumption.models.``ForecastPropertiesConfidenceLevelsItem`(*, bound=None, **kwargs)

  Bases: `msrest.serialization.Model`

  ForecastPropertiesConfidenceLevelsItem.

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

  Variables:

  - percentage (decimal.Decimal) – The percentage level of the confidence
  - value (decimal.Decimal) – The amount of forecast within the percentage level

  Parameters: | bound (str or Bound) – The boundary of the percentage, values could be ‘Upper’ or ‘Lower’. Possible values include: ‘Upper’, ‘Lower’

class `azure.mgmt.consumption.models.``Forecast`(*, grain=None, charge_type=None, **kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  A forecast resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - usage_date (str) – The usage date of the forecast.
  - charge (decimal.Decimal) – The amount of charge
  - currency (str) – The ISO currency in which the meter is charged, for example, USD.
  - confidence_levels (list[ForecastPropertiesConfidenceLevelsItem]) – The details about the forecast confidence levels. This is populated only when chargeType is Forecast.

  Parameters:

  - grain (str or Grain) – The granularity of forecast. Possible values include: ‘Daily’, ‘Monthly’, ‘Yearly’
  - charge_type (str or ChargeType) – The type of the charge. Could be actual or forecast. Possible values include: ‘Actual’, ‘Forecast’

class `azure.mgmt.consumption.models.``ManagementGroupAggregatedCostResult`(*, children=None, included_subscriptions=None, excluded_subscriptions=None, **kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  A management group aggregated cost resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - billing_period_id (str) – The id of the billing period resource that the aggregated cost belongs to.
  - usage_start (datetime) – The start of the date time range covered by aggregated cost.
  - usage_end (datetime) – The end of the date time range covered by the aggregated cost.
  - azure_charges (decimal.Decimal) – Azure Charges.
  - marketplace_charges (decimal.Decimal) – Marketplace Charges.
  - charges_billed_separately (decimal.Decimal) – Charges Billed Separately.
  - currency (str) – The ISO currency in which the meter is charged, for example, USD.

  Parameters:

  - children (list[ManagementGroupAggregatedCostResult]) – Children of a management group
  - included_subscriptions (list[str]) – List of subscription Guids included in the calculation of aggregated cost
  - excluded_subscriptions (list[str]) – List of subscription Guids excluded from the calculation of aggregated cost

class `azure.mgmt.consumption.models.``ChargeSummary`(**kwargs)

  Bases: `azure.mgmt.consumption.models.resource_py3.Resource`

  A charge summary resource.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.
  - billing_period_id (str) – The id of the billing period resource that the charge belongs to.
  - usage_start (str) – Usage start date.
  - usage_end (str) – Usage end date.
  - azure_charges (decimal.Decimal) – Azure Charges.
  - charges_billed_separately (decimal.Decimal) – Charges Billed separately.
  - marketplace_charges (decimal.Decimal) – Marketplace Charges.
  - currency (str) – Currency Code

class `azure.mgmt.consumption.models.``ChargesListResult`(**kwargs)

  Bases: `msrest.serialization.Model`

  Result of listing charge summary.

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

  Variables: | value (list[ChargeSummary]) – The list of charge summary

class `azure.mgmt.consumption.models.``ErrorDetails`(**kwargs)

  Bases: `msrest.serialization.Model`

  The details of the error.

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

  Variables:

  - code (str) – Error code.
  - message (str) – Error message indicating why the operation failed.

class `azure.mgmt.consumption.models.``ErrorResponse`(*, error=None, **kwargs)

  Bases: `msrest.serialization.Model`

  Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

  Parameters: | error (ErrorDetails) – The details of the error.

class `azure.mgmt.consumption.models.``OperationDisplay`(**kwargs)

  Bases: `msrest.serialization.Model`

  The object that represents the operation.

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

  Variables:

  - provider (str) – Service provider: Microsoft.Consumption.
  - resource (str) – Resource on which the operation is performed: UsageDetail, etc.
  - operation (str) – Operation type: Read, write, delete, etc.

class `azure.mgmt.consumption.models.``Operation`(*, display=None, **kwargs)

  Bases: `msrest.serialization.Model`

  A Consumption REST API operation.

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

  Variables: | name (str) – Operation name: {provider}/{resource}/{operation}.
  Parameters: | display (OperationDisplay) – The object that represents the operation.

class `azure.mgmt.consumption.models.``Resource`(**kwargs)

  Bases: `msrest.serialization.Model`

  The Resource model definition.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.
  - tags (dict[str, str]) – Resource tags.

class `azure.mgmt.consumption.models.``ResourceAttributes`(**kwargs)

  Bases: `msrest.serialization.Model`

  The Resource model definition.

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

  Variables:

  - location (str) – Resource location
  - sku (str) – Resource sku

class `azure.mgmt.consumption.models.``ProxyResource`(*, e_tag: str = None, **kwargs)

  Bases: `msrest.serialization.Model`

  The Resource model definition.

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

  Variables:

  - id (str) – Resource Id.
  - name (str) – Resource name.
  - type (str) – Resource type.

  Parameters: | e_tag (str) – eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

class `azure.mgmt.consumption.models.``UsageDetailPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `UsageDetail` object

class `azure.mgmt.consumption.models.``MarketplacePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `Marketplace` object

class `azure.mgmt.consumption.models.``BudgetPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `Budget` object

class `azure.mgmt.consumption.models.``ReservationSummaryPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `ReservationSummary` object

class `azure.mgmt.consumption.models.``ReservationDetailPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `ReservationDetail` object

class `azure.mgmt.consumption.models.``ReservationRecommendationPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `ReservationRecommendation` object

class `azure.mgmt.consumption.models.``ForecastPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `Forecast` object

class `azure.mgmt.consumption.models.``OperationPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of `Operation` object

class `azure.mgmt.consumption.models.``BillingFrequency`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `month` = 'Month'
  `quarter` = 'Quarter'
  `year` = 'Year'

class `azure.mgmt.consumption.models.``CategoryType`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `cost` = 'Cost'
  `usage` = 'Usage'

class `azure.mgmt.consumption.models.``TimeGrainType`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `annually` = 'Annually'
  `monthly` = 'Monthly'
  `quarterly` = 'Quarterly'

class `azure.mgmt.consumption.models.``OperatorType`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `equal_to` = 'EqualTo'
  `greater_than` = 'GreaterThan'
  `greater_than_or_equal_to` = 'GreaterThanOrEqualTo'

class `azure.mgmt.consumption.models.``Grain`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `daily` = 'Daily'
  `monthly` = 'Monthly'
  `yearly` = 'Yearly'

class `azure.mgmt.consumption.models.``ChargeType`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `actual` = 'Actual'
  `forecast` = 'Forecast'

class `azure.mgmt.consumption.models.``Bound`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `lower` = 'Lower'
  `upper` = 'Upper'

class `azure.mgmt.consumption.models.``Datagrain`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `daily_grain` = 'daily'

    Daily grain of data

  `monthly_grain` = 'monthly'

    Monthly grain of data

class `azure.mgmt.consumption.models.``Metrictype`

  Bases: `str`, `enum.Enum`

  An enumeration.

  `actual_cost_metric_type` = 'actualcost'

    Actual cost data.

  `amortized_cost_metric_type` = 'amortizedcost'

    Amortized cost data.

  `usage_metric_type` = 'usage'

    Usage data.