# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure ADHybridHealthService Service Members API
  version: 1.0.0
extends: openapi/microsoft-azure-servicemembers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers'].get
  update:
    x-apievangelist-phrasing:
      intent: List servers onboarded to a Connect Health service
      effect: read
      questions:
      - Which servers are onboarded to my Azure AD Connect Health service?
      - Can I filter the servers of a Connect Health service by dimension type?
      instructions:
      - text: List servers onboarded to Connect Health service {service}.
        slots:
          service: path.serviceName
      - text: List servers of service {service} with dimension type {dimension}.
        slots:
          service: path.serviceName
          dimension: query.dimensionType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Onboard a server to a Connect Health service
      effect: write
      questions:
      - How do I onboard a new server to Azure AD Connect Health?
      - Can I register a machine by name under an existing Connect Health service?
      instructions:
      - text: Onboard server {machine} to Connect Health service {service}.
        slots:
          machine: requestBody.machineName
          service: path.serviceName
      - text: Add service member {member} with role {role} to service {service}.
        slots:
          member: requestBody.serviceMemberId
          role: requestBody.role
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an onboarded Connect Health server
      effect: read
      questions:
      - How do I see the details of one server onboarded to Connect Health?
      - What OS, alerts and status does a specific Connect Health server report?
      instructions:
      - text: Get server {member} in Connect Health service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show details of onboarded server {member} for {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a server from Connect Health
      effect: destructive
      questions:
      - How do I offboard a server from Azure AD Connect Health?
      - Does removing a Connect Health server need a confirm flag?
      instructions:
      - text: Delete server {member} from Connect Health service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Remove server {member} from {service} with confirm set to {confirm}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
          confirm: query.confirm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List sync connectors for a server
      effect: read
      questions:
      - What connectors are configured on my Connect Health sync server?
      - Can I see the connector details for one service member?
      instructions:
      - text: List connectors on server {member} of service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show connector details for Connect Health server {member} in {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: Get agent credentials for a server
      effect: read
      questions:
      - Where do I get the credentials the Connect Health agent uses to connect?
      - Can I fetch a server's agent credentials filtered by type?
      instructions:
      - text: Get agent credentials for server {member} in service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: List credentials of server {member} on {service} matching {filter}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete data a server uploaded to Connect Health
      effect: destructive
      questions:
      - How do I purge the data a server has uploaded to Connect Health?
      - Can I wipe a server's uploaded health data while keeping it onboarded?
      instructions:
      - text: Delete uploaded data for server {member} in service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Purge Connect Health data sent by server {member} of {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness'].get
  update:
    x-apievangelist-phrasing:
      intent: Check when a server last uploaded data
      effect: read
      questions:
      - When did my Connect Health server last upload data?
      - Is a server's health data stale?
      instructions:
      - text: Get data freshness for server {member} in service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show the last upload time of server {member} on {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sync export status for a server
      effect: read
      questions:
      - What is the export status on my Connect Health sync server?
      - Can I check export errors for one service member?
      instructions:
      - text: Get export status for server {member} in service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show the export status of Connect Health server {member} on {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server's global sync configuration
      effect: read
      questions:
      - What global configuration is my Connect Health sync server running?
      - Can I read the global settings reported by one server?
      instructions:
      - text: Get global configuration for server {member} in service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show the global config of Connect Health server {member} on {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server's service configuration
      effect: read
      questions:
      - How do I read the service configuration reported by a Connect Health server?
      - Which service configuration values does one server member have?
      instructions:
      - text: Read the per-server service configuration of {member} in Connect Health service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show the service config of server {member} on {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'