Microsoft Azure AD Hybrid Health Service is a cloud-based service that helps organizations monitor and improve the health and performance of their hybrid identity environment. By collecting data from on-premises Active Directory and Azure Active Directory, the service provides insights into potential issues such as synchronization failures, password sync problems, or authentication failures.
swagger: '2.0'
info:
version: '2014-01-01'
title: Microsoft Azure ADHybridHealthService
description: REST APIs for Azure Active Directory Connect Health
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/providers/Microsoft.ADHybridHealthService/addsservices:
get:
tags:
- Adds
description: >-
Gets the details of Active Directory Domain Service, for a tenant, that
are onboarded to Azure Active Directory Connect Health.
operationId: microsoftAzureAddsservicesList
x-ms-examples:
addsServices_list:
$ref: ./examples/Services.json
parameters:
- name: $filter
in: query
description: The service property filter to apply.
required: false
type: string
- name: serviceType
in: query
description: >-
The service type for the services onboarded to Azure Active
Directory Connect Health. Depending on whether the service is
monitoring, ADFS, Sync or ADDS roles, the service type can either be
AdFederationService or AadSyncService or AdDomainService.
required: false
type: string
- name: skipCount
in: query
description: >-
The skip count, which specifies the number of elements that can be
bypassed from a sequence and then return the remaining elements.
required: false
type: integer
- name: takeCount
in: query
description: >-
The take count , which specifies the number of elements that can be
returned from a sequence.
required: false
type: integer
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: ' The list of Active Directory Domain Controller services.'
schema:
$ref: '#/definitions/Services'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices
post:
tags:
- Adds
description: >-
Onboards a service for a given tenant in Azure Active Directory Connect
Health.
operationId: microsoftAzureAddsservicesAdd
x-ms-examples:
addsServices_add:
$ref: ./examples/AddService.json
parameters:
- $ref: '#/parameters/apiVersionParameter'
- name: service
in: body
description: The service object.
required: true
schema:
$ref: '#/definitions/ServiceProperties'
responses:
'200':
description: Adds the Active Directory Domain Controller Services.
schema:
$ref: '#/definitions/ServiceProperties'
summary: Microsoft Azure Post Providers Microsoft Adhybridhealthservice Addsservices
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}:
get:
tags: []
description: >-
Gets the details of an Active Directory Domain Service for a tenant
having Azure AD Premium license and is onboarded to Azure Active
Directory Connect Health.
x-ms-examples:
addsServices_get:
$ref: ./examples/Service.json
operationId: microsoftAzureAddsservicesGet
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: >-
The Active Directory Domain Controller service as specified by the
serviceName property.
schema:
$ref: '#/definitions/ServiceProperties'
summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename
delete:
tags: []
description: >-
Deletes an Active Directory Domain Service which is onboarded to Azure
Active Directory Connect Health.
x-ms-examples:
addsServices_delete:
$ref: ./examples/DeleteService.json
operationId: microsoftAzureAddsservicesDelete
parameters:
- name: serviceName
in: path
description: The name of the service which needs to be deleted.
required: true
type: string
- name: confirm
in: query
description: >-
Indicates if the service will be permanently deleted or disabled.
True indicates that the service will be permanently deleted and
False indicates that the service will be marked disabled and then
deleted after 30 days, if it is not re-registered.
required: false
type: boolean
- $ref: '#/parameters/apiVersionParameter'
responses:
'204':
description: Successfully deleted the service.
summary: >-
Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Addsservices Servicename
patch:
tags: []
description: >-
Updates an Active Directory Domain Service properties of an onboarded
service.
x-ms-examples:
addsServices_update:
$ref: ./examples/UpdateService.json
operationId: microsoftAzureAddsservicesUpdate
parameters:
- name: serviceName
in: path
description: The name of the service which needs to be deleted.
required: true
type: string
- name: service
in: body
description: The service object.
required: true
schema:
$ref: '#/definitions/ServiceProperties'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: Successfully updated service.
schema:
$ref: '#/definitions/ServiceProperties'
summary: Microsoft Azure Patch Providers Microsoft Adhybridhealthservice Addsservices Servicename
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts:
get:
tags:
- Adds
description: Gets the alerts for a given Active Directory Domain Service.
x-ms-examples:
alerts_listAddsAlerts:
$ref: ./examples/Alerts.json
operationId: microsoftAzureAlertsListaddsalerts
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: $filter
in: query
description: The alert property filter to apply.
required: false
type: string
- name: state
in: query
description: The alert state to query for.
required: false
type: string
- name: from
in: query
description: The start date to query for.
required: false
type: string
format: date-time
- name: to
in: query
description: The end date till when to query for.
required: false
type: string
format: date-time
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: The list of alerts for the given service.
schema:
$ref: '#/definitions/Alerts'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Alerts
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration:
get:
tags:
- Adds
description: Gets the service configurations.
x-ms-examples:
configuration_listAddsConfigurations:
$ref: ./examples/AddsConfiguration.json
operationId: microsoftAzureConfigurationListaddsconfigurations
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: grouping
in: query
description: The grouping for configurations.
required: false
type: string
responses:
'200':
description: 'The Active Directory Domain Controller service configuration. '
schema:
$ref: '#/definitions/AddsConfiguration'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Configuration
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}:
get:
tags:
- Adds
description: Gets the dimensions for a given dimension type in a server.
x-ms-examples:
dimensions_listAddsDimensions:
$ref: ./examples/Dimensions.json
operationId: microsoftAzureDimensionsListaddsdimensions
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: dimension
in: path
description: The dimension type.
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of dimensions for a server. '
schema:
$ref: '#/definitions/Dimensions'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Dimensions Dimension
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers:
get:
tags:
- Adds
description: >-
Gets the details of the Active Directory Domain servers, for a given
Active Directory Domain Service, that are onboarded to Azure Active
Directory Connect Health.
x-ms-examples:
addsServiceMembers_list:
$ref: ./examples/AddsServiceMembers.json
operationId: microsoftAzureAddsservicemembersList
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: $filter
in: query
description: The server property filter to apply.
required: false
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of Active Directory Domain Servers. '
schema:
$ref: '#/definitions/AddsServiceMembers'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Addsservicemembers
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers:
get:
tags:
- Adds
description: >-
Gets the details of the servers, for a given Active Directory Domain
Service, that are onboarded to Azure Active Directory Connect Health.
x-ms-examples:
adDomainServiceMembers_list:
$ref: ./examples/AddomainServiceMembers.json
operationId: microsoftAzureAddomainservicemembersList
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: $filter
in: query
description: The server property filter to apply.
required: false
type: string
- name: isGroupbySite
in: query
description: Indicates if the result should be grouped by site or not.
required: true
type: boolean
- name: query
in: query
description: The custom query.
required: false
type: string
- name: nextPartitionKey
in: query
description: The next partition key to query for.
required: true
type: string
enum:
- ' '
x-ms-enum:
name: nextPartitionKey
modelAsString: true
- name: nextRowKey
in: query
description: The next row key to query for.
required: true
type: string
enum:
- ' '
x-ms-enum:
name: nextRowKey
modelAsString: true
- name: takeCount
in: query
description: >-
The take count , which specifies the number of elements that can be
returned from a sequence.
required: false
type: integer
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: The list of Active Directory Domain Servers.
schema:
$ref: '#/definitions/AddsServiceMembers'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Addomainservicemembers
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference:
get:
tags:
- Adds
description: Gets the user preferences for a given feature.
x-ms-examples:
addsServicesUserPreference_get:
$ref: ./examples/UserPreference.json
operationId: microsoftAzureAddsservicesuserpreferenceGet
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: featureName
in: path
description: The name of the feature.
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The user preference settings. '
schema:
$ref: '#/definitions/UserPreference'
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Features Featurename Userpreference
delete:
tags:
- Adds
description: Deletes the user preferences for a given feature.
x-ms-examples:
addsServicesUserPreference_delete:
$ref: ./examples/DeleteUserPreference.json
operationId: microsoftAzureAddsservicesuserpreferenceDelete
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: featureName
in: path
description: The name of the feature.
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'Successfully deleted the user preference settings. '
summary: >-
Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Addsservices Servicename Features Featurename Userpreference
post:
tags:
- Adds
description: Adds the user preferences for a given feature.
x-ms-examples:
addsServicesUserPreference_add:
$ref: ./examples/AddUserPreference.json
operationId: microsoftAzureAddsservicesuserpreferenceAdd
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: featureName
in: path
description: The name of the feature.
required: true
type: string
- name: setting
in: body
description: The user preference setting.
required: true
schema:
$ref: '#/definitions/UserPreference'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: ' Successfully added the user preference settings. '
summary: >-
Microsoft Azure Post Providers Microsoft Adhybridhealthservice Addsservices Servicename Features Featurename Userpreference
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary:
get:
tags:
- Adds
description: >-
Gets the forest summary for a given Active Directory Domain Service,
that is onboarded to Azure Active Directory Connect Health.
x-ms-examples:
addsServices_getForestSummary:
$ref: ./examples/ForestSummary.json
operationId: microsoftAzureAddsservicesGetforestsummary
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of forest summary for the service. '
schema:
$ref: '#/definitions/ForestSummary'
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Forestsummary
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}:
get:
tags:
- Adds
description: >-
Gets the server related metrics for a given metric and group
combination.
x-ms-examples:
addsService_getMetrics:
$ref: ./examples/Service_MetricSets.json
operationId: microsoftAzureAddsserviceGetmetrics
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: metricName
in: path
description: The metric name
required: true
type: string
- name: groupName
in: path
description: The group name
required: true
type: string
- name: groupKey
in: query
description: The group key
required: false
type: string
- name: fromDate
in: query
description: The start date.
required: false
type: string
format: date-time
- name: toDate
in: query
description: The end date.
required: false
type: string
format: date-time
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The metric sets for the service. '
schema:
$ref: '#/definitions/MetricSets'
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metrics Metricname Groups Groupname
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average:
get:
tags:
- Adds
description: >-
Gets the average of the metric values for a given metric and group
combination.
x-ms-examples:
addsServices_listMetricsAverage:
$ref: ./examples/Metrics.json
operationId: microsoftAzureAddsservicesListmetricsaverage
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: metricName
in: path
description: The metric name
required: true
type: string
- name: groupName
in: path
description: The group name
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of metrics. '
schema:
$ref: '#/definitions/Metrics'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metrics Metricname Groups Groupname Average
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum:
get:
tags:
- Adds
description: >-
Gets the sum of the metric values for a given metric and group
combination.
x-ms-examples:
addsServices_listMetricsSum:
$ref: ./examples/Metrics.json
operationId: microsoftAzureAddsservicesListmetricssum
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: metricName
in: path
description: The metric name
required: true
type: string
- name: groupName
in: path
description: The group name
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of aum of the metric values for a given service. '
schema:
$ref: '#/definitions/Metrics'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metrics Metricname Groups Groupname Sum
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata:
get:
tags:
- Adds
description: Gets the service related metrics information.
x-ms-examples:
addsServices_listMetricMetadata:
$ref: ./examples/MetricMetadataList.json
operationId: microsoftAzureAddsservicesListmetricmetadata
parameters:
- name: $filter
in: query
description: The metric metadata property filter to apply.
required: false
type: string
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: perfCounter
in: query
description: Indicates if only performance counter metrics are requested.
required: false
type: boolean
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of metric metadata for a service. '
schema:
$ref: '#/definitions/MetricMetadataList'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metricmetadata
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}:
get:
tags:
- Adds
description: Gets the service related metric information.
x-ms-examples:
addsServices_getMetricMetadata:
$ref: ./examples/MetricMetadata.json
operationId: microsoftAzureAddsservicesGetmetricmetadata
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: metricName
in: path
description: The metric name
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: ' The metric metadata for the service.'
schema:
$ref: '#/definitions/MetricMetadata'
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metricmetadata Metricname
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}:
get:
tags:
- Adds
description: >-
Gets the service related metrics for a given metric and group
combination.
x-ms-examples:
addsServices_getMetricMetadataForGroup:
$ref: ./examples/MetricSets.json
operationId: microsoftAzureAddsservicesGetmetricmetadataforgroup
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: metricName
in: path
description: The metric name
required: true
type: string
- name: groupName
in: path
description: The group name
required: true
type: string
- name: groupKey
in: query
description: The group key
required: false
type: string
- name: fromDate
in: query
description: The start date.
required: false
type: string
format: date-time
- name: toDate
in: query
description: The end date.
required: false
type: string
format: date-time
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The metric sets for a given service and group. '
schema:
$ref: '#/definitions/MetricSets'
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metricmetadata Metricname Groups Groupname
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails:
get:
tags:
- Adds
description: >-
Gets complete domain controller list along with replication details for
a given Active Directory Domain Service, that is onboarded to Azure
Active Directory Connect Health.
x-ms-examples:
addsServices_listReplicationDetails:
$ref: ./examples/ReplicationDetails.json
operationId: microsoftAzureAddsservicesListreplicationdetails
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: $filter
in: query
description: The server property filter to apply.
required: false
type: string
- name: withDetails
in: query
description: Indicates if InboundReplicationNeighbor details are required or not.
required: false
type: boolean
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of replication details for a service. '
schema:
$ref: '#/definitions/ReplicationDetailsList'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Replicationdetails
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus:
get:
tags:
- Adds
description: >-
Gets Replication status for a given Active Directory Domain Service,
that is onboarded to Azure Active Directory Connect Health.
x-ms-examples:
addsServicesReplicationStatus_get:
$ref: ./examples/ReplicationStatus.json
operationId: microsoftAzureAddsservicesreplicationstatusGet
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The replication status for a service. '
schema:
$ref: '#/definitions/ReplicationStatus'
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Replicationstatus
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary:
get:
tags:
- Adds
description: >-
Gets complete domain controller list along with replication details for
a given Active Directory Domain Service, that is onboarded to Azure
Active Directory Connect Health.
x-ms-examples:
addsServices_listReplicationSummary:
$ref: ./examples/ReplicationSummary.json
operationId: microsoftAzureAddsservicesListreplicationsummary
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: $filter
in: query
description: The server property filter to apply.
required: false
type: string
- name: isGroupbySite
in: query
description: Indicates if the result should be grouped by site or not.
required: true
type: boolean
- name: query
in: query
description: The custom query.
required: true
type: string
- name: nextPartitionKey
in: query
description: The next partition key to query for.
required: true
type: string
enum:
- ' '
x-ms-enum:
name: nextPartitionKey
modelAsString: true
- name: nextRowKey
in: query
description: The next row key to query for.
required: true
type: string
enum:
- ' '
x-ms-enum:
name: nextRowKey
modelAsString: true
- name: takeCount
in: query
description: >-
The take count , which specifies the number of elements that can be
returned from a sequence.
required: false
type: integer
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: 'The list of replication summary for a service. '
schema:
$ref: '#/definitions/ReplicationSummaryList'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Replicationsummary
/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers:
get:
tags:
- Adds
description: >-
Gets the details of the servers, for a given Active Directory Domain
Controller service, that are onboarded to Azure Active Directory Connect
Health Service.
x-ms-examples:
addsServicesServiceMembers_list:
$ref: ./examples/ServiceMembers.json
operationId: microsoftAzureAddsservicesservicemembersList
parameters:
- name: serviceName
in: path
description: The name of the service.
required: true
type: string
- name: $filter
in: query
description: The server property filter to apply.
required: false
type: string
- name: dimensionType
in: query
description: The server specific dimension.
required: false
type: string
- name: dimensionSignature
in: query
description: The value of the dimension.
required: false
type: string
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: The list of service members for a given service.
schema:
$ref: '#/definitions/ServiceMembers'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers
post:
tags:
- Adds
description: >-
Onboards a server, for a given Active Directory Domain Controller
service, to Azure Active Directory Connect Health Service.
x-ms-examples:
addsServicesServiceMembers_add:
$ref: ./examples/AddServiceMembers.json
operationId: microsoftAzureAddsservicesservicemembersAdd
parameters:
- name: serviceName
in: path
description: The name of the service under which the server is to be onboarded.
required: true
type: string
- name: serviceMember
in: body
description: The server object.
required: true
schema:
$ref: '#/definitions/ServiceMember'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: Successfully added the service member.
schema:
$ref: '#/definitions/ServiceMember'
summary: >-
Microsoft Azure Post Provi
# --- truncated at 32 KB (169 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/adhybridhealthservice-openapi-original.yml