Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn Custom Domains API

7 actions 7 updates phrasing extends openapi/microsoft-azure-cdn-custom-domains-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}/endpoints/{endpointName}/customDomains'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps'].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 Custom Domains API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-custom-domains-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom domains on a CDN endpoint
      effect: read
      questions:
      - Which custom hostnames are mapped to my classic Azure CDN endpoint?
      - Can I see every custom domain attached to one CDN endpoint?
      instructions:
      - text: List the custom domains on CDN endpoint {endpoint} in profile {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      - text: Show all hostnames attached to endpoint {endpoint} under {profile}.
        slots:
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom domain on a CDN endpoint
      effect: read
      questions:
      - What is the HTTPS provisioning state of a custom domain on my CDN endpoint?
      - Where do I look up a single custom domain's details?
      instructions:
      - text: Get custom domain {domain} on endpoint {endpoint} in profile {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      - text: Show the status of domain {domain} attached to {endpoint}, profile {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Map a custom domain to a CDN endpoint
      effect: write
      questions:
      - How do I attach my own hostname to an Azure CDN endpoint?
      - Does my CNAME need to point at the endpoint before I add a custom domain?
      instructions:
      - text: Create custom domain {domain} on endpoint {endpoint} in profile {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      - text: Add hostname {domain} to CDN endpoint {endpoint} of {profile} with {properties}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom domain from a CDN endpoint
      effect: destructive
      questions:
      - Can I detach a hostname from my CDN endpoint?
      - What happens when I delete a custom domain from an endpoint?
      instructions:
      - text: Delete custom domain {domain} from endpoint {endpoint} in profile {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      - text: Detach hostname {domain} from CDN endpoint {endpoint} on {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off HTTPS on a CDN custom domain
      effect: write
      questions:
      - How do I stop serving HTTPS on one of my CDN custom domains?
      - Can I disable custom HTTPS without removing the domain itself?
      instructions:
      - text: Disable HTTPS delivery for domain {domain} on endpoint {endpoint} in {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      - text: Turn off custom HTTPS on hostname {domain} at {endpoint}, profile {profile}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on HTTPS for a CDN custom domain
      effect: write
      questions:
      - Can I use a CDN-managed certificate or my own Key Vault certificate for a custom domain?
      - What minimum TLS version can I require when enabling HTTPS on a custom domain?
      instructions:
      - text: Enable HTTPS on domain {domain} at endpoint {endpoint} in {profile} using certificate source {source} and protocol {protocol}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
          source: requestBody.certificateSource
          protocol: requestBody.protocolType
      - text: Turn on custom HTTPS for {domain} on {endpoint}, profile {profile}, source {source}, protocol {protocol}, minimum TLS {tls}.
        slots:
          domain: path.customDomainName
          endpoint: path.endpointName
          profile: path.profileName
          source: requestBody.certificateSource
          protocol: requestBody.protocolType
          tls: requestBody.minimumTlsVersion
      method: generated
      generated: '2026-10-01'