azure-mgmt-costmanagement 5.0.0b1

Microsoft Azure Costmanagement Management Client Library for Python

Microsoft Azure SDK for Python

This is the Microsoft Azure Cost Management Client Library. This package has been tested with Python 3.10+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

• Python 3.10+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-costmanagement
pip install azure-identity

Authentication

By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

With above configuration, client can be authenticated by following code:

from azure.identity import DefaultAzureCredential
from azure.mgmt.costmanagement import CostManagementClient

client = CostManagementClient(credential=DefaultAzureCredential())

Examples

Code samples for this package can be found at:

• Search Cost Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

5.0.0b1 (2026-05-26)

Features Added

• Client CostManagementClient added parameter cloud_setting in method __init__
• Client CostManagementClient added method send_request
• Client CostManagementClient added operation group budgets
• Client CostManagementClient added operation group settings
• Client CostManagementClient added operation group cost_allocation_rules
• Client CostManagementClient added operation group generate_benefit_utilization_summaries_report
• Model Alert added property system_data
• Model BenefitRecommendationModel added property system_data
• Model BenefitResource added property system_data
• Model BenefitUtilizationSummary added property system_data
• Model CommonExportProperties added property data_overwrite_behavior
• Model CommonExportProperties added property compression_mode
• Model CommonExportProperties added property export_description
• Model CommonExportProperties added property system_suspension_context
• Model CostDetailsOperationResults added property manifest
• Model Export added property properties
• Model Export added property identity
• Model Export added property location
• Model Export added property system_data
• Model ExportDatasetConfiguration added property data_version
• Model ExportDatasetConfiguration added property filters
• Model ExportDeliveryDestination added property type
• Model ExportProperties added property data_overwrite_behavior
• Model ExportProperties added property compression_mode
• Model ExportProperties added property export_description
• Model ExportProperties added property system_suspension_context
• Enum ExportType added member FOCUS_COST
• Enum ExportType added member PRICE_SHEET
• Enum ExportType added member RESERVATION_DETAILS
• Enum ExportType added member RESERVATION_RECOMMENDATIONS
• Enum ExportType added member RESERVATION_TRANSACTIONS
• Model ForecastResult added property properties
• Enum FormatType added member PARQUET
• Model GenerateDetailedCostReportOperationResult added property properties
• Model GenerateDetailedCostReportOperationResult added property system_data
• Model GenerateDetailedCostReportOperationStatuses added property properties
• Model GenerateDetailedCostReportOperationStatuses added property system_data
• Enum GranularityType added member MONTHLY
• Model IncludedQuantityUtilizationSummary added property properties
• Model IncludedQuantityUtilizationSummary added property system_data
• Model OperationStatus added property properties
• Model ProxyResource added property system_data
• Model QueryResult added property properties
• Model Resource added property system_data
• Model SavingsPlanUtilizationSummary added property properties
• Model SavingsPlanUtilizationSummary added property system_data
• Enum TimeframeType added member THE_CURRENT_MONTH
• Model View added property system_data
• Added model ArmErrorResponse
• Added model AsyncOperationStatusProperties
• Added model BenefitUtilizationSummariesOperationStatus
• Added model BenefitUtilizationSummariesRequest
• Added enum BenefitUtilizationSummaryReportSchema
• Added model Budget
• Added model BudgetComparisonExpression
• Added model BudgetFilter
• Added model BudgetFilterProperties
• Added enum BudgetNotificationOperatorType
• Added enum BudgetOperatorType
• Added model BudgetProperties
• Added model BudgetTimePeriod
• Added enum CategoryType
• Added enum CompressionModeType
• Added enum CostAllocationPolicyType
• Added model CostAllocationProportion
• Added model CostAllocationResource
• Added enum CostAllocationResourceType
• Added model CostAllocationRuleCheckNameAvailabilityRequest
• Added model CostAllocationRuleCheckNameAvailabilityResponse
• Added model CostAllocationRuleDefinition
• Added model CostAllocationRuleDetails
• Added model CostAllocationRuleProperties
• Added enum CultureCode
• Added model CurrentSpend
• Added enum DataOverwriteBehaviorType
• Added enum DestinationType
• Added model ErrorAdditionalInfo
• Added model ErrorDetail
• Added model ExportRunRequest
• Added model ExportSuspensionContext
• Added model ExtensionResource
• Added enum FilterItemNames
• Added model FilterItems
• Added model ForecastSpend
• Added enum Frequency
• Added model MCAPriceSheetProperties
• Added model Notification
• Added model PricesheetDownloadProperties
• Added enum Reason
• Added model ReportConfigDefinition
• Added model RequestContext
• Added enum RuleStatus
• Added model Setting
• Added enum SettingType
• Added enum SettingsKind
• Added model SettingsListResult
• Added model SourceCostAllocationResource
• Added model SystemAssignedServiceIdentity
• Added enum SystemAssignedServiceIdentityType
• Added model TagInheritanceProperties
• Added model TagInheritanceSetting
• Added model TargetCostAllocationResource
• Added enum ThresholdType
• Added enum TimeGrainType
• Operation group PriceSheetOperations added method begin_download_by_billing_account
• Operation group PriceSheetOperations added method begin_download_by_invoice
• Added operation group BudgetsOperations
• Added operation group CostAllocationRulesOperations
• Added operation group GenerateBenefitUtilizationSummariesReportOperations
• Added operation group SettingsOperations

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
• Model CostDetailsOperationResults moved instance variable manifest_version, data_format, byte_count, blob_count, compress_data, blobs, request_scope and request_body under property manifest whose type is ReportManifest
• Model DismissAlertPayload moved instance variable definition, description, source, details, cost_entity_id, status, creation_time, close_time, modification_time, status_modification_user_name and status_modification_time under property properties whose type is AlertProperties
• Model Export moved instance variable format, delivery_info, definition, run_history, partition_data, next_run_time_estimate and schedule under property properties whose type is ExportProperties
• Model ForecastComparisonExpression renamed its instance variable values to values_property
• Model ForecastResult moved instance variable next_link, columns and rows under property properties whose type is ForecastProperties
• Model GenerateDetailedCostReportOperationResult moved instance variable expiry_time, valid_till and download_url under property properties whose type is DownloadURL
• Model GenerateDetailedCostReportOperationStatuses moved instance variable expiry_time, valid_till and download_url under property properties whose type is DownloadURL
• Model IncludedQuantityUtilizationSummary moved instance variable arm_sku_name, benefit_id, benefit_order_id, benefit_type, usage_date and utilization_percentage under property properties whose type is IncludedQuantityUtilizationSummaryProperties
• Model OperationStatus moved instance variable report_url and valid_until under property properties whose type is ReportURL
• Model QueryComparisonExpression renamed its instance variable values to values_property
• Model QueryResult moved instance variable next_link, columns and rows under property properties whose type is QueryProperties
• Model ReportConfigComparisonExpression renamed its instance variable values to values_property
• Model SavingsPlanUtilizationSummary moved instance variable arm_sku_name, benefit_id, benefit_order_id, benefit_type, usage_date, avg_utilization_percentage, min_utilization_percentage and max_utilization_percentage under property properties whose type is SavingsPlanUtilizationSummaryProperties
• Method BenefitRecommendationsOperations.list changed its parameter orderby/expand from positional_or_keyword to keyword_only
• Method BenefitUtilizationSummariesOperations.list_by_billing_account_id changed its parameter grain_parameter from positional_or_keyword to keyword_only
• Method BenefitUtilizationSummariesOperations.list_by_billing_profile_id changed its parameter grain_parameter from positional_or_keyword to keyword_only
• Method BenefitUtilizationSummariesOperations.list_by_savings_plan_id changed its parameter grain_parameter from positional_or_keyword to keyword_only
• Method BenefitUtilizationSummariesOperations.list_by_savings_plan_order changed its parameter grain_parameter from positional_or_keyword to keyword_only
• Method DimensionsOperations.by_external_cloud_provider_type changed its parameter expand/skiptoken from positional_or_keyword to keyword_only
• Method DimensionsOperations.list changed its parameter expand/skiptoken from positional_or_keyword to keyword_only
• Method ExportsOperations.get changed its parameter expand from positional_or_keyword to keyword_only
• Method ExportsOperations.list changed its parameter expand from positional_or_keyword to keyword_only
• Method GenerateReservationDetailsReportOperations.begin_by_billing_account_id changed its parameter start_date/end_date from positional_or_keyword to keyword_only
• Method GenerateReservationDetailsReportOperations.begin_by_billing_profile_id changed its parameter start_date/end_date from positional_or_keyword to keyword_only
• Deleted or renamed method PriceSheetOperations.begin_download
• Method ScheduledActionsOperations.create_or_update replaced positional_or_keyword parameter if_match with keyword_only parameters etag/match_condition
• Method ScheduledActionsOperations.create_or_update_by_scope replaced positional_or_keyword parameter if_match with keyword_only parameters etag/match_condition
• Method PriceSheetOperations.begin_download_by_billing_profile changed return type from LROPoller[DownloadURL] to LROPoller[PricesheetDownloadProperties]

Other Changes

• Deleted model ScheduledActionProxyResource which actually was not used by SDK users

4.0.1 (2023-07-19)

Bugs Fixed

• Fix deserialization error for some operation when error happens

4.0.0 (2023-05-22)

Features Added

• Added operation group BenefitRecommendationsOperations
• Added operation group BenefitUtilizationSummariesOperations
• Added operation group GenerateCostDetailsReportOperations
• Added operation group GenerateDetailedCostReportOperationResultsOperations
• Added operation group GenerateDetailedCostReportOperationStatusOperations
• Added operation group GenerateDetailedCostReportOperations
• Added operation group PriceSheetOperations
• Added operation group ScheduledActionsOperations
• Model Alert has a new parameter e_tag
• Model AlertPropertiesDetails has a new parameter company_name
• Model AlertPropertiesDetails has a new parameter department_name
• Model AlertPropertiesDetails has a new parameter enrollment_end_date
• Model AlertPropertiesDetails has a new parameter enrollment_number
• Model AlertPropertiesDetails has a new parameter enrollment_start_date
• Model AlertPropertiesDetails has a new parameter invoicing_threshold
• Model CommonExportProperties has a new parameter next_run_time_estimate
• Model CommonExportProperties has a new parameter partition_data
• Model CommonExportProperties has a new parameter run_history
• Model Dimension has a new parameter e_tag
• Model Dimension has a new parameter location
• Model Dimension has a new parameter sku
• Model Export has a new parameter next_run_time_estimate
• Model Export has a new parameter partition_data
• Model Export has a new parameter run_history
• Model ExportDeliveryDestination has a new parameter sas_token
• Model ExportDeliveryDestination has a new parameter storage_account
• Model ExportProperties has a new parameter next_run_time_estimate
• Model ExportProperties has a new parameter partition_data
• Model ExportProperties has a new parameter run_history
• Model Operation has a new parameter action_type
• Model Operation has a new parameter is_data_action
• Model Operation has a new parameter origin
• Model OperationDisplay has a new parameter description
• Operation ExportsOperations.get has a new optional parameter expand
• Operation ExportsOperations.list has a new optional parameter expand

Breaking Changes

• Model Alert no longer has parameter tags
• Model ProxyResource no longer has parameter e_tag
• Model ReportConfigFilter no longer has parameter tag_key
• Model ReportConfigFilter no longer has parameter tag_value
• Model Resource no longer has parameter tags
• Removed operation group SettingsOperations

4.0.0b1 (2022-11-07)

Features Added

• Added operation group BenefitRecommendationsOperations
• Added operation group BenefitUtilizationSummariesOperations
• Added operation group GenerateCostDetailsReportOperations
• Added operation group GenerateDetailedCostReportOperationResultsOperations
• Added operation group GenerateDetailedCostReportOperationStatusOperations
• Added operation group GenerateDetailedCostReportOperations
• Added operation group PriceSheetOperations
• Added operation group ScheduledActionsOperations
• Model Alert has a new parameter e_tag
• Model AlertPropertiesDetails has a new parameter company_name
• Model AlertPropertiesDetails has a new parameter department_name
• Model AlertPropertiesDetails has a new parameter enrollment_end_date
• Model AlertPropertiesDetails has a new parameter enrollment_number
• Model AlertPropertiesDetails has a new parameter enrollment_start_date
• Model AlertPropertiesDetails has a new parameter invoicing_threshold
• Model CommonExportProperties has a new parameter next_run_time_estimate
• Model CommonExportProperties has a new parameter partition_data
• Model CommonExportProperties has a new parameter run_history
• Model Dimension has a new parameter e_tag
• Model Dimension has a new parameter location
• Model Dimension has a new parameter sku
• Model Export has a new parameter next_run_time_estimate
• Model Export has a new parameter partition_data
• Model Export has a new parameter run_history
• Model ExportDeliveryDestination has a new parameter sas_token
• Model ExportDeliveryDestination has a new parameter storage_account
• Model ExportProperties has a new parameter next_run_time_estimate
• Model ExportProperties has a new parameter partition_data
• Model ExportProperties has a new parameter run_history
• Model Operation has a new parameter action_type
• Model Operation has a new parameter is_data_action
• Model Operation has a new parameter origin
• Model OperationDisplay has a new parameter description

Breaking Changes

• Model Alert no longer has parameter tags
• Model ProxyResource no longer has parameter e_tag
• Model ReportConfigFilter no longer has parameter tag_key
• Model ReportConfigFilter no longer has parameter tag_value
• Model Resource no longer has parameter tags
• Operation ExportsOperations.get has a new parameter expand
• Operation ExportsOperations.list has a new parameter expand
• Removed operation group SettingsOperations

3.0.0 (2021-07-27)

Breaking changes

• Parameter dataset of model QueryDefinition is now required
• Parameter dataset of model ForecastDefinition is now required

2.0.0 (2021-06-08)

Features

• Model QueryResult has a new parameter sku
• Model QueryResult has a new parameter e_tag
• Model QueryResult has a new parameter location
• Model View has a new parameter date_range
• Model View has a new parameter data_set
• Model View has a new parameter include_monetary_commitment
• Model View has a new parameter currency
• Model ExportExecution has a new parameter tags
• Added operation group GenerateReservationDetailsReportOperations
• Added operation group SettingsOperations

Breaking changes

• Parameter recurrence of model ExportSchedule is now required
• Operation ExportsOperations.list has a new signature
• Operation ExportsOperations.get has a new signature
• Model Export no longer has parameter run_history
• Model Export no longer has parameter next_run_time_estimate
• Model View no longer has parameter dataset
• Model ExportExecution no longer has parameter e_tag
• Model ExportExecution no longer has parameter error
• Model CommonExportProperties no longer has parameter run_history
• Model CommonExportProperties no longer has parameter next_run_time_estimate
• Model ExportProperties no longer has parameter run_history
• Model ExportProperties no longer has parameter next_run_time_estimate
• Model QueryFilter has a new signature
• Model ReportConfigFilter has a new signature

1.0.0 (2021-02-04)

Features

• Model ExportExecution has a new parameter e_tag

Breaking changes

• Model ExportExecution no longer has parameter tags

1.0.0b1 (2020-12-09)

This is beta preview version.

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 changes

• Credential system has been completly revamped:

  • azure.common.credentials or msrestazure.azure_active_directory instances are no longer supported, use the azure-identity classes instead: https://pypi.org/project/azure-identity/
  • credentials parameter has been renamed credential

• The config attribute 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 the parameters accept in init documentation of azure-core

• You can't import a version module anymore, use __version__ instead

• Operations that used to return a msrest.polling.LROPoller now returns a azure.core.polling.LROPoller and are prefixed with begin_.

• Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError (CloudError has been removed).

• Most of the operation kwarg have changed. Some of the most noticeable:

  • raw has been removed. Equivalent feature can be found using cls, a callback that will give access to internal HTTP response for advanced user
  • For a complete set of supported options, see the parameters accept in Request documentation of azure-core

0.2.0 (2020-04-08)

Features

• Added operation DimensionsOperations.list
• Added operation QueryOperations.usage

Breaking changes

• Model QueryDataset no longer has parameter sorting
• Removed operation DimensionsOperations.list_by_subscription
• Removed operation QueryOperations.usage_by_scope

General Breaking Changes

This version uses a next-generation code generator that might introduce breaking changes. In summary, some modules were incorrectly visible/importable and have been renamed. This fixed several issues caused by usage of classes that were not supposed to be used in the first place.

• CostManagementClient cannot be imported from azure.mgmt.costmanagement.cost_management_client anymore (import from azure.mgmt.costmanagement works like before)
• CostManagementClientConfiguration import has been moved from azure.mgmt.costmanagement.cost_management_client to azure.mgmt.costmanagement
• A model MyClass from a "models" sub-module cannot be imported anymore using azure.mgmt.costmanagement.models.my_class (import from azure.mgmt.costmanagement.models works like before)
• An operation class MyClassOperations from an operations sub-module cannot be imported anymore using azure.mgmt.costmanagement.operations.my_class_operations (import from azure.mgmt.costmanagement.operations works like before)

Last but not least, HTTP connection pooling is now enabled by default. You should always use a client as a context manager, or call close(), or use no more than one client per process.

0.1.0 (2019-05-04)

• Initial Release