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

API Evangelist conversational phrasing for Identity.DirectoryManagement Devices.extension API

7 actions 7 updates phrasing extends openapi/azure-ad-devices-extension-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 7

$.info
$.paths['/devices/{device-id}/extensions'].get
$.paths['/devices/{device-id}/extensions'].post
$.paths['/devices/{device-id}/extensions/{extension-id}'].get
$.paths['/devices/{device-id}/extensions/{extension-id}'].delete
$.paths['/devices/{device-id}/extensions/{extension-id}'].patch
$.paths['/devices/{device-id}/extensions/$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 Devices.extension API
  version: 1.0.0
extends: openapi/azure-ad-devices-extension-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['/devices/{device-id}/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List open extensions on a device
      effect: read
      questions:
      - Which open extensions with custom data are attached to a device?
      - How do I read the custom properties my app stored on a device object?
      instructions:
      - text: List the open extensions on device {device_id}.
        slots:
          device_id: path.device-id
      - text: Show all custom extension data stored on device {device_id}.
        slots:
          device_id: path.device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an open extension to a device
      effect: write
      questions:
      - Can I attach my own custom data to a device as an open extension?
      - What is needed to create a new extension on a device object?
      instructions:
      - text: Create an open extension on device {device_id}.
        slots:
          device_id: path.device-id
      - text: Attach extension {extension_name} with my custom data to device {device_id}.
        slots:
          extension_name: requestBody.id
          device_id: path.device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/extensions/{extension-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one open extension on a device
      effect: read
      questions:
      - Can I read a single named extension from a device?
      - What custom values does one specific device extension hold?
      instructions:
      - text: Get extension {extension_id} from device {device_id}.
        slots:
          extension_id: path.extension-id
          device_id: path.device-id
      - text: Show the custom data in extension {extension_id} on device {device_id}.
        slots:
          extension_id: path.extension-id
          device_id: path.device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/extensions/{extension-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an open extension from a device
      effect: destructive
      questions:
      - Can I remove custom extension data from a device?
      - Is deleting a device's open extension permanent?
      instructions:
      - text: Delete extension {extension_id} from device {device_id}.
        slots:
          extension_id: path.extension-id
          device_id: path.device-id
      - text: Remove extension {extension_id} on device {device_id} only if its ETag is {etag}.
        slots:
          extension_id: path.extension-id
          device_id: path.device-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/extensions/{extension-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an open extension on a device
      effect: write
      questions:
      - Can I change the custom values inside an existing device extension?
      - Which call edits extension data already attached to a device?
      instructions:
      - text: Update extension {extension_id} on device {device_id} with my new values.
        slots:
          extension_id: path.extension-id
          device_id: path.device-id
      - text: Patch the custom data in existing extension {extension_id} of device {device_id}.
        slots:
          extension_id: path.extension-id
          device_id: path.device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/extensions/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count open extensions on a device
      effect: read
      questions:
      - How many open extensions does a device carry?
      - Can I get just the number of extensions on a device?
      instructions:
      - text: Count the open extensions on device {device_id}.
        slots:
          device_id: path.device-id
      - text: Return only the extension total for device {device_id}.
        slots:
          device_id: path.device-id
      method: generated
      generated: '2026-10-01'