Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn AFD Endpoints API

9 actions 9 updates phrasing extends openapi/microsoft-azure-cdn-afdendpoints-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 9

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/usages'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/validateCustomDomain'].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 AFD Endpoints API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-afdendpoints-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: 8
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List Front Door endpoints in a profile
      effect: read
      questions:
      - Which endpoints exist on my Azure Front Door profile?
      - Can I get all AFD endpoints for a Standard or Premium profile in one call?
      instructions:
      - text: List the Front Door endpoints in profile {profile}.
        slots:
          profile: path.profileName
      - text: Show every AFD endpoint under {profile}.
        slots:
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Front Door endpoint
      effect: read
      questions:
      - What hostname and enabled state does one of my Front Door endpoints have?
      - Where do I look up the details of a single AFD endpoint?
      instructions:
      - text: Get Front Door endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Show the configuration of AFD endpoint {endpoint} on {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Front Door endpoint
      effect: write
      questions:
      - How do I add a new endpoint to my Azure Front Door profile?
      - Can I choose the endpoint name when I create a Front Door endpoint?
      instructions:
      - text: Create Front Door endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Add a new AFD endpoint named {endpoint} to {profile} using {properties}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Front Door endpoint
      effect: destructive
      questions:
      - What happens to traffic when I delete an AFD endpoint?
      - Can I remove a Front Door endpoint I no longer need?
      instructions:
      - text: Delete Front Door endpoint {endpoint} from profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Remove AFD endpoint {endpoint} from {profile} permanently.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags or state of a Front Door endpoint
      effect: write
      questions:
      - Can I change the tags or enabled state of an existing Front Door endpoint?
      - Which settings of an AFD endpoint can be modified after it is created?
      instructions:
      - text: Update the tags on Front Door endpoint {endpoint} in {profile} to {tags}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
          tags: requestBody.tags
      - text: Patch AFD endpoint {endpoint} on profile {profile} with {properties}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge cached content from a Front Door endpoint
      effect: write
      questions:
      - How do I clear cached files from Azure Front Door after a deploy?
      - Can I purge content for only specific domains on a Front Door endpoint?
      instructions:
      - text: Purge {paths} from Front Door endpoint {endpoint} in {profile}.
        slots:
          paths: requestBody.contentPaths
          endpoint: path.endpointName
          profile: path.profileName
      - text: Clear the AFD cache for {paths} on domains {domains} at endpoint {endpoint}, profile {profile}.
        slots:
          paths: requestBody.contentPaths
          domains: requestBody.domains
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/usages'].post
  update:
    x-apievangelist-phrasing:
      intent: Check quota usage of a Front Door endpoint
      effect: read
      questions:
      - How close is my Front Door endpoint to its resource quota?
      - What are the usage limits for routes on a single AFD endpoint?
      instructions:
      - text: Check the quota and usage of Front Door endpoint {endpoint} in {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Show resource usage for AFD endpoint {endpoint} on profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/validateCustomDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a domain's DNS mapping to a Front Door endpoint
      effect: read
      questions:
      - Is my custom hostname's CNAME pointing at the right Front Door endpoint?
      - Can I test DNS mapping of a domain before attaching it to an AFD endpoint?
      instructions:
      - text: Validate that {host} maps to Front Door endpoint {endpoint} in {profile}.
        slots:
          host: requestBody.hostName
          endpoint: path.endpointName
          profile: path.profileName
      - text: Check the DNS of hostname {host} against AFD endpoint {endpoint} on profile {profile}.
        slots:
          host: requestBody.hostName
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'