Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity.DirectoryManagement Domains.domain Dns Record API

13 actions 13 updates phrasing extends openapi/azure-ad-domains-domaindnsrecord-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/domains/{domain-id}/serviceConfigurationRecords'].get
$.paths['/domains/{domain-id}/serviceConfigurationRecords'].post
$.paths['/domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}'].get
$.paths['/domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}'].delete
$.paths['/domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}'].patch
$.paths['/domains/{domain-id}/serviceConfigurationRecords/$count'].get
$.paths['/domains/{domain-id}/verificationDnsRecords'].get
$.paths['/domains/{domain-id}/verificationDnsRecords'].post
$.paths['/domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}'].get
$.paths['/domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}'].delete
$.paths['/domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}'].patch
$.paths['/domains/{domain-id}/verificationDnsRecords/$count'].get

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 Identity.DirectoryManagement Domains.domain Dns Record API
  version: 1.0.0
extends: openapi/azure-ad-domains-domaindnsrecord-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: 12
- target: $.paths['/domains/{domain-id}/serviceConfigurationRecords'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS records needed to enable services on a domain
      effect: read
      questions:
      - Which DNS records do I need to add to my zone file so Microsoft Online services work on my domain?
      - What MX, CNAME and TXT records does a custom domain need for email and other services?
      instructions:
      - text: List the service configuration DNS records for domain {domain}.
        slots:
          domain: path.domain-id
      - text: Show which records I must add to the zone of {domain} to enable services.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/serviceConfigurationRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a service configuration record to a domain
      effect: write
      questions:
      - Can I add a new service configuration DNS record entry to a domain?
      - What fields go into a service configuration record, such as label, type, service and TTL?
      instructions:
      - text: Add a {type} service configuration record labelled {label} to domain {domain}.
        slots:
          type: requestBody.recordType
          label: requestBody.label
          domain: path.domain-id
      - text: Create a service configuration record on {domain} for service {service} with TTL {ttl}.
        slots:
          domain: path.domain-id
          service: requestBody.supportedService
          ttl: requestBody.ttl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one service configuration record of a domain
      effect: read
      questions:
      - What are the details of one specific service configuration DNS record for my domain?
      - Is a particular service configuration record optional for the domain?
      instructions:
      - text: Get service configuration record {record} for domain {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      - text: Show the label, type and TTL of service record {record} on {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service configuration record from a domain
      effect: destructive
      questions:
      - Can I remove a service configuration DNS record entry from a domain?
      - What happens if I delete one of a domain's service configuration records?
      instructions:
      - text: Delete service configuration record {record} from domain {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      - text: Remove the services DNS record {record} on {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/serviceConfigurationRecords/{domainDnsRecord-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service configuration record of a domain
      effect: write
      questions:
      - Can I change the TTL or label of an existing service configuration record?
      - Which properties of a domain's service configuration record can be edited?
      instructions:
      - text: Set the TTL of service configuration record {record} on {domain} to {ttl}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
          ttl: requestBody.ttl
      - text: Mark service record {record} on domain {domain} as optional {optional}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
          optional: requestBody.isOptional
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/serviceConfigurationRecords/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a domain's service configuration records
      effect: read
      questions:
      - How many service configuration DNS records does my domain require?
      - What is the total of services records for a custom domain?
      instructions:
      - text: Count the service configuration records for domain {domain}.
        slots:
          domain: path.domain-id
      - text: Tell me how many services DNS records {domain} has.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/verificationDnsRecords'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS records needed to verify domain ownership
      effect: read
      questions:
      - Which DNS record do I add to prove I own a custom domain before using it in my tenant?
      - Why can't I use my new domain yet, and what verification records does it need?
      instructions:
      - text: List the ownership verification DNS records for domain {domain}.
        slots:
          domain: path.domain-id
      - text: Show the TXT or MX record I need to add to verify {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/verificationDnsRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a verification record to a domain
      effect: write
      questions:
      - Can I add a new ownership verification DNS record entry to a domain?
      - What fields describe a verification record, such as its type, label and TTL?
      instructions:
      - text: Add a {type} verification record labelled {label} to domain {domain}.
        slots:
          type: requestBody.recordType
          label: requestBody.label
          domain: path.domain-id
      - text: Create a domain verification record on {domain} with TTL {ttl}.
        slots:
          domain: path.domain-id
          ttl: requestBody.ttl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one verification record of a domain
      effect: read
      questions:
      - What exactly does one of my domain's ownership verification records say?
      - Which label and value should I copy into my DNS host to verify the domain?
      instructions:
      - text: Get verification record {record} for domain {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      - text: Show the type, label and TTL of verification record {record} on {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a verification record from a domain
      effect: destructive
      questions:
      - Can I remove an ownership verification DNS record entry from a domain?
      - Is it possible to delete a verification record I no longer need?
      instructions:
      - text: Delete verification record {record} from domain {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      - text: Remove the ownership verification DNS entry {record} on {domain}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/verificationDnsRecords/{domainDnsRecord-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a verification record of a domain
      effect: write
      questions:
      - Can I change the TTL or label on an existing domain verification record?
      - Which properties of a verification DNS record can be edited after it exists?
      instructions:
      - text: Set the TTL of verification record {record} on {domain} to {ttl}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
          ttl: requestBody.ttl
      - text: Change the label of verification record {record} on domain {domain} to {label}.
        slots:
          record: path.domainDnsRecord-id
          domain: path.domain-id
          label: requestBody.label
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/verificationDnsRecords/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a domain's verification records
      effect: read
      questions:
      - How many ownership verification records exist for a domain?
      - What is the total of verification DNS entries for a custom domain?
      instructions:
      - text: Count the verification records for domain {domain}.
        slots:
          domain: path.domain-id
      - text: Tell me how many verification DNS records {domain} has.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'