Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn Rules API

6 actions 6 updates phrasing extends openapi/microsoft-azure-cdn-rules-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/{ruleSetName}/rules'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}'].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 Cdn Rules API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-rules-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/{ruleSetName}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List delivery rules in a rule set
      effect: read
      questions:
      - Which delivery rules are inside one of my Front Door rule sets?
      - Can I see the order of every rule in a rule set?
      instructions:
      - text: List the delivery rules in rule set {ruleset} of profile {profile}.
        slots:
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Show all rules defined inside {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}/rules/{ruleName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a delivery rule
      effect: read
      questions:
      - What conditions and actions does one of my delivery rules apply?
      - Where do I look up a single rule in a Front Door rule set?
      instructions:
      - text: Get delivery rule {rule} from rule set {ruleset} in profile {profile}.
        slots:
          rule: path.ruleName
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Show the conditions and actions of rule {rule} in {ruleset}, profile {profile}.
        slots:
          rule: path.ruleName
          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}/rules/{ruleName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a delivery rule to a rule set
      effect: write
      questions:
      - How do I add a header rewrite or redirect rule on Azure Front Door?
      - Can I set the order a new rule runs in within its rule set?
      instructions:
      - text: Create delivery rule {rule} in rule set {ruleset} of profile {profile}.
        slots:
          rule: path.ruleName
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Add a new rule named {rule} to {ruleset} on {profile} with {properties}.
        slots:
          rule: path.ruleName
          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}/rules/{ruleName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a delivery rule
      effect: destructive
      questions:
      - Can I remove one rule without deleting its whole rule set?
      - What happens to traffic once a delivery rule is deleted?
      instructions:
      - text: Delete delivery rule {rule} from rule set {ruleset} in profile {profile}.
        slots:
          rule: path.ruleName
          ruleset: path.ruleSetName
          profile: path.profileName
      - text: Remove rule {rule} out of {ruleset} on {profile} permanently.
        slots:
          rule: path.ruleName
          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}/rules/{ruleName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing delivery rule
      effect: write
      questions:
      - Can I change the conditions or actions of a rule I already created?
      - How do I reorder an existing delivery rule?
      instructions:
      - text: Update existing delivery rule {rule} in {ruleset} of {profile} with {properties}.
        slots:
          rule: path.ruleName
          ruleset: path.ruleSetName
          profile: path.profileName
          properties: requestBody.properties
      - text: Patch the actions of rule {rule} inside rule set {ruleset}, profile {profile}.
        slots:
          rule: path.ruleName
          ruleset: path.ruleSetName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'