Azure Cost Management · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CostManagementClient Budgets API

5 actions 5 updates phrasing extends openapi/microsoft-azure-cost-management-budgets-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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/{scope}/providers/Microsoft.CostManagement/budgets'].get

$.paths['/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}'].get

$.paths['/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}'].put

$.paths['/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}'].delete

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 Budgets API
  version: 1.0.0
extends: openapi/microsoft-azure-cost-management-budgets-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: 4
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/budgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List budgets for a scope
      effect: read
      questions:
      - What budgets are set up on my Azure subscription?
      - Can I filter the budgets at a scope, for example by category?
      - How do I see every spending budget defined for a resource group?
      instructions:
      - text: List all budgets at scope {scope}.
        slots:
          scope: path.scope
      - text: List the budgets at {scope} matching filter {filter}.
        slots:
          scope: path.scope
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a budget by name
      effect: read
      questions:
      - How much is left in a particular budget and what are its thresholds?
      - Can I read one budget's amount, time period and notifications by name?
      instructions:
      - text: Get budget {budgetName} at scope {scope}.
        slots:
          budgetName: path.budgetName
          scope: path.scope
      - text: Show me the current spend and notification settings of budget {budgetName} in {scope}.
        slots:
          budgetName: path.budgetName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a budget
      effect: write
      questions:
      - How do I set a monthly spending budget with alert thresholds on a subscription?
      - Can I change an existing budget's amount, and do I need its eTag to do it safely?
      instructions:
      - text: 'Create budget {budgetName} at scope {scope} with these settings: {properties}.'
        slots:
          budgetName: path.budgetName
          scope: path.scope
          properties: requestBody.properties
      - text: Update budget {budgetName} in {scope} to {properties} using eTag {eTag}.
        slots:
          budgetName: path.budgetName
          scope: path.scope
          properties: requestBody.properties
          eTag: requestBody.eTag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a budget
      effect: destructive
      questions:
      - How do I remove a budget I no longer need?
      - Can I delete a budget from a resource group without affecting the others?
      instructions:
      - text: Delete budget {budgetName} at scope {scope}.
        slots:
          budgetName: path.budgetName
          scope: path.scope
      - text: Remove the {budgetName} budget from {scope}.
        slots:
          budgetName: path.budgetName
          scope: path.scope
      method: generated
      generated: '2026-10-01'