Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn Rule Sets API

6 actions 6 updates phrasing extends openapi/microsoft-azure-cdn-rulesets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure Cdn's API. It is a proposal applied on top of the contract, not a document Microsoft Azure Cdn publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages'].post

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 Cdn Rule Sets API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-rulesets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule sets in a Front Door profile
      effect: read
      questions:
      - Which rule sets exist on my Azure Front Door profile?
      - Can I see all rule sets available to attach to routes?
      instructions:
      - text: List the rule sets in Front Door profile {profile}.
        slots:
          profile: path.profileName
      - text: Show every rule set configured under {profile}.
        slots:
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Front Door rule set
      effect: read
      questions:
      - What is the provisioning state of one of my rule sets?
      - Where can I look up a single rule set by name?
      instructions:
      - text: Get rule set {ruleset} in Front Door profile {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Show details of rule set {ruleset} on {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Front Door rule set
      effect: write
      questions:
      - How do I create a container for delivery rules on Front Door?
      - Can I create a rule set along with its rules in one request?
      instructions:
      - text: Create rule set {ruleset} in Front Door profile {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Add a new rule set named {ruleset} to {profile} with {properties}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Front Door rule set
      effect: destructive
      questions:
      - Can I delete a rule set that routes no longer reference?
      - Does deleting a rule set also remove the rules inside it?
      instructions:
      - text: Delete rule set {ruleset} from Front Door profile {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Remove the {ruleset} rule set from {profile} permanently.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages'].post
  update:
    x-apievangelist-phrasing:
      intent: Check quota usage of a rule set
      effect: read
      questions:
      - How many more rules can I add before a rule set hits its quota?
      - What is the current resource usage for a specific rule set?
      instructions:
      - text: Check the quota and usage of rule set {ruleset} in {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Show resource usage for rule set {ruleset} on profile {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'