# 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.device API
  version: 1.0.0
extends: openapi/azure-ad-devices-device-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: 9
- target: $.paths['/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices registered in the organization
      effect: read
      questions:
      - Which devices are registered in our Microsoft Entra tenant?
      - Can I see every registered device along with its operating system and compliance state?
      instructions:
      - text: List all devices registered in the organization.
      - text: Show registered devices matching the filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new device
      effect: write
      questions:
      - How do I register a new device in the directory through the API?
      - Can I set the operating system and ownership when registering a device?
      instructions:
      - text: Register a new device named {displayName} running {os}.
        slots:
          displayName: requestBody.displayName
          os: requestBody.operatingSystem
      - text: Create a device record with device ID {deviceId} and alternative security IDs {securityIds}.
        slots:
          deviceId: requestBody.deviceId
          securityIds: requestBody.alternativeSecurityIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device by its object ID
      effect: read
      questions:
      - How do I read a registered device's properties using its directory object ID?
      - Is a particular device compliant and managed, looked up by object ID?
      instructions:
      - text: Get device object {device}.
        slots:
          device: path.device-id
      - text: Show the compliance and trust type of device object {device}.
        slots:
          device: path.device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device by its object ID
      effect: destructive
      questions:
      - How do I remove a registered device using its object ID?
      - Can I delete a device only if nobody changed it since I last read it?
      instructions:
      - text: Delete device object {device}.
        slots:
          device: path.device-id
      - text: Remove registered device object {device} if its ETag is {etag}.
        slots:
          device: path.device-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a device by its object ID
      effect: write
      questions:
      - How do I disable a registered device's account using its object ID?
      - Which device properties can be updated, and do some need an approved MDM app?
      instructions:
      - text: Set accountEnabled to {enabled} on device object {device}.
        slots:
          enabled: requestBody.accountEnabled
          device: path.device-id
      - text: Rename device object {device} to {displayName}.
        slots:
          device: path.device-id
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices(deviceId=\'{deviceId}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device by its hardware device ID
      effect: read
      questions:
      - Can I look up a device by its deviceId instead of the directory object ID?
      - How do I find the directory record for a device when I only know its device identifier?
      instructions:
      - text: Get the device whose deviceId is {deviceId}.
        slots:
          deviceId: path.deviceId
      - text: Look up the registered device by device identifier {deviceId}.
        slots:
          deviceId: path.deviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices(deviceId=\'{deviceId}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device by its hardware device ID
      effect: destructive
      questions:
      - How do I delete a registered device when I only have its deviceId?
      - Can I remove a device by device identifier rather than object ID?
      instructions:
      - text: Delete the device whose deviceId is {deviceId}.
        slots:
          deviceId: path.deviceId
      - text: Remove the device keyed by device identifier {deviceId} if its ETag is {etag}.
        slots:
          deviceId: path.deviceId
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices(deviceId=\'{deviceId}\')'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a device by its hardware device ID
      effect: write
      questions:
      - How do I update a device addressed by its deviceId?
      - Can I disable a device account using its device identifier?
      instructions:
      - text: Set accountEnabled to {enabled} on the device whose deviceId is {deviceId}.
        slots:
          enabled: requestBody.accountEnabled
          deviceId: path.deviceId
      - text: Set the device category of device identifier {deviceId} to {category}.
        slots:
          deviceId: path.deviceId
          category: requestBody.deviceCategory
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count registered devices
      effect: read
      questions:
      - How many devices are registered in our organization?
      - What's the total device count in the directory?
      instructions:
      - text: Count the registered devices.
      - text: Tell me how many devices our tenant has.
      method: generated
      generated: '2026-10-01'