API Evangelist conversational phrasing for DirectoryObjects Directory Objects.directory Object API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DirectoryObjects Directory Objects.directory Object API
  version: 1.0.0
extends: openapi/azure-ad-directoryobjects-directoryobject-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['/directoryObjects'].get
  update:
    x-apievangelist-phrasing:
      intent: List directory objects
      effect: read
      questions:
      - How do I list all directory objects in my Entra ID tenant?
      - Which consistency level header do advanced queries on directory objects need?
      instructions:
      - text: List directory objects.
      - text: List directory objects matching {filter} with consistency level {level}.
        slots:
          filter: query.$filter
          level: header.ConsistencyLevel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a directory object
      effect: write
      questions:
      - Can I post a new generic entity to the directoryObjects collection?
      - What fields does creating a raw directory object accept?
      instructions:
      - text: Create a directory object with ID {id}.
        slots:
          id: requestBody.id
      - text: Add a new entity to directoryObjects.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryObjects/{directoryObject-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a directory object
      effect: read
      questions:
      - What kind of object is behind a given directory object ID?
      - Can I look up any user, group or service principal by its object ID?
      instructions:
      - text: Show directory object {object}.
        slots:
          object: path.directoryObject-id
      - text: Get the type and properties of object {object}.
        slots:
          object: path.directoryObject-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryObjects/{directoryObject-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a directory object
      effect: destructive
      questions:
      - How do I delete a group, user, application or service principal by its object ID?
      - Can I delete any directory object generically without knowing its type?
      instructions:
      - text: Delete directory object {object}.
        slots:
          object: path.directoryObject-id
      - text: Remove object {object} from the directory if its ETag is {etag}.
        slots:
          object: path.directoryObject-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryObjects/{directoryObject-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a directory object
      effect: write
      questions:
      - Can I PATCH a directory object generically by its ID?
      - Which properties can be updated on a raw directoryObject entity?
      instructions:
      - text: Update directory object {object}.
        slots:
          object: path.directoryObject-id
      - text: Set the deleted time of object {object} to {deleted}.
        slots:
          object: path.directoryObject-id
          deleted: requestBody.deletedDateTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryObjects/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count directory objects
      effect: read
      questions:
      - How many directory objects exist in the tenant?
      - Does counting directory objects require the ConsistencyLevel eventual header?
      instructions:
      - text: Count directory objects.
      - text: Count directory objects matching {filter} with consistency level {level}.
        slots:
          filter: query.$filter
          level: header.ConsistencyLevel
      method: generated
      generated: '2026-10-01'