Azure Cost Management · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CostManagementClient Alerts API

4 actions 4 updates phrasing extends openapi/microsoft-azure-cost-management-alerts-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 4

$.info

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

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

$.paths['/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}'].patch

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 Alerts API
  version: 1.0.0
extends: openapi/microsoft-azure-cost-management-alerts-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: 3
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost alerts for a scope
      effect: read
      questions:
      - How do I see all the cost alerts raised for my Azure subscription?
      - Which budget and usage alerts are currently active at a given billing scope?
      - Can I pull every cost alert for a resource group in one call?
      instructions:
      - text: List all cost alerts for scope {scope}.
        slots:
          scope: path.scope
      - text: Show me every alert raised at {scope}.
        slots:
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one cost alert by ID
      effect: read
      questions:
      - What are the details of a specific cost alert I was notified about?
      - Can I look up a single alert by its ID to see what triggered it?
      instructions:
      - text: Get alert {alertId} at scope {scope}.
        slots:
          alertId: path.alertId
          scope: path.scope
      - text: Show me what triggered cost alert {alertId} in {scope}.
        slots:
          alertId: path.alertId
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Dismiss a cost alert
      effect: write
      questions:
      - How do I dismiss a cost alert I've already dealt with?
      - Can I mark an alert as dismissed so it stops showing as active?
      instructions:
      - text: Dismiss alert {alertId} at scope {scope}.
        slots:
          alertId: path.alertId
          scope: path.scope
      - text: Mark cost alert {alertId} in {scope} as dismissed.
        slots:
          alertId: path.alertId
          scope: path.scope
      method: generated
      generated: '2026-10-01'