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

API Evangelist conversational phrasing for Identity.DirectoryManagement Directory.on Premises…

7 actions 7 updates phrasing extends openapi/azure-ad-directory-onpremisesdirectorysynchronization-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['/directory/onPremisesSynchronization'].get
$.paths['/directory/onPremisesSynchronization'].post
$.paths['/directory/onPremisesSynchronization/{onPremisesDirectorySynchronization-id}'].get
$.paths['/directory/onPremisesSynchronization/{onPremisesDirectorySynchronization-id}'].delete
$.paths['/directory/onPremisesSynchronization/{onPremisesDirectorySynchronization-id}'].patch
$.paths['/directory/onPremisesSynchronization/$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 Directory.on Premises…
  version: 1.0.0
extends: openapi/azure-ad-directory-onpremisesdirectorysynchronization-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['/directory/onPremisesSynchronization'].get
  update:
    x-apievangelist-phrasing:
      intent: List on-premises directory sync configurations
      effect: read
      questions:
      - How do I see the on-premises directory synchronization settings for my tenant?
      - Which directory sync features are turned on for our hybrid setup?
      instructions:
      - text: List the on-premises directory synchronization objects for the tenant.
      - text: Show all onPremisesSynchronization configurations and their enabled features.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/onPremisesSynchronization'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an on-premises sync configuration
      effect: write
      questions:
      - Can I create a new onPremisesDirectorySynchronization object with its configuration?
      - What can be supplied when adding an on-premises sync entry, such as features?
      instructions:
      - text: Create an on-premises directory synchronization object with configuration {configuration}.
        slots:
          configuration: requestBody.configuration
      - text: Add a directory sync entry with features {features}.
        slots:
          features: requestBody.features
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/onPremisesSynchronization/{onPremisesDirectorySynchronization-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an on-premises sync configuration
      effect: read
      questions:
      - What does one specific on-premises directory synchronization object contain?
      - How do I read the sync configuration by its id?
      instructions:
      - text: Get on-premises directory synchronization {sync}.
        slots:
          sync: path.onPremisesDirectorySynchronization-id
      - text: Show the configuration and features of sync object {sync}.
        slots:
          sync: path.onPremisesDirectorySynchronization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/onPremisesSynchronization/{onPremisesDirectorySynchronization-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an on-premises sync configuration
      effect: destructive
      questions:
      - Can I delete an onPremisesDirectorySynchronization object?
      - How do I remove one directory synchronization entry by id?
      instructions:
      - text: Delete on-premises directory synchronization {sync}.
        slots:
          sync: path.onPremisesDirectorySynchronization-id
      - text: Remove directory sync object {sync}.
        slots:
          sync: path.onPremisesDirectorySynchronization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/onPremisesSynchronization/{onPremisesDirectorySynchronization-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update on-premises sync settings
      effect: write
      questions:
      - How do I turn directory sync features on or off for our hybrid tenant?
      - Can I change the on-premises synchronization configuration after it's set up?
      instructions:
      - text: Update the features of on-premises sync {sync} to {features}.
        slots:
          sync: path.onPremisesDirectorySynchronization-id
          features: requestBody.features
      - text: Change the configuration of directory sync {sync} to {configuration}.
        slots:
          sync: path.onPremisesDirectorySynchronization-id
          configuration: requestBody.configuration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/onPremisesSynchronization/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count on-premises sync configurations
      effect: read
      questions:
      - How many on-premises directory synchronization objects exist in the tenant?
      - Can I just get the number of directory sync configurations?
      instructions:
      - text: Count the on-premises directory synchronization objects.
      - text: Tell me how many directory sync configurations there are.
      method: generated
      generated: '2026-10-01'