# 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 Adds API
  version: 1.0.0
extends: openapi/microsoft-azure-adds-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: 26
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices'].get
  update:
    x-apievangelist-phrasing:
      intent: List AD Domain Services onboarded to Connect Health
      effect: read
      questions:
      - Which Active Directory Domain Services in my tenant are onboarded to Azure AD Connect Health?
      - Can I page through my monitored AD DS services with a skip and take count?
      instructions:
      - text: List every Active Directory Domain Service my tenant has onboarded to Connect Health.
      - text: Show the onboarded AD DS services of type {service_type}, taking {take} results.
        slots:
          service_type: query.serviceType
          take: query.takeCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices'].post
  update:
    x-apievangelist-phrasing:
      intent: Onboard an AD DS service to Connect Health
      effect: write
      questions:
      - How do I onboard a new Active Directory Domain Service to Azure AD Connect Health for my tenant?
      - Can I set custom notification emails when I register a domain service for health monitoring?
      instructions:
      - text: Onboard a new AD DS service named {display_name} to Connect Health for my tenant.
        slots:
          display_name: requestBody.displayName
      - text: Register domain service {service_name} with Connect Health and send alert emails to {emails}.
        slots:
          service_name: requestBody.serviceName
          emails: requestBody.notificationEmails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts for an AD Domain Service
      effect: read
      questions:
      - What health alerts has my Active Directory Domain Service raised recently?
      - Can I filter domain service alerts by state and a from/to date range?
      instructions:
      - text: Show the alerts for AD DS service {service}.
        slots:
          service: path.serviceName
      - text: List {state} alerts on domain service {service} raised between {from} and {to}.
        slots:
          state: query.state
          service: path.serviceName
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the configuration of an AD DS service
      effect: read
      questions:
      - What configuration settings does Connect Health hold for my AD Domain Service?
      - Can I group the service configuration results when I pull them?
      instructions:
      - text: Get the service configuration for AD DS service {service}.
        slots:
          service: path.serviceName
      - text: Pull the configuration of domain service {service} grouped by {grouping}.
        slots:
          service: path.serviceName
          grouping: query.grouping
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}'].get
  update:
    x-apievangelist-phrasing:
      intent: List dimension values for an AD DS service
      effect: read
      questions:
      - What values exist for a given dimension type, like sites or domains, in my AD DS service?
      - Which dimension entries does Connect Health report for a domain service?
      instructions:
      - text: List the {dimension} dimensions for AD DS service {service}.
        slots:
          dimension: path.dimension
          service: path.serviceName
      - text: Break down domain service {service} by the {dimension} dimension type.
        slots:
          service: path.serviceName
          dimension: path.dimension
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers'].get
  update:
    x-apievangelist-phrasing:
      intent: List domain controllers in an AD DS service
      effect: read
      questions:
      - Which Active Directory domain controllers are onboarded under my domain service in Connect Health?
      - Can I filter the list of AD domain servers reporting to Connect Health?
      instructions:
      - text: List the Active Directory domain servers onboarded under service {service}.
        slots:
          service: path.serviceName
      - text: Show AD domain servers in service {service} matching filter {filter}.
        slots:
          service: path.serviceName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers'].get
  update:
    x-apievangelist-phrasing:
      intent: List domain service servers, optionally by site
      effect: read
      questions:
      - Can I see the servers under my AD Domain Service grouped by site?
      - How are the domain service member servers paged using partition and row keys?
      instructions:
      - text: List the member servers of domain service {service} grouped by site ({group_by_site}), starting at partition {partition} row {row}.
        slots:
          service: path.serviceName
          group_by_site: query.isGroupbySite
          partition: query.nextPartitionKey
          row: query.nextRowKey
      - text: Search the domain service member servers of {service} for {query}.
        slots:
          service: path.serviceName
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my preferences for an AD DS feature
      effect: read
      questions:
      - What user preferences have I saved for a Connect Health feature on my domain service?
      - Which metric names are pinned in my preferences for an AD DS feature?
      instructions:
      - text: Get my user preferences for feature {feature} on AD DS service {service}.
        slots:
          feature: path.featureName
          service: path.serviceName
      - text: Show which metrics I chose for the {feature} feature of domain service {service}.
        slots:
          feature: path.featureName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference'].post
  update:
    x-apievangelist-phrasing:
      intent: Save my preferences for an AD DS feature
      effect: write
      questions:
      - Can I save which metrics I want to see for a Connect Health feature?
      - How do I store my metric preferences for a domain service feature?
      instructions:
      - text: Save metrics {metrics} as my preferences for feature {feature} on AD DS service {service}.
        slots:
          metrics: requestBody.metricNames
          feature: path.featureName
          service: path.serviceName
      - text: Add a user preference to the {feature} feature of domain service {service}.
        slots:
          feature: path.featureName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my preferences for an AD DS feature
      effect: destructive
      questions:
      - Can I clear the saved user preferences for a Connect Health feature?
      - What happens to my pinned metrics if I delete a feature preference on my domain service?
      instructions:
      - text: Delete my user preferences for feature {feature} on AD DS service {service}.
        slots:
          feature: path.featureName
          service: path.serviceName
      - text: Reset the {feature} preferences I saved for domain service {service}.
        slots:
          feature: path.featureName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the forest summary for an AD DS service
      effect: read
      questions:
      - What does the Active Directory forest summary look like for my monitored domain service?
      - Can Connect Health give me an overview of my AD forest?
      instructions:
      - text: Get the forest summary for AD DS service {service}.
        slots:
          service: path.serviceName
      - text: Summarize the Active Directory forest behind domain service {service}.
        slots:
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get server metrics for a metric and group
      effect: read
      questions:
      - Can I pull the raw server metric values for one metric and group over a date range?
      - What server-level metric data does Connect Health return for a domain service metric group?
      instructions:
      - text: Get metric {metric} for group {group} on AD DS service {service}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
      - text: Pull {metric} values in group {group} of service {service} from {from_date} to {to_date}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
          from_date: query.fromDate
          to_date: query.toDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the average of a metric for a group
      effect: read
      questions:
      - What is the average value of a domain service metric across a group?
      - Can Connect Health compute a metric average for me instead of the raw series?
      instructions:
      - text: Get the average of metric {metric} for group {group} on AD DS service {service}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
      - text: Average the {metric} values in group {group} for domain service {service}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the sum of a metric for a group
      effect: read
      questions:
      - What is the total of a domain service metric summed across a group?
      - Can I get summed metric values rather than averages from Connect Health?
      instructions:
      - text: Get the sum of metric {metric} for group {group} on AD DS service {service}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
      - text: Total up {metric} across group {group} for domain service {service}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric metadata for an AD DS service
      effect: read
      questions:
      - Which metrics can Connect Health report for my Active Directory Domain Service?
      - Can I narrow the metric catalog to performance counters only?
      instructions:
      - text: List all metric definitions available for AD DS service {service}.
        slots:
          service: path.serviceName
      - text: Show only perf counter metrics ({perf_counter}) defined for domain service {service}.
        slots:
          perf_counter: query.perfCounter
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the definition of one AD DS metric
      effect: read
      questions:
      - What does a specific Connect Health metric measure on my domain service?
      - Where can I see the metadata for a single AD DS metric by name?
      instructions:
      - text: Get the metadata for metric {metric} on AD DS service {service}.
        slots:
          metric: path.metricName
          service: path.serviceName
      - text: Describe what metric {metric} tracks for domain service {service}.
        slots:
          metric: path.metricName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get service-level metric data for a group
      effect: read
      questions:
      - Can I get service-wide values for a metric group, not per server, over a time window?
      - What service-level data does the metric metadata group endpoint return for a group key?
      instructions:
      - text: Return service-wide rather than per-server data for metric {metric}, group {group}, in {service}.
        slots:
          metric: path.metricName
          group: path.groupName
          service: path.serviceName
      - text: Fetch service-wide {metric} data for group key {group_key} in group {group} of {service}.
        slots:
          metric: path.metricName
          group_key: query.groupKey
          group: path.groupName
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails'].get
  update:
    x-apievangelist-phrasing:
      intent: List domain controllers with replication details
      effect: read
      questions:
      - Which domain controllers are in my AD DS service and how is each replicating?
      - Can I include full replication details for every domain controller?
      instructions:
      - text: List domain controllers and their replication details for AD DS service {service}.
        slots:
          service: path.serviceName
      - text: Show replication details ({with_details}) for each domain controller in {service}.
        slots:
          with_details: query.withDetails
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get replication status of an AD DS service
      effect: read
      questions:
      - Is Active Directory replication healthy for my monitored domain service?
      - What overall replication status does Connect Health report for my AD DS service?
      instructions:
      - text: Get the replication status of AD DS service {service}.
        slots:
          service: path.serviceName
      - text: Check whether replication is failing anywhere in domain service {service}.
        slots:
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a replication summary, optionally by site
      effect: read
      questions:
      - Can I get a replication summary of my domain controllers grouped by site?
      - Which parameters page through the AD DS replication summary?
      instructions:
      - text: Get the replication summary for {service} grouped by site ({group_by_site}) matching {query} from partition {partition} row {row}.
        slots:
          service: path.serviceName
          group_by_site: query.isGroupbySite
          query: query.query
          partition: query.nextPartitionKey
          row: query.nextRowKey
      - text: Summarize replication for up to {take} domain controllers in service {service}.
        slots:
          take: query.takeCount
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers'].get
  update:
    x-apievangelist-phrasing:
      intent: List servers onboarded to a domain controller service
      effect: read
      questions:
      - Which servers are registered as service members of my domain controller service?
      - Can I filter service members by dimension type and signature?
      instructions:
      - text: List the service member servers of AD DS service {service}.
        slots:
          service: path.serviceName
      - text: Show service members of {service} with dimension {dimension_type} and signature {signature}.
        slots:
          service: path.serviceName
          dimension_type: query.dimensionType
          signature: query.dimensionSignature
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Onboard a server to a domain controller service
      effect: write
      questions:
      - How do I add a domain controller server to Connect Health monitoring?
      - What details do I send when onboarding a server to an AD DS service?
      instructions:
      - text: Onboard server {member_id} to AD DS service {service}.
        slots:
          member_id: requestBody.serviceMemberId
          service: path.serviceName
      - text: Register a new domain controller server under service {service} in Connect Health.
        slots:
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one onboarded domain controller
      effect: read
      questions:
      - What does Connect Health know about one specific domain controller server?
      - Can I look up a single service member of my domain service by its id?
      instructions:
      - text: Get server {member} from AD DS service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show the onboarding details of domain controller {member} in {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain controller from Connect Health
      effect: destructive
      questions:
      - Can I stop monitoring a domain controller by deleting it from Connect Health?
      - Does removing a domain controller server from my AD DS service need a confirm flag?
      instructions:
      - text: Delete server {member} from AD DS service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Offboard domain controller {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/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts for one domain controller server
      effect: read
      questions:
      - What alerts has a particular domain controller raised, rather than the whole service?
      - Can I see only active alerts for one server in a date window?
      instructions:
      - text: List alerts for server {member} in AD DS service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Show {state} alerts on domain controller {member} of {service} since {from}.
        slots:
          state: query.state
          member: path.serviceMemberId
          service: path.serviceName
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: Get agent credentials for a monitored server
      effect: read
      questions:
      - Where does the Connect Health agent get the credentials it needs to connect for a server?
      - Can I retrieve the credentials a domain controller agent uses to report health?
      instructions:
      - text: Get the agent credentials for server {member} in AD DS service {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      - text: Fetch connection credentials for the health agent on domain controller {member} of {service}.
        slots:
          member: path.serviceMemberId
          service: path.serviceName
      method: generated
      generated: '2026-09-26'