azure.mgmt.consumption.models module

class azure.mgmt.consumption.models.Amount(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The amount plus currency .

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

Variables

• currency (str) – Amount currency.

• value (float) – Amount.

class azure.mgmt.consumption.models.AmountWithExchangeRate(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.Amount

The amount with exchange rate.

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

Variables

• currency (str) – Amount currency.

• value (float) – Amount.

• exchange_rate (float) – The exchange rate.

• exchange_rate_month (int) – The exchange rate month.

class azure.mgmt.consumption.models.Balance(*, billing_frequency: Optional[Union[str, _models.BillingFrequency]] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_py3.Resource

A balance resource.

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

Variables

• 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 (dict[str, str]) – Resource tags.

• currency (str) – The ISO currency in which the meter is charged, for example, USD.

• beginning_balance (float) – The beginning balance for the billing period.

• ending_balance (float) – The ending balance for the billing period (for open periods this will be updated daily).

• new_purchases (float) – Total new purchase amount.

• adjustments (float) – Total adjustment amount.

• utilized (float) – Total Commitment usage.

• service_overage (float) – Overage for Azure services.

• charges_billed_separately (float) – Charges Billed separately.

• total_overage (float) – serviceOverage + chargesBilledSeparately.

• total_usage (float) – Azure service commitment + total Overage.

• azure_marketplace_service_charges (float) – Total charges for Azure Marketplace.

• billing_frequency (str or BillingFrequency) – The billing frequency. Known values are: “Month”, “Quarter”, and “Year”.

• 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.).

Keyword Arguments

billing_frequency (str or BillingFrequency) – The billing frequency. Known values are: “Month”, “Quarter”, and “Year”.

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

Bases: azure.mgmt.consumption._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 (float) – the value of new adjustment.

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

Bases: azure.mgmt.consumption._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 (float) – the value of new purchase.

class azure.mgmt.consumption.models.BillingFrequency(value)

Bases: str, enum.Enum

The billing frequency.

MONTH = 'Month'

QUARTER = 'Quarter'

YEAR = 'Year'

class azure.mgmt.consumption.models.Budget(*, e_tag: Optional[str] = None, category: Optional[Union[str, _models.CategoryType]] = None, amount: Optional[float] = None, time_grain: Optional[Union[str, _models.TimeGrainType]] = None, time_period: Optional[_models.BudgetTimePeriod] = None, filter: Optional[_models.BudgetFilter] = None, notifications: Optional[Dict[str, _models.Notification]] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ProxyResource

A budget 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.

• 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) – The category of the budget, whether the budget tracks cost or usage. “Cost”

• amount (float) – The total amount of cost to track with the budget.

• time_grain (str or TimeGrainType) – The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers. Known values are: “Monthly”, “Quarterly”, “Annually”, “BillingMonth”, “BillingQuarter”, and “BillingAnnual”.

• time_period (BudgetTimePeriod) – 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 twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.

• filter (BudgetFilter) – May be used to filter budgets by user-specified dimensions and/or tags.

• current_spend (CurrentSpend) – The current amount of cost which is being tracked for a budget.

• notifications (dict[str, Notification]) – Dictionary of notifications associated with the budget. Budget can have up to five notifications.

• forecast_spend (ForecastSpend) – The forecasted cost which is being tracked for a budget.

Keyword Arguments

• 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) – The category of the budget, whether the budget tracks cost or usage. “Cost”

• amount (float) – The total amount of cost to track with the budget.

• time_grain (str or TimeGrainType) – The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers. Known values are: “Monthly”, “Quarterly”, “Annually”, “BillingMonth”, “BillingQuarter”, and “BillingAnnual”.

• time_period (BudgetTimePeriod) – 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 twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.

• filter (BudgetFilter) – May be used to filter budgets by user-specified dimensions and/or tags.

• notifications (dict[str, Notification]) – Dictionary of notifications associated with the budget. Budget can have up to five notifications.

class azure.mgmt.consumption.models.BudgetComparisonExpression(*, name: str, operator: Union[str, _models.BudgetOperatorType], values: List[str], **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The comparison expression to be used in the budgets.

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

Variables

• name (str) – The name of the column to use in comparison. Required.

• operator (str or BudgetOperatorType) – The operator to use for comparison. Required. “In”

• values (list[str]) – Array of values to use for comparison. Required.

Keyword Arguments

• name (str) – The name of the column to use in comparison. Required.

• operator (str or BudgetOperatorType) – The operator to use for comparison. Required. “In”

• values (list[str]) – Array of values to use for comparison. Required.

class azure.mgmt.consumption.models.BudgetFilter(*, and_property: Optional[List[_models.BudgetFilterProperties]] = None, dimensions: Optional[_models.BudgetComparisonExpression] = None, tags: Optional[_models.BudgetComparisonExpression] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

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

Variables

• and_property (list[BudgetFilterProperties]) – The logical “AND” expression. Must have at least 2 items.

• dimensions (BudgetComparisonExpression) – Has comparison expression for a dimension.

• tags (BudgetComparisonExpression) – Has comparison expression for a tag.

Keyword Arguments

• and_property (list[BudgetFilterProperties]) – The logical “AND” expression. Must have at least 2 items.

• dimensions (BudgetComparisonExpression) – Has comparison expression for a dimension.

• tags (BudgetComparisonExpression) – Has comparison expression for a tag.

class azure.mgmt.consumption.models.BudgetFilterProperties(*, dimensions: Optional[_models.BudgetComparisonExpression] = None, tags: Optional[_models.BudgetComparisonExpression] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The Dimensions or Tags to filter a budget by.

Variables

• dimensions (BudgetComparisonExpression) – Has comparison expression for a dimension.

• tags (BudgetComparisonExpression) – Has comparison expression for a tag.

Keyword Arguments

• dimensions (BudgetComparisonExpression) – Has comparison expression for a dimension.

• tags (BudgetComparisonExpression) – Has comparison expression for a tag.

class azure.mgmt.consumption.models.BudgetOperatorType(value)

Bases: str, enum.Enum

The operator to use for comparison.

IN = 'In'

class azure.mgmt.consumption.models.BudgetTimePeriod(*, start_date: datetime.datetime, end_date: Optional[datetime.datetime] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The start and end date for a budget.

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

Variables

• start_date (datetime) – The start date for the budget. Required.

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

Keyword Arguments

• start_date (datetime) – The start date for the budget. Required.

• 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.BudgetsListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing budgets. It contains a list of available budgets in the scope provided.

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

Variables

• value (list[Budget]) – The list of budgets.

• next_link (str) – The link (url) to the next page of results.

class azure.mgmt.consumption.models.CategoryType(value)

Bases: str, enum.Enum

The category of the budget, whether the budget tracks cost or usage.

COST = 'Cost'

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

Bases: azure.mgmt.consumption.models._models_py3.Resource

A charge summary resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LegacyChargeSummary, ModernChargeSummary

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) – 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 (dict[str, str]) – Resource tags.

• kind (str or ChargeSummaryKind) – Specifies the kind of charge summary. Required. Known values are: “legacy” and “modern”.

class azure.mgmt.consumption.models.ChargeSummaryKind(value)

Bases: str, enum.Enum

Specifies the kind of charge summary.

LEGACY = 'legacy'

MODERN = 'modern'

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

Bases: azure.mgmt.consumption._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.CreditBalanceSummary(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Summary of credit balances.

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

Variables

• estimated_balance (Amount) – Estimated balance.

• current_balance (Amount) – Current balance.

• estimated_balance_in_billing_currency (AmountWithExchangeRate) – Estimated balance in billing currency.

class azure.mgmt.consumption.models.CreditSummary(*, e_tag: Optional[str] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ProxyResource

A credit 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.

• 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.

• balance_summary (CreditBalanceSummary) – Summary of balances associated with this credit summary.

• pending_credit_adjustments (Amount) – Pending credit adjustments.

• expired_credit (Amount) – Expired credit.

• pending_eligible_charges (Amount) – Pending eligible charges.

• credit_currency (str) – The credit currency.

• billing_currency (str) – The billing currency.

• reseller (Reseller) – Credit’s reseller.

• e_tag_properties_e_tag (str) – The eTag for the resource.

Keyword Arguments

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.CultureCode(value)

Bases: str, enum.Enum

Language in which the recipient will receive the notification.

CS_CZ = 'cs-cz'

DA_DK = 'da-dk'

DE_DE = 'de-de'

EN_GB = 'en-gb'

EN_US = 'en-us'

ES_ES = 'es-es'

FR_FR = 'fr-fr'

HU_HU = 'hu-hu'

IT_IT = 'it-it'

JA_JP = 'ja-jp'

KO_KR = 'ko-kr'

NB_NO = 'nb-no'

NL_NL = 'nl-nl'

PL_PL = 'pl-pl'

PT_BR = 'pt-br'

PT_PT = 'pt-pt'

RU_RU = 'ru-ru'

SV_SE = 'sv-se'

TR_TR = 'tr-tr'

ZH_CN = 'zh-cn'

ZH_TW = 'zh-tw'

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

Bases: azure.mgmt.consumption._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 (float) – 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.Datagrain(value)

Bases: str, enum.Enum

Datagrain.

DAILY_GRAIN = 'daily'

Daily grain of data

MONTHLY_GRAIN = 'monthly'

Monthly grain of data

class azure.mgmt.consumption.models.DownloadProperties(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The properties of the price sheet download.

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

Variables

• download_url (str) – The link (url) to download the pricesheet.

• valid_till (str) – Download link validity.

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

Bases: azure.mgmt.consumption._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: Optional[_models.ErrorDetails] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

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

Some Error responses:

• 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the “x-ms-ratelimit-microsoft.consumption-retry-after” header.

• 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the “Retry-After” header.

  ivar error

  The details of the error.

  vartype error

  ~azure.mgmt.consumption.models.ErrorDetails

Keyword Arguments

error (ErrorDetails) – The details of the error.

class azure.mgmt.consumption.models.EventSummary(*, e_tag: Optional[str] = None, event_type: Optional[Union[str, _models.EventType]] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ProxyResource

An event 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.

• 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.

• transaction_date (datetime) – The date of the event.

• description (str) – The description of the event.

• new_credit (Amount) – The amount of new credit or commitment for NewCredit or SettleCharges event.

• adjustments (Amount) – The amount of balance adjustment. The property is not available for ConsumptionCommitment lots.

• credit_expired (Amount) – The amount of expired credit or commitment for NewCredit or SettleCharges event.

• charges (Amount) – The amount of charges for events of type SettleCharges and PendingEligibleCharges.

• closed_balance (Amount) – The balance after the event.

• event_type (str or EventType) – Identifies the type of the event. Known values are: “SettledCharges”, “PendingCharges”, “PendingAdjustments”, “PendingNewCredit”, “PendingExpiredCredit”, “UnKnown”, “NewCredit”, and “CreditExpired”.

• invoice_number (str) – The number which uniquely identifies the invoice on which the event was billed. This will be empty for unbilled events.

• billing_profile_id (str) – The ID that uniquely identifies the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement.

• billing_profile_display_name (str) – The display name of the billing profile for which the event happened. The property is only available for billing account of type MicrosoftCustomerAgreement.

• lot_id (str) – The ID that uniquely identifies the lot for which the event happened.

• lot_source (str) – Identifies the source of the lot for which the event happened.

• canceled_credit (Amount) – Amount of canceled credit.

• credit_currency (str) – The credit currency of the event.

• billing_currency (str) – The billing currency of the event.

• reseller (Reseller) – The reseller of the event.

• credit_expired_in_billing_currency (AmountWithExchangeRate) – The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency.

• new_credit_in_billing_currency (AmountWithExchangeRate) – The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency.

• adjustments_in_billing_currency (AmountWithExchangeRate) – The amount of balance adjustment in billing currency.

• charges_in_billing_currency (AmountWithExchangeRate) – The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency.

• closed_balance_in_billing_currency (AmountWithExchangeRate) – The balance in billing currency after the event.

• e_tag_properties_e_tag (str) – The eTag for the resource.

Keyword Arguments

• 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.

• event_type (str or EventType) – Identifies the type of the event. Known values are: “SettledCharges”, “PendingCharges”, “PendingAdjustments”, “PendingNewCredit”, “PendingExpiredCredit”, “UnKnown”, “NewCredit”, and “CreditExpired”.

class azure.mgmt.consumption.models.EventType(value)

Bases: str, enum.Enum

Identifies the type of the event.

CREDIT_EXPIRED = 'CreditExpired'

NEW_CREDIT = 'NewCredit'

PENDING_ADJUSTMENTS = 'PendingAdjustments'

PENDING_CHARGES = 'PendingCharges'

PENDING_EXPIRED_CREDIT = 'PendingExpiredCredit'

PENDING_NEW_CREDIT = 'PendingNewCredit'

SETTLED_CHARGES = 'SettledCharges'

UN_KNOWN = 'UnKnown'

class azure.mgmt.consumption.models.Events(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing event summary.

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

Variables

• value (list[EventSummary]) – The list of event summary.

• next_link (str) – The link (url) to the next page of results.

class azure.mgmt.consumption.models.ForecastSpend(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The forecasted 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 (float) – The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.

• unit (str) – The unit of measure for the budget amount.

class azure.mgmt.consumption.models.HighCasedErrorDetails(**kwargs)

Bases: azure.mgmt.consumption._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.HighCasedErrorResponse(*, error: Optional[_models.HighCasedErrorDetails] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

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

Some Error responses:

• 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the “x-ms-ratelimit-microsoft.consumption-retry-after” header.

• 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the “Retry-After” header.

  ivar error

  The details of the error.

  vartype error

  ~azure.mgmt.consumption.models.HighCasedErrorDetails

Keyword Arguments

error (HighCasedErrorDetails) – The details of the error.

class azure.mgmt.consumption.models.LegacyChargeSummary(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ChargeSummary

Legacy charge summary.

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) – 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 (dict[str, str]) – Resource tags.

• kind (str or ChargeSummaryKind) – Specifies the kind of charge summary. Required. Known values are: “legacy” and “modern”.

• 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 (float) – Azure Charges.

• charges_billed_separately (float) – Charges Billed separately.

• azure_marketplace_charges (float) – Marketplace Charges.

• currency (str) – Currency Code.

class azure.mgmt.consumption.models.LegacyReservationRecommendation(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ReservationRecommendation

Legacy reservation recommendation.

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

• location (str) – Resource location.

• sku (str) – Resource sku.

• 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 (dict[str, str]) – Resource tags.

• kind (str or ReservationRecommendationKind) – Specifies the kind of reservation recommendation. Required. Known values are: “legacy” and “modern”.

• look_back_period (str) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• resource_type (str) – The azure resource type.

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (float) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• total_cost_with_reserved_instances (float) – The total amount of cost with reserved instances.

• net_savings (float) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

class azure.mgmt.consumption.models.LegacyReservationRecommendationProperties(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The properties of the reservation recommendation.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LegacySharedScopeReservationRecommendationProperties, LegacySingleScopeReservationRecommendationProperties

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

• look_back_period (str) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• resource_type (str) – The azure resource type.

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (float) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• total_cost_with_reserved_instances (float) – The total amount of cost with reserved instances.

• net_savings (float) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

class azure.mgmt.consumption.models.LegacyReservationTransaction(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ReservationTransaction

Legacy Reservation transaction 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 (list[str]) – Resource tags.

• event_date (datetime) – The date of the transaction.

• 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.

• description (str) – The description of the transaction.

• event_type (str) – The type of the transaction (Purchase, Cancel or Refund).

• quantity (float) – The quantity of the transaction.

• amount (float) – The charge of the transaction.

• currency (str) – The ISO currency in which the transaction is charged, for example, USD.

• reservation_order_name (str) – The name of the reservation order.

• purchasing_enrollment (str) – The purchasing enrollment.

• purchasing_subscription_guid (str) – The subscription guid that makes the transaction.

• purchasing_subscription_name (str) – The subscription name that makes the transaction.

• arm_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.

• term (str) – This is the term of the transaction.

• region (str) – The region of the transaction.

• account_name (str) – The name of the account that makes the transaction.

• account_owner_email (str) – The email of the account owner that makes the transaction.

• department_name (str) – The department name.

• cost_center (str) – The cost center of this department if it is a department and a cost center is provided.

• current_enrollment (str) – The current enrollment.

• billing_frequency (str) – The billing frequency, which can be either one-time or recurring.

• billing_month (int) – The billing month(yyyyMMdd), on which the event initiated.

• monetary_commitment (float) – The monetary commitment amount at the enrollment scope.

• overage (float) – The overage amount at the enrollment scope.

class azure.mgmt.consumption.models.LegacySharedScopeReservationRecommendationProperties(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.LegacyReservationRecommendationProperties

The properties of the legacy reservation recommendation for shared scope.

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

• look_back_period (str) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• resource_type (str) – The azure resource type.

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (float) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• total_cost_with_reserved_instances (float) – The total amount of cost with reserved instances.

• net_savings (float) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

class azure.mgmt.consumption.models.LegacySingleScopeReservationRecommendationProperties(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.LegacyReservationRecommendationProperties

The properties of the legacy reservation recommendation for single scope.

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

• look_back_period (str) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• resource_type (str) – The azure resource type.

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (float) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• total_cost_with_reserved_instances (float) – The total amount of cost with reserved instances.

• net_savings (float) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

• subscription_id (str) – Subscription id associated with single scoped recommendation.

class azure.mgmt.consumption.models.LegacyUsageDetail(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.UsageDetail

Legacy 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.

Variables

• 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 (dict[str, str]) – Resource tags.

• kind (str or UsageDetailsKind) – Specifies the kind of usage details. Required. Known values are: “legacy” and “modern”.

• 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 (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 (float) – The usage quantity.

• effective_price (float) – Effective Price that’s charged for the usage.

• cost (float) – The amount of cost before tax.

• unit_price (float) – 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) – Unique identifier of the Azure Resource Manager usage detail resource.

• resource_name (str) – Resource Name.

• 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. 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.

• pay_g_price (float) – Retail price for the resource.

• benefit_id (str) – Unique identifier for the applicable benefit.

• benefit_name (str) – Name of the applicable benefit.

• pricing_model (str or PricingModelType) – Identifier that indicates how the meter is priced. Known values are: “On Demand”, “Reservation”, and “Spot”.

class azure.mgmt.consumption.models.LookBackPeriod(value)

Bases: str, enum.Enum

LookBackPeriod.

LAST07_DAYS = 'Last7Days'

Use 7 days of data for recommendations

LAST30_DAYS = 'Last30Days'

Use 30 days of data for recommendations

LAST60_DAYS = 'Last60Days'

Use 60 days of data for recommendations

class azure.mgmt.consumption.models.LotSource(value)

Bases: str, enum.Enum

The source of the lot.

CONSUMPTION_COMMITMENT = 'ConsumptionCommitment'

PROMOTIONAL_CREDIT = 'PromotionalCredit'

PURCHASED_CREDIT = 'PurchasedCredit'

class azure.mgmt.consumption.models.LotSummary(*, e_tag: Optional[str] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ProxyResource

A lot 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.

• 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.

• original_amount (Amount) – The original amount of a lot.

• closed_balance (Amount) – The balance as of the last invoice.

• source (str or LotSource) – The source of the lot. Known values are: “PurchasedCredit”, “PromotionalCredit”, and “ConsumptionCommitment”.

• start_date (datetime) – The date when the lot became effective.

• expiration_date (datetime) – The expiration date of a lot.

• po_number (str) – The po number of the invoice on which the lot was added. This property is not available for ConsumptionCommitment lots.

• purchased_date (datetime) – The date when the lot was added.

• status (str or Status) – The status of the lot. Known values are: “None”, “Active”, “Inactive”, “Expired”, “Complete”, and “Canceled”.

• credit_currency (str) – The currency of the lot.

• billing_currency (str) – The billing currency of the lot.

• original_amount_in_billing_currency (AmountWithExchangeRate) – The original amount of a lot in billing currency.

• closed_balance_in_billing_currency (AmountWithExchangeRate) – The balance as of the last invoice in billing currency.

• reseller (Reseller) – The reseller of the lot.

• e_tag_properties_e_tag (str) – The eTag for the resource.

Keyword Arguments

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.Lots(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing lot summary.

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

Variables

• value (list[LotSummary]) – The list of lot summary.

• next_link (str) – The link (url) to the next page of results.

class azure.mgmt.consumption.models.ManagementGroupAggregatedCostResult(*, children: Optional[List[_models.ManagementGroupAggregatedCostResult]] = None, included_subscriptions: Optional[List[str]] = None, excluded_subscriptions: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_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) – 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 (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 (float) – Azure Charges.

• marketplace_charges (float) – Marketplace Charges.

• charges_billed_separately (float) – Charges Billed Separately.

• currency (str) – The ISO currency in which the meter is charged, for example, USD.

• 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.

Keyword Arguments

• 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.Marketplace(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.Resource

A marketplace resource.

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

Variables

• 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 (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 (float) – The marketplace resource rate.

• offer_name (str) – The type of offer.

• resource_group (str) – The name of resource group.

• additional_info (str) – Additional information.

• 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 (float) – The quantity of usage.

• unit_of_measure (str) – The unit of measure.

• pretax_cost (float) – 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.MarketplacesListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.

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

Variables

• value (list[Marketplace]) – The list of marketplaces.

• next_link (str) – The link (url) to the next page of results.

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

Bases: azure.mgmt.consumption._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 (float) – The total included quantity associated with the offer.

• pretax_standard_rate (float) – 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: azure.mgmt.consumption._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.Metrictype(value)

Bases: str, enum.Enum

Metrictype.

ACTUAL_COST_METRIC_TYPE = 'actualcost'

Actual cost data.

AMORTIZED_COST_METRIC_TYPE = 'amortizedcost'

Amortized cost data.

USAGE_METRIC_TYPE = 'usage'

Usage data.

class azure.mgmt.consumption.models.ModernChargeSummary(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ChargeSummary

Modern charge summary.

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) – 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 (dict[str, str]) – Resource tags.

• kind (str or ChargeSummaryKind) – Specifies the kind of charge summary. Required. Known values are: “legacy” and “modern”.

• 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 (Amount) – Azure Charges.

• charges_billed_separately (Amount) – Charges Billed separately.

• marketplace_charges (Amount) – Marketplace Charges.

• billing_account_id (str) – Billing Account Id.

• billing_profile_id (str) – Billing Profile Id.

• invoice_section_id (str) – Invoice Section Id.

• customer_id (str) – Customer Id.

• is_invoiced (bool) – Is charge Invoiced.

class azure.mgmt.consumption.models.ModernReservationRecommendation(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ReservationRecommendation

Modern reservation recommendation.

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

• location (str) – Resource location.

• sku (str) – Resource sku.

• 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 (dict[str, str]) – Resource tags.

• kind (str or ReservationRecommendationKind) – Specifies the kind of reservation recommendation. Required. Known values are: “legacy” and “modern”.

• location_properties_location (str) – Resource Location.

• look_back_period (int) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (Amount) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• resource_type (str) – Resource type.

• total_cost_with_reserved_instances (Amount) – The total amount of cost with reserved instances.

• net_savings (Amount) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

• sku_name (str) – This is the ARM Sku name.

class azure.mgmt.consumption.models.ModernReservationRecommendationProperties(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The properties of the reservation recommendation.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ModernSharedScopeReservationRecommendationProperties, ModernSingleScopeReservationRecommendationProperties

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

• location (str) – Resource Location.

• look_back_period (int) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (Amount) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• resource_type (str) – Resource type.

• total_cost_with_reserved_instances (Amount) – The total amount of cost with reserved instances.

• net_savings (Amount) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

• sku_name (str) – This is the ARM Sku name.

class azure.mgmt.consumption.models.ModernReservationTransaction(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ReservationTransactionResource

Modern Reservation transaction 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 (list[str]) – Resource tags.

• amount (float) – The charge of the transaction.

• arm_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.

• billing_frequency (str) – The billing frequency, which can be either one-time or recurring.

• billing_profile_id (str) – Billing profile Id.

• billing_profile_name (str) – Billing profile name.

• currency (str) – The ISO currency in which the transaction is charged, for example, USD.

• description (str) – The description of the transaction.

• event_date (datetime) – The date of the transaction.

• event_type (str) – The type of the transaction (Purchase, Cancel or Refund).

• invoice (str) – Invoice Number.

• invoice_id (str) – Invoice Id as on the invoice where the specific transaction appears.

• invoice_section_id (str) – Invoice Section Id.

• invoice_section_name (str) – Invoice Section Name.

• purchasing_subscription_guid (str) – The subscription guid that makes the transaction.

• purchasing_subscription_name (str) – The subscription name that makes the transaction.

• quantity (float) – The quantity of the transaction.

• region (str) – The region of the transaction.

• 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_order_name (str) – The name of the reservation order.

• term (str) – This is the term of the transaction.

class azure.mgmt.consumption.models.ModernReservationTransactionsListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing reservation recommendations.

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

Variables

• value (list[ModernReservationTransaction]) – The list of reservation recommendations.

• next_link (str) – The link (url) to the next page of results.

class azure.mgmt.consumption.models.ModernSharedScopeReservationRecommendationProperties(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ModernReservationRecommendationProperties

The properties of the modern reservation recommendation for shared scope.

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

• location (str) – Resource Location.

• look_back_period (int) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (Amount) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• resource_type (str) – Resource type.

• total_cost_with_reserved_instances (Amount) – The total amount of cost with reserved instances.

• net_savings (Amount) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

• sku_name (str) – This is the ARM Sku name.

class azure.mgmt.consumption.models.ModernSingleScopeReservationRecommendationProperties(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ModernReservationRecommendationProperties

The properties of the modern reservation recommendation for single scope.

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

• location (str) – Resource Location.

• look_back_period (int) – The number of days of usage to look back for recommendation.

• instance_flexibility_ratio (float) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• normalized_size (str) – The normalized Size.

• recommended_quantity_normalized (float) – The recommended Quantity Normalized.

• meter_id (str) – The meter id (GUID).

• term (str) – RI recommendations in one or three year terms.

• cost_with_no_reserved_instances (Amount) – The total amount of cost without reserved instances.

• recommended_quantity (float) – Recommended quality for reserved instances.

• resource_type (str) – Resource type.

• total_cost_with_reserved_instances (Amount) – The total amount of cost with reserved instances.

• net_savings (Amount) – Total estimated savings with reserved instances.

• first_usage_date (datetime) – The usage date for looking back.

• scope (str) – Shared or single recommendation. Required.

• sku_properties (list[SkuProperty]) – List of sku properties.

• sku_name (str) – This is the ARM Sku name.

• subscription_id (str) – Subscription ID associated with single scoped recommendation.

class azure.mgmt.consumption.models.ModernUsageDetail(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.UsageDetail

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.

Variables

• 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 (dict[str, str]) – Resource tags.

• kind (str or UsageDetailsKind) – Specifies the kind of usage details. Required. Known values are: “legacy” and “modern”.

• billing_account_id (str) – Billing Account identifier.

• effective_price (float) – Effective Price that’s charged for the usage.

• pricing_model (str or PricingModelType) – Identifier that indicates how the meter is priced. Known values are: “On Demand”, “Reservation”, and “Spot”.

• billing_account_name (str) – Name of the Billing Account.

• billing_period_start_date (datetime) – Billing Period Start Date as in the invoice.

• billing_period_end_date (datetime) – 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 (datetime) – 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 (float) – 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 (float) – Estimated extendedCost or blended cost before tax in USD.

• unit_price (float) – 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 (bool) – 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 (float) – ExtendedCost or blended cost before tax in billed currency.

• cost_in_pricing_currency (float) – 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 (datetime) – 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 (datetime) – 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 (datetime) – 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 (float) – Market Price that’s charged for the usage.

• exchange_rate_pricing_to_billing (float) – Exchange Rate from pricing currency to billing currency.

• payg_cost_in_billing_currency (float) – The amount of PayG cost before tax in billing currency.

• payg_cost_in_usd (float) – The amount of PayG cost before tax in US Dollar currency.

• partner_earned_credit_rate (float) – 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 (float) – 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.

class azure.mgmt.consumption.models.Notification(*, enabled: bool, operator: Union[str, _models.OperatorType], threshold: float, contact_emails: List[str], contact_roles: Optional[List[str]] = None, contact_groups: Optional[List[str]] = None, threshold_type: Union[str, _models.ThresholdType] = 'Actual', locale: Optional[Union[str, _models.CultureCode]] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The notification associated with a budget.

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

Variables

• enabled (bool) – The notification is enabled or not. Required.

• operator (str or OperatorType) – The comparison operator. Required. Known values are: “EqualTo”, “GreaterThan”, and “GreaterThanOrEqualTo”.

• threshold (float) – 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. Required.

• contact_emails (list[str]) – Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. Required.

• 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. Must be provided as a fully qualified Azure resource id. Only supported at Subscription or Resource Group scopes.

• threshold_type (str or ThresholdType) – The type of threshold. Known values are: “Actual” and “Forecasted”.

• locale (str or CultureCode) – Language in which the recipient will receive the notification. Known values are: “en-us”, “ja-jp”, “zh-cn”, “de-de”, “es-es”, “fr-fr”, “it-it”, “ko-kr”, “pt-br”, “ru-ru”, “zh-tw”, “cs-cz”, “pl-pl”, “tr-tr”, “da-dk”, “en-gb”, “hu-hu”, “nb-no”, “nl-nl”, “pt-pt”, and “sv-se”.

Keyword Arguments

• enabled (bool) – The notification is enabled or not. Required.

• operator (str or OperatorType) – The comparison operator. Required. Known values are: “EqualTo”, “GreaterThan”, and “GreaterThanOrEqualTo”.

• threshold (float) – 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. Required.

• contact_emails (list[str]) – Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. Required.

• 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. Must be provided as a fully qualified Azure resource id. Only supported at Subscription or Resource Group scopes.

• threshold_type (str or ThresholdType) – The type of threshold. Known values are: “Actual” and “Forecasted”.

• locale (str or CultureCode) – Language in which the recipient will receive the notification. Known values are: “en-us”, “ja-jp”, “zh-cn”, “de-de”, “es-es”, “fr-fr”, “it-it”, “ko-kr”, “pt-br”, “ru-ru”, “zh-tw”, “cs-cz”, “pl-pl”, “tr-tr”, “da-dk”, “en-gb”, “hu-hu”, “nb-no”, “nl-nl”, “pt-pt”, and “sv-se”.

class azure.mgmt.consumption.models.Operation(*, display: Optional[_models.OperationDisplay] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

A Consumption REST API operation.

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

Variables

• id (str) – Operation Id.

• name (str) – Operation name: {provider}/{resource}/{operation}.

• display (OperationDisplay) – The object that represents the operation.

Keyword Arguments

display (OperationDisplay) – The object that represents the operation.

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

Bases: azure.mgmt.consumption._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.

• description (str) – Description of the operation.

class azure.mgmt.consumption.models.OperationListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.

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

Variables

• value (list[Operation]) – List of consumption operations supported by the Microsoft.Consumption resource provider.

• next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.consumption.models.OperatorType(value)

Bases: str, enum.Enum

The comparison operator.

EQUAL_TO = 'EqualTo'

It’s not recommended to use this OperatorType as there’s low chance of cost being exactly the same as threshold value, leading to missing of your alert. This OperatorType will be deprecated in future.

Type

Alert will be triggered if the evaluated cost is the same as threshold value. Note

GREATER_THAN = 'GreaterThan'

This is the recommended OperatorType while configuring Budget Alert.

Type

Alert will be triggered if the evaluated cost is greater than the threshold value. Note

GREATER_THAN_OR_EQUAL_TO = 'GreaterThanOrEqualTo'

Alert will be triggered if the evaluated cost is greater than or equal to the threshold value.

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

Bases: azure.mgmt.consumption._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 (float) – Included quality for an offer.

• part_number (str) – Part Number.

• unit_price (float) – Unit Price.

• currency_code (str) – Currency Code.

• offer_id (str) – Offer Id.

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

Bases: azure.mgmt.consumption.models._models_py3.Resource

An pricesheet resource.

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

Variables

• 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 (dict[str, str]) – Resource tags.

• pricesheets (list[PriceSheetProperties]) – Price sheet.

• next_link (str) – The link (url) to the next page of results.

• download (MeterDetails) – Pricesheet download details.

class azure.mgmt.consumption.models.PricingModelType(value)

Bases: str, enum.Enum

Identifier that indicates how the meter is priced.

ON_DEMAND = 'On Demand'

RESERVATION = 'Reservation'

SPOT = 'Spot'

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

Bases: azure.mgmt.consumption._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.

• 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.

Keyword Arguments

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.Reseller(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The reseller properties.

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

Variables

• reseller_id (str) – The reseller property ID.

• reseller_description (str) – The reseller property description.

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

Bases: azure.mgmt.consumption.models._models_py3.Resource

reservation detail resource.

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

Variables

• 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 (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.

• instance_flexibility_ratio (str) – The instance Flexibility Ratio.

• instance_flexibility_group (str) – The instance Flexibility Group.

• 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 (float) – 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 (float) – 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 (float) – This is the total count of instances that are reserved for the reservationId.

• kind (str) – The reservation kind.

class azure.mgmt.consumption.models.ReservationDetailsListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing reservation details.

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

Variables

• value (list[ReservationDetail]) – The list of reservation details.

• next_link (str) – The link (url) to the next page of results.

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

Bases: azure.mgmt.consumption.models._models_py3.Resource, azure.mgmt.consumption.models._models_py3.ResourceAttributes

A reservation recommendation resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LegacyReservationRecommendation, ModernReservationRecommendation

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

• location (str) – Resource location.

• sku (str) – Resource sku.

• 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 (dict[str, str]) – Resource tags.

• kind (str or ReservationRecommendationKind) – Specifies the kind of reservation recommendation. Required. Known values are: “legacy” and “modern”.

class azure.mgmt.consumption.models.ReservationRecommendationDetailsCalculatedSavingsProperties(*, reserved_unit_count: Optional[float] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Details of estimated savings. The costs and savings are estimated for the term.

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

Variables

• on_demand_cost (float) – The cost without reservation. Includes hardware and software cost.

• overage_cost (float) – Hardware and software cost of the resources not covered by the reservation.

• quantity (float) – The quantity for calculated savings.

• reservation_cost (float) – Hardware cost of the resources covered by the reservation.

• total_reservation_cost (float) – Reservation cost + software cost of the resources covered by the reservation + overage cost.

• reserved_unit_count (float) – The number of reserved units used to calculate savings. Always 1 for virtual machines.

• savings (float) – The amount saved by purchasing the recommended quantity of reservation. This is equal to onDemandCost - totalReservationCost.

Keyword Arguments

reserved_unit_count (float) – The number of reserved units used to calculate savings. Always 1 for virtual machines.

class azure.mgmt.consumption.models.ReservationRecommendationDetailsModel(*, location: Optional[str] = None, sku: Optional[str] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_py3.Resource

Reservation recommendation details.

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

Variables

• 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 (dict[str, str]) – Resource tags.

• location (str) – Resource Location.

• sku (str) – Resource sku.

• currency (str) – An ISO 4217 currency code identifier for the costs and savings.

• resource (ReservationRecommendationDetailsResourceProperties) – Resource specific properties.

• resource_group (str) – Resource Group.

• savings (ReservationRecommendationDetailsSavingsProperties) – Savings information for the recommendation.

• scope (str) – Scope of the reservation, ex: Single or Shared.

• usage (ReservationRecommendationDetailsUsageProperties) – Historical usage details used to calculate the estimated savings.

Keyword Arguments

• location (str) – Resource Location.

• sku (str) – Resource sku.

class azure.mgmt.consumption.models.ReservationRecommendationDetailsResourceProperties(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Details of the resource.

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

Variables

• applied_scopes (list[str]) – List of subscriptions for which the reservation is applied.

• on_demand_rate (float) – Hourly on-demand rate of the resource. Includes only hardware rate i.e, software rate is not included.

• product (str) – Azure product ex: Standard_E8s_v3 etc.

• region (str) – Azure resource region ex:EastUS, WestUS etc.

• reservation_rate (float) – Hourly reservation rate of the resource. Varies based on the term.

• resource_type (str) – The azure resource type.

class azure.mgmt.consumption.models.ReservationRecommendationDetailsSavingsProperties(*, calculated_savings: Optional[List[_models.ReservationRecommendationDetailsCalculatedSavingsProperties]] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Details of the estimated savings.

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

Variables

• calculated_savings (list[ReservationRecommendationDetailsCalculatedSavingsProperties]) – List of calculated savings.

• look_back_period (int) – Number of days of usage to look back used for computing the recommendation.

• recommended_quantity (float) – Number of recommended units of the resource.

• reservation_order_term (str) – Term period of the reservation, ex: P1Y or P3Y.

• savings_type (str) – Type of savings, ex: instance.

• unit_of_measure (str) – Measurement unit ex: hour etc.

Keyword Arguments

calculated_savings (list[ReservationRecommendationDetailsCalculatedSavingsProperties]) – List of calculated savings.

class azure.mgmt.consumption.models.ReservationRecommendationDetailsUsageProperties(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Details about historical usage data that has been used for computing the recommendation.

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

Variables

• first_consumption_date (str) – The first usage date used for looking back for computing the recommendation.

• last_consumption_date (str) – The last usage date used for looking back for computing the recommendation.

• look_back_unit_type (str) – What the usage data values represent ex: virtual machine instance.

• usage_data (list[float]) – The breakdown of historical resource usage. The values are in the order of usage between the firstConsumptionDate and the lastConsumptionDate.

• usage_grain (str) – The grain of the values represented in the usage data ex: hourly.

class azure.mgmt.consumption.models.ReservationRecommendationKind(value)

Bases: str, enum.Enum

Specifies the kind of reservation recommendation.

LEGACY = 'legacy'

MODERN = 'modern'

class azure.mgmt.consumption.models.ReservationRecommendationsListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing reservation recommendations.

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

Variables

• value (list[ReservationRecommendation]) – The list of reservation recommendations.

• next_link (str) – The link (url) to the next page of results.

• previous_link (str) – The link (url) to the previous page of results.

class azure.mgmt.consumption.models.ReservationSummariesListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing reservation summaries.

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

Variables

• value (list[ReservationSummary]) – The list of reservation summaries.

• next_link (str) – The link (url) to the next page of results.

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

Bases: azure.mgmt.consumption.models._models_py3.Resource

reservation summary resource.

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

Variables

• 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 (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 (float) – 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 (float) – Total used hours by the reservation.

• min_utilization_percentage (float) – 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 (float) – This is average utilization for the entire time range. (day or month depending on the grain).

• max_utilization_percentage (float) – 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.

• kind (str) – The reservation kind.

• purchased_quantity (float) – This is the purchased quantity for the reservationId.

• remaining_quantity (float) – This is the remaining quantity for the reservationId.

• total_reserved_quantity (float) – This is the total count of instances that are reserved for the reservationId.

• used_quantity (float) – This is the used quantity for the reservationId.

• utilized_percentage (float) – This is the utilized percentage for the reservation Id.

class azure.mgmt.consumption.models.ReservationTransaction(**kwargs)

Bases: azure.mgmt.consumption.models._models_py3.ReservationTransactionResource

Reservation transaction 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 (list[str]) – Resource tags.

• event_date (datetime) – The date of the transaction.

• 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.

• description (str) – The description of the transaction.

• event_type (str) – The type of the transaction (Purchase, Cancel or Refund).

• quantity (float) – The quantity of the transaction.

• amount (float) – The charge of the transaction.

• currency (str) – The ISO currency in which the transaction is charged, for example, USD.

• reservation_order_name (str) – The name of the reservation order.

• purchasing_enrollment (str) – The purchasing enrollment.

• purchasing_subscription_guid (str) – The subscription guid that makes the transaction.

• purchasing_subscription_name (str) – The subscription name that makes the transaction.

• arm_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.

• term (str) – This is the term of the transaction.

• region (str) – The region of the transaction.

• account_name (str) – The name of the account that makes the transaction.

• account_owner_email (str) – The email of the account owner that makes the transaction.

• department_name (str) – The department name.

• cost_center (str) – The cost center of this department if it is a department and a cost center is provided.

• current_enrollment (str) – The current enrollment.

• billing_frequency (str) – The billing frequency, which can be either one-time or recurring.

• billing_month (int) – The billing month(yyyyMMdd), on which the event initiated.

• monetary_commitment (float) – The monetary commitment amount at the enrollment scope.

• overage (float) – The overage amount at the enrollment scope.

class azure.mgmt.consumption.models.ReservationTransactionResource(**kwargs)

Bases: azure.mgmt.consumption._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 (list[str]) – Resource tags.

class azure.mgmt.consumption.models.ReservationTransactionsListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing reservation recommendations.

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

Variables

• value (list[ReservationTransaction]) – The list of reservation recommendations.

• next_link (str) – The link (url) to the next page of results.

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

Bases: azure.mgmt.consumption._serialization.Model

The Resource model definition.

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

Variables

• 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 (dict[str, str]) – Resource tags.

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

Bases: azure.mgmt.consumption._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.Scope(value)

Bases: str, enum.Enum

Scope.

SHARED = 'Shared'

SINGLE = 'Single'

class azure.mgmt.consumption.models.SkuProperty(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The Sku property.

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

Variables

• name (str) – The name of sku property.

• value (str) – The value of sku property.

class azure.mgmt.consumption.models.Status(value)

Bases: str, enum.Enum

The status of the lot.

ACTIVE = 'Active'

CANCELED = 'Canceled'

COMPLETE = 'Complete'

EXPIRED = 'Expired'

INACTIVE = 'Inactive'

NONE = 'None'

class azure.mgmt.consumption.models.Tag(*, key: Optional[str] = None, value: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.consumption._serialization.Model

The tag resource.

Variables

• key (str) – Tag key.

• value (list[str]) – Tag values.

Keyword Arguments

• key (str) – Tag key.

• value (list[str]) – Tag values.

class azure.mgmt.consumption.models.TagsResult(*, e_tag: Optional[str] = None, tags: Optional[List[_models.Tag]] = None, **kwargs)

Bases: azure.mgmt.consumption.models._models_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.

• 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.

• next_link (str) – The link (url) to the next page of results.

• previous_link (str) – The link (url) to the previous page of results.

Keyword Arguments

• 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.Term(value)

Bases: str, enum.Enum

Term.

P1_Y = 'P1Y'

1 year reservation term

P3_Y = 'P3Y'

3 year reservation term

class azure.mgmt.consumption.models.ThresholdType(value)

Bases: str, enum.Enum

The type of threshold.

ACTUAL = 'Actual'

Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget .

FORECASTED = 'Forecasted'

Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions.

class azure.mgmt.consumption.models.TimeGrainType(value)

Bases: str, enum.Enum

The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers.

ANNUALLY = 'Annually'

BILLING_ANNUAL = 'BillingAnnual'

BILLING_MONTH = 'BillingMonth'

BILLING_QUARTER = 'BillingQuarter'

MONTHLY = 'Monthly'

QUARTERLY = 'Quarterly'

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

Bases: azure.mgmt.consumption.models._models_py3.Resource

An usage detail resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LegacyUsageDetail, ModernUsageDetail

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) – 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 (dict[str, str]) – Resource tags.

• kind (str or UsageDetailsKind) – Specifies the kind of usage details. Required. Known values are: “legacy” and “modern”.

class azure.mgmt.consumption.models.UsageDetailsKind(value)

Bases: str, enum.Enum

Specifies the kind of usage details.

LEGACY = 'legacy'

MODERN = 'modern'

class azure.mgmt.consumption.models.UsageDetailsListResult(**kwargs)

Bases: azure.mgmt.consumption._serialization.Model

Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.

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

Variables

• value (list[UsageDetail]) – The list of usage details.

• next_link (str) – The link (url) to the next page of results.