Microsoft Azure Cdn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Cdn Secrets API

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

$.info

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}'].put

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}'].delete

OpenAPI Overlay

# 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 Secrets API
  version: 1.0.0
extends: openapi/microsoft-azure-cdn-secrets-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: 4
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List secrets in a Front Door profile
      effect: read
      questions:
      - Which certificates and secrets are registered on my Azure Front Door profile?
      - Can I see all secrets available to use for custom domain TLS?
      instructions:
      - text: List the secrets in Front Door profile {profile}.
        slots:
          profile: path.profileName
      - text: Show every certificate secret stored under {profile}.
        slots:
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Front Door secret
      effect: read
      questions:
      - What Key Vault certificate and version does one of my secrets point to?
      - Where do I look up a single secret by name on a Front Door profile?
      instructions:
      - text: Get secret {secret} in Front Door profile {profile}.
        slots:
          secret: path.secretName
          profile: path.profileName
      - text: Show the details of secret {secret} on {profile}.
        slots:
          secret: path.secretName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a secret to a Front Door profile
      effect: write
      questions:
      - How do I register my own TLS certificate from Key Vault with Front Door?
      - Can I pin a specific certificate version when creating a secret?
      instructions:
      - text: Create secret {secret} in Front Door profile {profile}.
        slots:
          secret: path.secretName
          profile: path.profileName
      - text: Add a new secret named {secret} to {profile} with {properties}.
        slots:
          secret: path.secretName
          profile: path.profileName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Front Door secret
      effect: destructive
      questions:
      - Can I remove a certificate secret I no longer use?
      - What happens to domains using a secret when I delete it?
      instructions:
      - text: Delete secret {secret} from Front Door profile {profile}.
        slots:
          secret: path.secretName
          profile: path.profileName
      - text: Remove the {secret} secret from {profile} permanently.
        slots:
          secret: path.secretName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'