Azure Cost Management · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cost Management Exports API

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

$.info
$.paths['/{scope}/providers/Microsoft.CostManagement/exports'].get
$.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}'].get
$.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}'].put
$.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}'].delete
$.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run'].post
$.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory'].get
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/exports'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Cost Management Exports API
  version: 1.0.0
extends: openapi/microsoft-azure-cost-management-exports-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: 12
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost exports at any scope
      effect: read
      questions:
      - What scheduled cost data exports are configured at my billing scope?
      - Can I include each export's last run status when listing exports at a scope?
      instructions:
      - text: List all cost exports at scope {scope}.
        slots:
          scope: path.scope
      - text: List exports at {scope} expanded with {expand}.
        slots:
          scope: path.scope
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cost export at a scope by name
      effect: read
      questions:
      - Where does a particular cost export write its files and on what schedule?
      - Can I get one export's definition at a billing scope along with its recent run history?
      instructions:
      - text: Get cost export {exportName} at scope {scope}.
        slots:
          exportName: path.exportName
          scope: path.scope
      - text: Show export {exportName} in {scope} expanded with {expand}.
        slots:
          exportName: path.exportName
          scope: path.scope
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a scheduled cost export
      effect: write
      questions:
      - How do I set up a daily export of cost data to a storage account at a billing scope?
      - Why does updating an existing export need the latest eTag?
      instructions:
      - text: Create cost export {exportName} at scope {scope} with definition {properties}.
        slots:
          exportName: path.exportName
          scope: path.scope
          properties: requestBody.properties
      - text: Update export {exportName} in {scope} to {properties} using eTag {eTag}.
        slots:
          exportName: path.exportName
          scope: path.scope
          properties: requestBody.properties
          eTag: requestBody.eTag
      - text: Create export {exportName} in {scope} with a managed identity {identity} in region {location} and definition {properties}.
        slots:
          exportName: path.exportName
          scope: path.scope
          identity: requestBody.identity
          location: requestBody.location
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cost export at a scope
      effect: destructive
      questions:
      - How do I stop and remove a cost export at my billing account scope?
      - Can I delete an export by name at any scope, such as a management group?
      instructions:
      - text: Delete cost export {exportName} at scope {scope}.
        slots:
          exportName: path.exportName
          scope: path.scope
      - text: Remove the {exportName} export configured at {scope}.
        slots:
          exportName: path.exportName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a cost export now
      effect: write
      questions:
      - Can I trigger a cost export immediately instead of waiting for its schedule?
      - Is it possible to run an export on demand for a custom date range?
      instructions:
      - text: Run export {exportName} at scope {scope} now.
        slots:
          exportName: path.exportName
          scope: path.scope
      - text: Run export {exportName} in {scope} for the period {timePeriod}.
        slots:
          exportName: path.exportName
          scope: path.scope
          timePeriod: requestBody.timePeriod
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an export's run history
      effect: read
      questions:
      - Did my cost export succeed the last few times it ran?
      - When did an export last run and were there any failures?
      instructions:
      - text: Show the run history of export {exportName} at scope {scope}.
        slots:
          exportName: path.exportName
          scope: path.scope
      - text: List past executions of cost export {exportName} in {scope}.
        slots:
          exportName: path.exportName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List export resources in a subscription
      effect: read
      questions:
      - Which export resources exist across a whole subscription, by subscription ID?
      - Can I list every exports resource in a subscription without naming a scope path?
      instructions:
      - text: List all export resources in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Show every exports resource under subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List export resources in a resource group
      effect: read
      questions:
      - What export resources are deployed in a specific resource group?
      - Can I list exports resources for just one resource group in a subscription?
      instructions:
      - text: List export resources in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the exports resources inside {resourceGroupName} under {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an export resource in a resource group
      effect: read
      questions:
      - How do I fetch one exports resource from a resource group by its name?
      - Can I read a resource-group export resource's tags and location?
      instructions:
      - text: Get export resource {name} in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Fetch the exports resource {name} from {resourceGroupName} in {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an export resource in a resource group
      effect: write
      questions:
      - How do I deploy an exports resource into a resource group with tags and a location?
      - Can I replace a resource-group export resource's full definition with a PUT?
      instructions:
      - text: Create export resource {name} in resource group {resourceGroupName} of subscription {subscriptionId} in {location}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          location: requestBody.location
      - text: Create or replace exports resource {name} in {resourceGroupName} under {subscriptionId} with tags {tags} and properties {properties}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          tags: requestBody.tags
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an export resource in a resource group
      effect: destructive
      questions:
      - How do I delete an exports resource from a specific resource group?
      - Can I remove a resource-group export resource by subscription, group and name?
      instructions:
      - text: Delete export resource {name} from resource group {resourceGroupName} in subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the exports resource {name} in {resourceGroupName} under {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/exports/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an export resource in a resource group
      effect: write
      questions:
      - Can I partially update an exports resource in a resource group with a PATCH?
      - Is there a way to modify a resource-group export resource without recreating it?
      instructions:
      - text: Patch export resource {name} in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Apply a partial update to exports resource {name} in {resourceGroupName} under {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'