Azure Cost Management Providers API
The tenant- and scope-level Cost Management surface that is not a managed resource: Query, Forecast, Dimensions, cost details and detailed cost report generation, price sheet downloads, benefit recommendations and benefit utilization summaries.
Operations 28
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations
List savings plan purchase recommendations · Benefit recommendations list
#
Ask an LLM
“Should I buy an Azure savings plan, and how much commitment is recommended for my subscription?”
“Can I see savings plan recommendations for a single scope rather than shared?”
Tell an agent
List savings plan recommendations for billing scope {billingScope}.
List savings plan recommendations for {billingScope} filtered by {filter}.
POST
/{scope}/providers/Microsoft.CostManagement/checkNameAvailability
Check a shared scheduled action name at a scope · Scheduled actions check name availability by scope
#
Ask an LLM
“Is a name already taken for a shared scheduled action on my subscription?”
“Can I validate a scheduled action name within a specific scope before creating it?”
Tell an agent
Check whether a scheduled action name is available at scope {scope}.
Validate a shared scheduled action name in {scope} before I create it.
GET
/{scope}/providers/Microsoft.CostManagement/dimensions
List cost dimensions for an Azure scope · Dimensions list
#
Ask an LLM
“Which dimensions, like resource group or meter category, can I group my Azure costs by?”
“Can I page through the dimension values available at a subscription scope?”
Tell an agent
List cost dimensions available at scope {scope}.
List dimensions at {scope} matching {filter}, returning the top {top}.
POST
/{scope}/providers/Microsoft.CostManagement/forecast
Forecast Azure costs for a scope · Forecast usage
#
Ask an LLM
“What will my Azure subscription spend by the end of the month?”
“Can a cost forecast include actual costs to date alongside the projection?”
Tell an agent
Forecast {type} costs for scope {scope} over {timeframe} using dataset {dataset}.
Forecast {type} costs at {scope} for period {timePeriod} with timeframe {timeframe} and dataset {dataset}, including actual cost {includeActualCost}.
POST
/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport
Request a cost details report · Generate cost details report create operation
#
Ask an LLM
“What's the current way to get line-item usage details for my subscription now that the older usage APIs are replaced?”
“Can I generate a cost details report for a specific invoice on a Microsoft Customer Agreement?”
Tell an agent
Generate a cost details report for scope {scope} covering {timePeriod}.
Generate a {metric} cost details report for {scope} for billing period {billingPeriod}.
POST
/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport
Request a detailed cost report · Generate detailed cost report create operation
#
Ask an LLM
“Can I request a detailed cost report for one customer under my billing account?”
“Which operation kicks off a detailed cost report that I then poll via the Azure-Consumption-AsyncOperation header?”
Tell an agent
Generate a detailed cost report for scope {scope} for date range {timePeriod}.
Generate a detailed {metric} cost report at {scope} for customer {customerId} and invoice {invoiceId}.
POST
/{scope}/providers/Microsoft.CostManagement/query
Query Azure cost and usage data for a scope · Query usage
#
Ask an LLM
“How much did each resource group cost me last month?”
“Can I query actual or amortized costs grouped by service for a subscription?”
Tell an agent
Query {type} costs for scope {scope} over {timeframe} with dataset {dataset}.
Query {type} usage at {scope} for period {timePeriod} with timeframe {timeframe} grouped by dataset {dataset}.
GET
/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts
List cost alerts for an external cloud account · Alerts list external
#
Ask an LLM
“What cost alerts exist for my connected external cloud billing account?”
“Can I list alerts for an external cloud provider connector by its ID?”
Tell an agent
List cost alerts for external cloud {externalCloudProviderType} account {externalCloudProviderId}.
Show alerts on external billing account {externalCloudProviderId} of type {externalCloudProviderType}.
GET
/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions
List cost dimensions for an external cloud account · Dimensions by external cloud provider type
#
Ask an LLM
“Which dimensions can I group external cloud connector costs by?”
“Can I filter the dimensions returned for an external cloud billing account?”
Tell an agent
List cost dimensions for external cloud {externalCloudProviderType} account {externalCloudProviderId}.
List external account {externalCloudProviderId} ({externalCloudProviderType}) dimensions matching {filter}, top {top}.
POST
/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast
Forecast costs for an external cloud account · Forecast external cloud provider usage
#
Ask an LLM
“What is the projected spend for my connected external cloud billing account?”
“Can I forecast external cloud connector costs including actual cost so far?”
Tell an agent
Forecast {type} costs for external cloud {externalCloudProviderType} account {externalCloudProviderId} over {timeframe} with dataset {dataset}.
Project external account {externalCloudProviderId} ({externalCloudProviderType}) {type} spend for {timePeriod}, timeframe {timeframe}, dataset {dataset}.
POST
/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query
Query cost data for an external cloud account · Query usage by external cloud provider type
#
Ask an LLM
“How much did my connected external cloud account cost last month by service?”
“Can I query usage for an external cloud consolidated or member account?”
Tell an agent
Query {type} costs for external cloud {externalCloudProviderType} account {externalCloudProviderId} over {timeframe} with dataset {dataset}.
Pull external account {externalCloudProviderId} ({externalCloudProviderType}) {type} usage for {timePeriod}, timeframe {timeframe}, dataset {dataset}.
POST
/providers/Microsoft.CostManagement/checkNameAvailability
Check a private scheduled action name · Scheduled actions check name availability
#
Ask an LLM
“Is a name free to use for one of my private scheduled actions?”
“Can I check a private scheduled action name is valid before I create it?”
Tell an agent
Check whether a name is available for my private scheduled action.
Validate a private scheduled action name without a scope.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download
Download an Enterprise Agreement price sheet · Price sheet download by billing account
#
Ask an LLM
“Where can I get my Enterprise Agreement price sheet for a past billing period?”
“Can I download EA prices, including reserved instance prices, by enrollment and period?”
Tell an agent
Download the price sheet for enrollment {billingAccountId} for billing period {billingPeriodName}.
Generate the EA price sheet for {billingAccountId} period {billingPeriodName}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download
Download the price sheet for an invoice · Price sheet download by invoice
#
Ask an LLM
“Can I get the prices that applied to a specific invoice on my Microsoft Customer Agreement?”
“Where do I download an invoice's price sheet for a partner agreement billing account?”
Tell an agent
Download the price sheet for invoice {invoiceName} on billing profile {billingProfileName} in account {billingAccountName}.
Get the invoice price sheet URL for {invoiceName} under {billingAccountName} / {billingProfileName}.
GET
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
List savings plan utilization for a billing profile · Benefit utilization summaries list by billing profile id
#
Ask an LLM
“How well are the savings plans on my billing profile being used each month?”
“Can I see daily savings plan utilization for a Microsoft Customer Agreement billing profile?”
Tell an agent
List savings plan utilization for billing profile {billingProfileId} in account {billingAccountId}.
Show {grainParameter} benefit utilization for profile {billingProfileId} of {billingAccountId} filtered by {filter}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
Generate a utilization report for a billing profile · Generate benefit utilization summaries report generate by billing profile
#
Ask an LLM
“Can I export a benefit utilization report for one billing profile over a date range?”
“What grain options are there when generating a billing profile utilization report?”
Tell an agent
Generate a {grain} benefit utilization report for billing profile {billingProfileId} in account {billingAccountId} from {startDate} to {endDate}.
Generate a {kind} utilization report for profile {billingProfileId} of {billingAccountId}, {grain}, {startDate} to {endDate}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport
Generate a reservation details report by profile · Generate reservation details report by billing profile id
#
Ask an LLM
“Can I get reservation usage details for a billing profile over a date range?”
“Which roles are allowed to view reservation details for a Customer Agreement billing profile?”
Tell an agent
Generate a reservation details report for billing profile {billingProfileId} in account {billingAccountId} from {startDate} to {endDate}.
Report reservation usage on profile {billingProfileId} of {billingAccountId} between {startDate} and {endDate}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download
Download this month's price sheet for a profile · Price sheet download by billing profile
#
Ask an LLM
“Where can I download the current month's prices for my billing profile?”
“Can I get a price sheet URL for a billing profile without picking an invoice?”
Tell an agent
Download the current month's price sheet for billing profile {billingProfileName} in account {billingAccountName}.
Get this month's price sheet link for {billingAccountName} profile {billingProfileName}.
GET
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
List savings plan utilization for an EA account · Benefit utilization summaries list by billing account id
#
Ask an LLM
“How much of our savings plan commitment is being used across the whole enterprise enrollment?”
“Can I get monthly savings plan utilization for an Enterprise Agreement billing account?”
Tell an agent
List savings plan utilization for enrollment {billingAccountId}.
Show {grainParameter} benefit utilization for EA account {billingAccountId} filtered by {filter}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability
Check a cost allocation rule name · Cost allocation rules check name availability
#
Ask an LLM
“Is a cost allocation rule name already in use on my billing account?”
“Can I validate an allocation rule name before creating the rule?”
Tell an agent
Check whether cost allocation rule name {name} is available on billing account {billingAccountId}.
Validate allocation rule name {name} of type {type} in {billingAccountId}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
Generate a utilization report for an enrollment · Generate benefit utilization summaries report generate by billing account
#
Ask an LLM
“Can I export a benefit utilization report for an entire enterprise enrollment?”
“Does generating a billing-account utilization report work for non-enrollment accounts?”
Tell an agent
Generate a {grain} benefit utilization report for enrollment {billingAccountId} from {startDate} to {endDate}.
Generate a {kind} utilization report for EA account {billingAccountId}, {grain}, {startDate} to {endDate}.
POST
/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport
Generate a reservation details report by enrollment · Generate reservation details report by billing account id
#
Ask an LLM
“Can I get reservation usage details for my whole enrollment over a date range?”
“Which enterprise roles can view the reservation details report for an EA enrollment?”
Tell an agent
Generate a reservation details report for enrollment {billingAccountId} from {startDate} to {endDate}.
Report reservation usage for EA account {billingAccountId} between {startDate} and {endDate}.
GET
/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
List utilization for a savings plan order · Benefit utilization summaries list by savings plan order
#
Ask an LLM
“How well is a savings plan order being used day by day?”
“Can I see monthly utilization for every savings plan in one order?”
Tell an agent
List utilization summaries for savings plan order {savingsPlanOrderId}.
Show {grainParameter} utilization for savings plan order {savingsPlanOrderId} filtered by {filter}.
POST
/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
Generate a utilization report for a savings plan order · Generate benefit utilization summaries report generate by savings plan order id
#
Ask an LLM
“Can I export a utilization report covering a whole savings plan order?”
“What date range and grain do I set when generating a savings plan order report?”
Tell an agent
Generate a {grain} utilization report for savings plan order {savingsPlanOrderId} from {startDate} to {endDate}.
Export {kind} utilization for order {savingsPlanOrderId}, {grain}, {startDate} through {endDate}.
GET
/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries
List utilization for one savings plan · Benefit utilization summaries list by savings plan id
#
Ask an LLM
“Is a specific savings plan inside an order underused?”
“Can I get daily utilization for a single savings plan rather than its whole order?”
Tell an agent
Show how much of the single savings plan {savingsPlanId} (from order {savingsPlanOrderId}) is being used.
Show {grainParameter} utilization for plan {savingsPlanId} of order {savingsPlanOrderId} filtered by {filter}.
POST
/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
Generate a utilization report for one savings plan · Generate benefit utilization summaries report generate by savings plan id
#
Ask an LLM
“Can I export a utilization report for just one savings plan in an order?”
“Which dates and grain does a single savings plan utilization report need?”
Tell an agent
Build a {grain} report on just savings plan {savingsPlanId} (order {savingsPlanOrderId}) for {startDate} to {endDate}.
Export {kind} utilization for plan {savingsPlanId} of order {savingsPlanOrderId}, {grain}, {startDate} through {endDate}.
POST
/providers/microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
Generate a utilization report for a reservation order · Generate benefit utilization summaries report generate by reservation order id
#
Ask an LLM
“How do I export utilization for all reservations in a reservation order?”
“Can I generate a monthly utilization report for a reserved instance order?”
Tell an agent
Generate a {grain} utilization report for reservation order {reservationOrderId} from {startDate} to {endDate}.
Export {kind} utilization for reservation order {reservationOrderId}, {grain}, {startDate} through {endDate}.
POST
/providers/microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport
Generate a utilization report for one reservation · Generate benefit utilization summaries report generate by reservation id
#
Ask an LLM
“Is a single reserved instance being fully used, and can I export that as a report?”
“Can I generate a daily utilization report for one reservation inside an order?”
Tell an agent
Build a {grain} report on the single reserved instance {reservationId} (order {reservationOrderId}) for {startDate} to {endDate}.
Check how fully reservation {reservationId} in {reservationOrderId} was used, as a {kind} {grain} report from {startDate} until {endDate}.
Documentation
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/cost-management/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/cost-management/