Package: azure-mgmt-consumption
Microsoft Azure SDK for PythonThis is the Microsoft Azure Consumption Client Library.
This package has been tested with Python 3.6+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691UsageTo learn how to use this package, see thequickstart guideFor docs and references, seePython SDK ReferencesCode samples for this package can be found atConsumptionon docs.microsoft.com.
Additional code samples for different Azure services are available atSamples RepoProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History10.0.0 (2022-06-20)FeaturesAdded operation LotsOperations.list_by_customerBreaking changesModel BudgetFilter no longer has parameter not_propertyOperation ReservationRecommendationDetailsOperations.get has a new parameter resource_scopeOperation ReservationRecommendationsOperations.list has a new parameter resource_scopeOperation ReservationRecommendationsOperations.list no longer has parameter scopeOperation ReservationsDetailsOperations.list has a new parameter resource_scopeOperation ReservationsDetailsOperations.list no longer has parameter scopeOperation ReservationsSummariesOperations.list has a new parameter resource_scopeOperation ReservationsSummariesOperations.list no longer has parameter scope9.0.0 (2022-01-06)FeaturesAdded operation EventsOperations.list_by_billing_accountAdded operation EventsOperations.list_by_billing_profileAdded operation LotsOperations.list_by_billing_accountAdded operation LotsOperations.list_by_billing_profileModel Balance has a new parameter etagModel Budget has a new parameter forecast_spendModel ChargeSummary has a new parameter e_tagModel CreditBalanceSummary has a new parameter estimated_balance_in_billing_currencyModel CreditSummary has a new parameter billing_currencyModel CreditSummary has a new parameter credit_currencyModel CreditSummary has a new parameter e_tagModel CreditSummary has a new parameter etagModel CreditSummary has a new parameter resellerModel EventSummary has a new parameter adjustments_in_billing_currencyModel EventSummary has a new parameter billing_currencyModel EventSummary has a new parameter billing_profile_display_nameModel EventSummary has a new parameter billing_profile_idModel EventSummary has a new parameter canceled_creditModel EventSummary has a new parameter charges_in_billing_currencyModel EventSummary has a new parameter closed_balance_in_billing_currencyModel EventSummary has a new parameter credit_currencyModel EventSummary has a new parameter credit_expired_in_billing_currencyModel EventSummary has a new parameter e_tagModel EventSummary has a new parameter e_tag_properties_e_tagModel EventSummary has a new parameter lot_idModel EventSummary has a new parameter lot_sourceModel EventSummary has a new parameter new_credit_in_billing_currencyModel EventSummary has a new parameter resellerModel LegacyChargeSummary has a new parameter e_tagModel LegacyReservationRecommendation has a new parameter etagModel LegacyReservationRecommendation has a new parameter resource_typeModel LegacyReservationTransaction has a new parameter billing_monthModel LegacyReservationTransaction has a new parameter monetary_commitmentModel LegacyReservationTransaction has a new parameter overageModel LegacyUsageDetail has a new parameter benefit_idModel LegacyUsageDetail has a new parameter benefit_nameModel LegacyUsageDetail has a new parameter etagModel LegacyUsageDetail has a new parameter pay_g_priceModel LegacyUsageDetail has a new parameter pricing_modelModel LotSummary has a new parameter billing_currencyModel LotSummary has a new parameter closed_balance_in_billing_currencyModel LotSummary has a new parameter credit_currencyModel LotSummary has a new parameter e_tagModel LotSummary has a new parameter e_tag_properties_e_tagModel LotSummary has a new parameter original_amount_in_billing_currencyModel LotSummary has a new parameter purchased_dateModel LotSummary has a new parameter resellerModel LotSummary has a new parameter statusModel ManagementGroupAggregatedCostResult has a new parameter etagModel Marketplace has a new parameter additional_infoModel Marketplace has a new parameter etagModel ModernChargeSummary has a new parameter e_tagModel ModernReservationRecommendation has a new parameter etagModel ModernReservationRecommendation has a new parameter location_properties_locationModel ModernReservationRecommendation has a new parameter sku_nameModel ModernUsageDetail has a new parameter benefit_idModel ModernUsageDetail has a new parameter benefit_nameModel ModernUsageDetail has a new parameter cost_allocation_rule_nameModel ModernUsageDetail has a new parameter effective_priceModel ModernUsageDetail has a new parameter etagModel ModernUsageDetail has a new parameter pay_g_priceModel ModernUsageDetail has a new parameter pricing_modelModel ModernUsageDetail has a new parameter providerModel Notification has a new parameter localeModel Operation has a new parameter idModel OperationDisplay has a new parameter descriptionModel PriceSheetResult has a new parameter downloadModel PriceSheetResult has a new parameter etagModel ReservationDetail has a new parameter etagModel ReservationRecommendation has a new parameter etagModel ReservationRecommendationDetailsModel has a new parameter etagModel ReservationRecommendationsListResult has a new parameter previous_linkModel ReservationSummary has a new parameter etagModel ReservationTransaction has a new parameter billing_monthModel ReservationTransaction has a new parameter monetary_commitmentModel ReservationTransaction has a new parameter overageModel Resource has a new parameter etagModel Tag has a new parameter valueModel TagsResult has a new parameter next_linkModel TagsResult has a new parameter previous_linkModel UsageDetail has a new parameter etagBreaking changesModel ChargeSummary no longer has parameter tagsModel EventSummary no longer has parameter tagsModel LegacyChargeSummary no longer has parameter tagsModel LotSummary no longer has parameter tagsModel ModernChargeSummary no longer has parameter tagsOperation ReservationRecommendationDetailsOperations.get has a new signatureParameter scope of model LegacyReservationRecommendation is now requiredParameter scope of model LegacyReservationRecommendation is now requiredRemoved operation EventsOperations.listRemoved operation LotsOperations.listRemoved operation group ForecastsOperations8.0.0 (2020-12-22)FeaturesModel ReservationRecommendationDetailsCalculatedSavingsProperties has a new parameter reserved_unit_countModel ReservationRecommendationDetailsModel has a new parameter locationModel ReservationRecommendationDetailsModel has a new parameter sku8.0.0b1 (2020-10-31)This is beta preview version.
For detailed changelog please refer to equivalent stable version 3.0.0(https://pypi.org/project/azure-mgmt-consumption/3.0.0/)This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).General breaking changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute no longer exists on a client, configuration should be passed as kwarg. Example:MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.3.0.0 (2018-05-16)FeaturesModel MeterDetails has a new parameter service_nameModel MeterDetails has a new parameter service_tierModel Filters has a new parameter tagsModel Marketplace has a new parameter is_recurring_chargeModel PriceSheetProperties has a new parameter offer_idAdded operation UsageDetailsOperations.downloadAdded operation group ForecastsOperationsAdded operation group ChargesOperationsAdded operation group TagsOperationsAdded operation group BalancesOperationsAdded operation group ReservationRecommendationsOperationsAdded operation group AggregatedCostOperationsBreaking changesModel UsageDetail has a new signatureRemoved operation
BudgetsOperations.create_or_update_by_resource_group_nameRemoved operation BudgetsOperations.get_by_resource_group_nameRemoved operation BudgetsOperations.list_by_resource_group_nameRemoved operation
BudgetsOperations.delete_by_resource_group_nameRemoved operation UsageDetailsOperations.list_by_billing_periodRemoved operation MarketplacesOperations.list_by_billing_periodGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes.Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:https://docs.python.org/3/library/enum.html#othersAt a glance:"is" should not be used at all."format" will return the string value, where "%s" string
formatting will returnNameOfEnum.stringvalue. Format syntax
should be prefered.New Long Running Operation:Return type changes frommsrestazure.azure_operation.AzureOperationPollertomsrest.polling.LROPoller. External API is the same.Return type is nowalwaysamsrest.polling.LROPoller,
regardless of the optional parameters used.The behavior has changed when usingraw=True. Instead of
returning the initial call result asClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as aClientRawResponse.Newpollingparameter. The default behavior isPolling=Truewhich will poll using ARM algorithm. WhenPolling=False, the response of the initial call will be
returned without polling.pollingparameter accepts instances of subclasses ofmsrest.polling.PollingMethod.add_done_callbackwill no longer raise if called after
polling is finished, but will instead execute the callback right
away.2.0.0 (2018-02-06)FeaturesMarketplace data with and without billing periodPrice sheets data with and without billing periodBudget CRUD operations supportBreaking changesRemoving scope from usage_details, reservation summaries and
details operations.1.1.0 (2017-12-12)FeaturesReservation summaries based on Reservation Order Id and/or
ReservationIdReservation details based on Reservation Order Id and/or
ReservationId1.0.0 (2017-11-15)FeaturesFeaturing stable api GA version 2017-11-30Supporting EA customers with azure consumption usage detailsBreaking changesRemoving support for calling usage_details.list() with
'invoice_id'. Will feature in future releases.0.1.0 (2017-05-18)Initial Release