Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn Endpoints API

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

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{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 Endpoints API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-endpoints-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: 11
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List CDN endpoints in a profile
      effect: read
      questions:
      - Which classic CDN endpoints exist under my Azure CDN profile?
      - Can I get every endpoint in a CDN profile in one call?
      instructions:
      - text: List the CDN endpoints in profile {profile}.
        slots:
          profile: path.profileName
      - text: Show all endpoints configured under CDN profile {profile}.
        slots:
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CDN endpoint
      effect: read
      questions:
      - Is my CDN endpoint currently running or stopped?
      - Where do I look up origin and caching settings of a single CDN endpoint?
      instructions:
      - text: Get CDN endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Show the configuration and state of 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}/endpoints/{endpointName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a CDN endpoint
      effect: write
      questions:
      - How do I create a new endpoint in an Azure CDN profile?
      - Can I set the origin and optimization type when I create a CDN endpoint?
      instructions:
      - text: Create CDN endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Add a new endpoint named {endpoint} to {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}/endpoints/{endpointName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CDN endpoint
      effect: destructive
      questions:
      - What happens to cached content when I delete a CDN endpoint?
      - Can I remove an endpoint I no longer use from my CDN profile?
      instructions:
      - text: Delete CDN endpoint {endpoint} from profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Remove endpoint {endpoint} out of {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}/endpoints/{endpointName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing CDN endpoint
      effect: write
      questions:
      - Can I change tags or caching behavior on an endpoint I already created?
      - Which settings of a classic CDN endpoint can be patched in place?
      instructions:
      - text: Update the tags on CDN endpoint {endpoint} in {profile} to {tags}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
          tags: requestBody.tags
      - text: Patch existing 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}/endpoints/{endpointName}/checkResourceUsage'].post
  update:
    x-apievangelist-phrasing:
      intent: Check geo filter and domain quota on an endpoint
      effect: read
      questions:
      - How many geo filters and custom domains can I still add to this endpoint?
      - What quota applies to custom domains on a single CDN endpoint?
      instructions:
      - text: Check geo filter and custom domain usage on endpoint {endpoint} in {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Show quota consumption for CDN endpoint {endpoint}, 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}/endpoints/{endpointName}/load'].post
  update:
    x-apievangelist-phrasing:
      intent: Pre-load content onto the CDN
      effect: write
      questions:
      - Can I warm the CDN cache with files before users request them?
      - Which profiles support pre-loading content onto CDN edge servers?
      instructions:
      - text: Pre-load {paths} onto CDN endpoint {endpoint} in profile {profile}.
        slots:
          paths: requestBody.contentPaths
          endpoint: path.endpointName
          profile: path.profileName
      - text: 'Warm the cache on {endpoint} ({profile}) with these files: {paths}.'
        slots:
          paths: requestBody.contentPaths
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge cached content from a CDN endpoint
      effect: write
      questions:
      - How do I force the CDN to drop stale files after I update my site?
      - Can I purge a whole folder with a wildcard path on a classic CDN endpoint?
      instructions:
      - text: Purge {paths} from CDN endpoint {endpoint} in profile {profile}.
        slots:
          paths: requestBody.contentPaths
          endpoint: path.endpointName
          profile: path.profileName
      - text: Clear the cached copies of {paths} on {endpoint} under {profile}.
        slots:
          paths: requestBody.contentPaths
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a stopped CDN endpoint
      effect: write
      questions:
      - My CDN endpoint is stopped, how do I bring it back online?
      - Can I resume serving traffic from an endpoint I stopped earlier?
      instructions:
      - text: Start CDN endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Bring stopped endpoint {endpoint} on {profile} back up.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running CDN endpoint
      effect: write
      questions:
      - Can I pause a CDN endpoint without deleting it?
      - What does stopping a running endpoint do to content delivery?
      instructions:
      - text: Stop CDN endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Pause the running 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}/endpoints/{endpointName}/validateCustomDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a domain's DNS mapping to a CDN endpoint
      effect: read
      questions:
      - Does my hostname's CNAME resolve to the right classic CDN endpoint?
      - Can I check DNS for a custom domain before adding it to an endpoint?
      instructions:
      - text: Validate that {host} maps to CDN endpoint {endpoint} in profile {profile}.
        slots:
          host: requestBody.hostName
          endpoint: path.endpointName
          profile: path.profileName
      - text: Check whether hostname {host} points at endpoint {endpoint} on {profile}.
        slots:
          host: requestBody.hostName
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'