Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn AFD Domains API

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

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}/refreshValidationToken'].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 Domains API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-afddomains-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: 6
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains'].get
  update:
    x-apievangelist-phrasing:
      intent: List Front Door custom domains in a profile
      effect: read
      questions:
      - Which custom domains are attached to my Azure Front Door profile?
      - Can I see every domain configured on a Front Door Standard or Premium profile at once?
      instructions:
      - text: List all custom domains in Front Door profile {profile}.
        slots:
          profile: path.profileName
      - text: Show me the domains registered on profile {profile}.
        slots:
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Front Door custom domain
      effect: read
      questions:
      - What is the validation state and TLS setup of one of my Front Door custom domains?
      - Where can I look up the details of a single domain on my Front Door profile?
      instructions:
      - text: Get custom domain {domain} from Front Door profile {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      - text: Show the configuration of domain {domain} in {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a custom domain to a Front Door profile
      effect: write
      questions:
      - How do I add my own hostname to an Azure Front Door profile?
      - Can I bring a vanity domain onto Front Door Standard or Premium?
      instructions:
      - text: Create custom domain {domain} in Front Door profile {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      - text: Add a new domain named {domain} to {profile} with properties {properties}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom domain from a Front Door profile
      effect: destructive
      questions:
      - What happens when I delete a custom domain from Front Door?
      - Can I remove a domain I no longer use from my Front Door profile?
      instructions:
      - text: Delete custom domain {domain} from Front Door profile {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      - text: Remove domain {domain} from {profile} permanently.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing Front Door custom domain
      effect: write
      questions:
      - Can I change the TLS or DNS zone settings on a Front Door domain I already added?
      - How do I modify an existing custom domain on my Front Door profile?
      instructions:
      - text: Update existing domain {domain} in profile {profile} with {properties}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
          properties: requestBody.properties
      - text: Patch the settings of Front Door domain {domain} under {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}/refreshValidationToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a custom domain's validation token
      effect: write
      questions:
      - My Front Door domain validation token expired, can I get a new one?
      - What do I do when a custom domain is stuck pending DNS TXT validation?
      instructions:
      - text: Refresh the validation token for domain {domain} in profile {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      - text: Regenerate the DNS validation token of {domain} on {profile}.
        slots:
          domain: path.customDomainName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'