Azure Cost Management · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for CostManagementClient Providers API
29 actions
29 updates
phrasing
extends
openapi/microsoft-azure-cost-management-providers-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Azure Cost Management's API. It is a proposal applied on top of the contract, not a document Azure Cost Management publishes.
What the actions change
x-apievangelist-phrasing
Targets 29 · first 16 shown; the file carries all of them
$.info
$.paths['/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations'].get
$.paths['/{scope}/providers/Microsoft.CostManagement/checkNameAvailability'].post
$.paths['/{scope}/providers/Microsoft.CostManagement/dimensions'].get
$.paths['/{scope}/providers/Microsoft.CostManagement/forecast'].post
$.paths['/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport'].post
$.paths['/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport'].post
$.paths['/{scope}/providers/Microsoft.CostManagement/query'].post
$.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts'].get
$.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions'].get
$.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast'].post
$.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query'].post
$.paths['/providers/Microsoft.CostManagement/checkNameAvailability'].post
$.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download'].post
$.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download'].post
$.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for CostManagementClient Providers API
version: 1.0.0
extends: openapi/microsoft-azure-cost-management-providers-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 28
- target: $.paths['/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations'].get
update:
x-apievangelist-phrasing:
intent: List savings plan purchase recommendations
effect: read
questions:
- 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?
- Which recommendation details, like usage history, can be expanded in the results?
instructions:
- text: List savings plan recommendations for billing scope {billingScope}.
slots:
billingScope: path.billingScope
- text: List savings plan recommendations for {billingScope} filtered by {filter}.
slots:
billingScope: path.billingScope
filter: query.$filter
- text: Get savings plan recommendations for {billingScope} expanded with {expand}, ordered by {orderby}.
slots:
billingScope: path.billingScope
expand: query.$expand
orderby: query.$orderby
method: generated
generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/checkNameAvailability'].post
update:
x-apievangelist-phrasing:
intent: Check a shared scheduled action name at a scope
effect: read
questions:
- 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?
instructions:
- text: Check whether a scheduled action name is available at scope {scope}.
slots:
scope: path.scope
- text: Validate a shared scheduled action name in {scope} before I create it.
slots:
scope: path.scope
method: generated
generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/dimensions'].get
update:
x-apievangelist-phrasing:
intent: List cost dimensions for an Azure scope
effect: read
questions:
- 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?
instructions:
- text: List cost dimensions available at scope {scope}.
slots:
scope: path.scope
- text: List dimensions at {scope} matching {filter}, returning the top {top}.
slots:
scope: path.scope
filter: query.$filter
top: query.$top
- text: Get the next page of dimensions at {scope} using skip token {skiptoken}.
slots:
scope: path.scope
skiptoken: query.$skiptoken
method: generated
generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/forecast'].post
update:
x-apievangelist-phrasing:
intent: Forecast Azure costs for a scope
effect: read
questions:
- What will my Azure subscription spend by the end of the month?
- Can a cost forecast include actual costs to date alongside the projection?
- How do I forecast costs for a custom time period at a billing scope?
instructions:
- text: Forecast {type} costs for scope {scope} over {timeframe} using dataset {dataset}.
slots:
type: requestBody.type
scope: path.scope
timeframe: requestBody.timeframe
dataset: requestBody.dataset
- text: Forecast {type} costs at {scope} for period {timePeriod} with timeframe {timeframe} and dataset {dataset}, including actual cost {includeActualCost}.
slots:
type: requestBody.type
scope: path.scope
timePeriod: requestBody.timePeriod
timeframe: requestBody.timeframe
dataset: requestBody.dataset
includeActualCost: requestBody.includeActualCost
method: generated
generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport'].post
update:
x-apievangelist-phrasing:
intent: Request a cost details report
effect: write
questions:
- 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?
- Is there a limit on how long a date range a cost details report can cover?
instructions:
- text: Generate a cost details report for scope {scope} covering {timePeriod}.
slots:
scope: path.scope
timePeriod: requestBody.timePeriod
- text: Generate a {metric} cost details report for {scope} for billing period {billingPeriod}.
slots:
metric: requestBody.metric
scope: path.scope
billingPeriod: requestBody.billingPeriod
- text: Generate a cost details report at {scope} for invoice {invoiceId}.
slots:
scope: path.scope
invoiceId: requestBody.invoiceId
method: generated
generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport'].post
update:
x-apievangelist-phrasing:
intent: Request a detailed cost report
effect: write
questions:
- 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?
instructions:
- text: Generate a detailed cost report for scope {scope} for date range {timePeriod}.
slots:
scope: path.scope
timePeriod: requestBody.timePeriod
- text: Generate a detailed {metric} cost report at {scope} for customer {customerId} and invoice {invoiceId}.
slots:
metric: requestBody.metric
scope: path.scope
customerId: requestBody.customerId
invoiceId: requestBody.invoiceId
- text: Start a detailed cost report at {scope} for billing period {billingPeriod}.
slots:
scope: path.scope
billingPeriod: requestBody.billingPeriod
method: generated
generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/query'].post
update:
x-apievangelist-phrasing:
intent: Query Azure cost and usage data for a scope
effect: read
questions:
- How much did each resource group cost me last month?
- Can I query actual or amortized costs grouped by service for a subscription?
- What were my daily Azure costs over a custom date range?
instructions:
- text: Query {type} costs for scope {scope} over {timeframe} with dataset {dataset}.
slots:
type: requestBody.type
scope: path.scope
timeframe: requestBody.timeframe
dataset: requestBody.dataset
- text: Query {type} usage at {scope} for period {timePeriod} with timeframe {timeframe} grouped by dataset {dataset}.
slots:
type: requestBody.type
scope: path.scope
timePeriod: requestBody.timePeriod
timeframe: requestBody.timeframe
dataset: requestBody.dataset
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts'].get
update:
x-apievangelist-phrasing:
intent: List cost alerts for an external cloud account
effect: read
questions:
- What cost alerts exist for my connected external cloud billing account?
- Can I list alerts for an external cloud provider connector by its ID?
instructions:
- text: List cost alerts for external cloud {externalCloudProviderType} account {externalCloudProviderId}.
slots:
externalCloudProviderType: path.externalCloudProviderType
externalCloudProviderId: path.externalCloudProviderId
- text: Show alerts on external billing account {externalCloudProviderId} of type {externalCloudProviderType}.
slots:
externalCloudProviderId: path.externalCloudProviderId
externalCloudProviderType: path.externalCloudProviderType
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions'].get
update:
x-apievangelist-phrasing:
intent: List cost dimensions for an external cloud account
effect: read
questions:
- Which dimensions can I group external cloud connector costs by?
- Can I filter the dimensions returned for an external cloud billing account?
instructions:
- text: List cost dimensions for external cloud {externalCloudProviderType} account {externalCloudProviderId}.
slots:
externalCloudProviderType: path.externalCloudProviderType
externalCloudProviderId: path.externalCloudProviderId
- text: List external account {externalCloudProviderId} ({externalCloudProviderType}) dimensions matching {filter}, top {top}.
slots:
externalCloudProviderId: path.externalCloudProviderId
externalCloudProviderType: path.externalCloudProviderType
filter: query.$filter
top: query.$top
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast'].post
update:
x-apievangelist-phrasing:
intent: Forecast costs for an external cloud account
effect: read
questions:
- What is the projected spend for my connected external cloud billing account?
- Can I forecast external cloud connector costs including actual cost so far?
instructions:
- text: Forecast {type} costs for external cloud {externalCloudProviderType} account {externalCloudProviderId} over {timeframe} with dataset {dataset}.
slots:
type: requestBody.type
externalCloudProviderType: path.externalCloudProviderType
externalCloudProviderId: path.externalCloudProviderId
timeframe: requestBody.timeframe
dataset: requestBody.dataset
- text: Project external account {externalCloudProviderId} ({externalCloudProviderType}) {type} spend for {timePeriod}, timeframe {timeframe}, dataset {dataset}.
slots:
externalCloudProviderId: path.externalCloudProviderId
externalCloudProviderType: path.externalCloudProviderType
type: requestBody.type
timePeriod: requestBody.timePeriod
timeframe: requestBody.timeframe
dataset: requestBody.dataset
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query'].post
update:
x-apievangelist-phrasing:
intent: Query cost data for an external cloud account
effect: read
questions:
- 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?
instructions:
- text: Query {type} costs for external cloud {externalCloudProviderType} account {externalCloudProviderId} over {timeframe} with dataset {dataset}.
slots:
type: requestBody.type
externalCloudProviderType: path.externalCloudProviderType
externalCloudProviderId: path.externalCloudProviderId
timeframe: requestBody.timeframe
dataset: requestBody.dataset
- text: Pull external account {externalCloudProviderId} ({externalCloudProviderType}) {type} usage for {timePeriod}, timeframe {timeframe}, dataset {dataset}.
slots:
externalCloudProviderId: path.externalCloudProviderId
externalCloudProviderType: path.externalCloudProviderType
type: requestBody.type
timePeriod: requestBody.timePeriod
timeframe: requestBody.timeframe
dataset: requestBody.dataset
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/Microsoft.CostManagement/checkNameAvailability'].post
update:
x-apievangelist-phrasing:
intent: Check a private scheduled action name
effect: read
questions:
- 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?
instructions:
- text: Check whether a name is available for my private scheduled action.
- text: Validate a private scheduled action name without a scope.
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download'].post
update:
x-apievangelist-phrasing:
intent: Download an Enterprise Agreement price sheet
effect: read
questions:
- 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?
instructions:
- text: Download the price sheet for enrollment {billingAccountId} for billing period {billingPeriodName}.
slots:
billingAccountId: path.billingAccountId
billingPeriodName: path.billingPeriodName
- text: Generate the EA price sheet for {billingAccountId} period {billingPeriodName}.
slots:
billingAccountId: path.billingAccountId
billingPeriodName: path.billingPeriodName
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download'].post
update:
x-apievangelist-phrasing:
intent: Download the price sheet for an invoice
effect: read
questions:
- 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?
instructions:
- text: Download the price sheet for invoice {invoiceName} on billing profile {billingProfileName} in account {billingAccountName}.
slots:
invoiceName: path.invoiceName
billingProfileName: path.billingProfileName
billingAccountName: path.billingAccountName
- text: Get the invoice price sheet URL for {invoiceName} under {billingAccountName} / {billingProfileName}.
slots:
invoiceName: path.invoiceName
billingAccountName: path.billingAccountName
billingProfileName: path.billingProfileName
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries'].get
update:
x-apievangelist-phrasing:
intent: List savings plan utilization for a billing profile
effect: read
questions:
- 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?
instructions:
- text: List savings plan utilization for billing profile {billingProfileId} in account {billingAccountId}.
slots:
billingProfileId: path.billingProfileId
billingAccountId: path.billingAccountId
- text: Show {grainParameter} benefit utilization for profile {billingProfileId} of {billingAccountId} filtered by {filter}.
slots:
grainParameter: query.grainParameter
billingProfileId: path.billingProfileId
billingAccountId: path.billingAccountId
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a utilization report for a billing profile
effect: write
questions:
- 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?
instructions:
- text: Generate a {grain} benefit utilization report for billing profile {billingProfileId} in account {billingAccountId} from {startDate} to {endDate}.
slots:
grain: requestBody.grain
billingProfileId: path.billingProfileId
billingAccountId: path.billingAccountId
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Generate a {kind} utilization report for profile {billingProfileId} of {billingAccountId}, {grain}, {startDate} to {endDate}.
slots:
kind: requestBody.kind
billingProfileId: path.billingProfileId
billingAccountId: path.billingAccountId
grain: requestBody.grain
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a reservation details report by profile
effect: write
questions:
- 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?
instructions:
- text: Generate a reservation details report for billing profile {billingProfileId} in account {billingAccountId} from {startDate} to {endDate}.
slots:
billingProfileId: path.billingProfileId
billingAccountId: path.billingAccountId
startDate: query.startDate
endDate: query.endDate
- text: Report reservation usage on profile {billingProfileId} of {billingAccountId} between {startDate} and {endDate}.
slots:
billingProfileId: path.billingProfileId
billingAccountId: path.billingAccountId
startDate: query.startDate
endDate: query.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download'].post
update:
x-apievangelist-phrasing:
intent: Download this month's price sheet for a profile
effect: read
questions:
- 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?
instructions:
- text: Download the current month's price sheet for billing profile {billingProfileName} in account {billingAccountName}.
slots:
billingProfileName: path.billingProfileName
billingAccountName: path.billingAccountName
- text: Get this month's price sheet link for {billingAccountName} profile {billingProfileName}.
slots:
billingAccountName: path.billingAccountName
billingProfileName: path.billingProfileName
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries'].get
update:
x-apievangelist-phrasing:
intent: List savings plan utilization for an EA account
effect: read
questions:
- 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?
instructions:
- text: List savings plan utilization for enrollment {billingAccountId}.
slots:
billingAccountId: path.billingAccountId
- text: Show {grainParameter} benefit utilization for EA account {billingAccountId} filtered by {filter}.
slots:
grainParameter: query.grainParameter
billingAccountId: path.billingAccountId
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability'].post
update:
x-apievangelist-phrasing:
intent: Check a cost allocation rule name
effect: read
questions:
- Is a cost allocation rule name already in use on my billing account?
- Can I validate an allocation rule name before creating the rule?
instructions:
- text: Check whether cost allocation rule name {name} is available on billing account {billingAccountId}.
slots:
name: requestBody.name
billingAccountId: path.billingAccountId
- text: Validate allocation rule name {name} of type {type} in {billingAccountId}.
slots:
name: requestBody.name
type: requestBody.type
billingAccountId: path.billingAccountId
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a utilization report for an enrollment
effect: write
questions:
- Can I export a benefit utilization report for an entire enterprise enrollment?
- Does generating a billing-account utilization report work for non-enrollment accounts?
instructions:
- text: Generate a {grain} benefit utilization report for enrollment {billingAccountId} from {startDate} to {endDate}.
slots:
grain: requestBody.grain
billingAccountId: path.billingAccountId
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Generate a {kind} utilization report for EA account {billingAccountId}, {grain}, {startDate} to {endDate}.
slots:
kind: requestBody.kind
billingAccountId: path.billingAccountId
grain: requestBody.grain
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a reservation details report by enrollment
effect: write
questions:
- 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?
instructions:
- text: Generate a reservation details report for enrollment {billingAccountId} from {startDate} to {endDate}.
slots:
billingAccountId: path.billingAccountId
startDate: query.startDate
endDate: query.endDate
- text: Report reservation usage for EA account {billingAccountId} between {startDate} and {endDate}.
slots:
billingAccountId: path.billingAccountId
startDate: query.startDate
endDate: query.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries'].get
update:
x-apievangelist-phrasing:
intent: List utilization for a savings plan order
effect: read
questions:
- How well is a savings plan order being used day by day?
- Can I see monthly utilization for every savings plan in one order?
instructions:
- text: List utilization summaries for savings plan order {savingsPlanOrderId}.
slots:
savingsPlanOrderId: path.savingsPlanOrderId
- text: Show {grainParameter} utilization for savings plan order {savingsPlanOrderId} filtered by {filter}.
slots:
grainParameter: query.grainParameter
savingsPlanOrderId: path.savingsPlanOrderId
filter: query.$filter
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a utilization report for a savings plan order
effect: write
questions:
- 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?
instructions:
- text: Generate a {grain} utilization report for savings plan order {savingsPlanOrderId} from {startDate} to {endDate}.
slots:
grain: requestBody.grain
savingsPlanOrderId: path.savingsPlanOrderId
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Export {kind} utilization for order {savingsPlanOrderId}, {grain}, {startDate} through {endDate}.
slots:
kind: requestBody.kind
savingsPlanOrderId: path.savingsPlanOrderId
grain: requestBody.grain
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries'].get
update:
x-apievangelist-phrasing:
intent: List utilization for one savings plan
effect: read
questions:
- Is a specific savings plan inside an order underused?
- Can I get daily utilization for a single savings plan rather than its whole order?
instructions:
- text: Show how much of the single savings plan {savingsPlanId} (from order {savingsPlanOrderId}) is being used.
slots:
savingsPlanId: path.savingsPlanId
savingsPlanOrderId: path.savingsPlanOrderId
- text: Show {grainParameter} utilization for plan {savingsPlanId} of order {savingsPlanOrderId} filtered by {filter}.
slots:
grainParameter: query.grainParameter
savingsPlanId: path.savingsPlanId
savingsPlanOrderId: path.savingsPlanOrderId
filter: query.$filter
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a utilization report for one savings plan
effect: write
questions:
- 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?
instructions:
- text: Build a {grain} report on just savings plan {savingsPlanId} (order {savingsPlanOrderId}) for {startDate} to {endDate}.
slots:
grain: requestBody.grain
savingsPlanId: path.savingsPlanId
savingsPlanOrderId: path.savingsPlanOrderId
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Export {kind} utilization for plan {savingsPlanId} of order {savingsPlanOrderId}, {grain}, {startDate} through {endDate}.
slots:
kind: requestBody.kind
savingsPlanId: path.savingsPlanId
savingsPlanOrderId: path.savingsPlanOrderId
grain: requestBody.grain
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a utilization report for a reservation order
effect: write
questions:
- How do I export utilization for all reservations in a reservation order?
- Can I generate a monthly utilization report for a reserved instance order?
instructions:
- text: Generate a {grain} utilization report for reservation order {reservationOrderId} from {startDate} to {endDate}.
slots:
grain: requestBody.grain
reservationOrderId: path.reservationOrderId
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Export {kind} utilization for reservation order {reservationOrderId}, {grain}, {startDate} through {endDate}.
slots:
kind: requestBody.kind
reservationOrderId: path.reservationOrderId
grain: requestBody.grain
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/providers/microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport'].post
update:
x-apievangelist-phrasing:
intent: Generate a utilization report for one reservation
effect: write
questions:
- 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?
instructions:
- text: Build a {grain} report on the single reserved instance {reservationId} (order {reservationOrderId}) for {startDate} to {endDate}.
slots:
grain: requestBody.grain
reservationId: path.reservationId
reservationOrderId: path.reservationOrderId
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Check how fully reservation {reservationId} in {reservationOrderId} was used, as a {kind} {grain} report from {startDate} until {endDate}.
slots:
reservationId: path.reservationId
reservationOrderId: path.reservationOrderId
kind: requestBody.kind
grain: requestBody.grain
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'