Microsoft.ADHybridHealthService (stable:2014-01-01)

2025/09/26 • 77 new, 77 deleted methods

addsServices_list (new)
Description :  Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_add (new)
Description :  Onboards a service for a given tenant in Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/addsservices
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
addsServices_get (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
addsServices_delete (new)
Description :  Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
confirm:
{
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 ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
addsServices_update (new)
Description :  Updates an Active Directory Domain Service properties of an onboarded service.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
alerts_listAddsAlerts (new)
Description :  Gets the alerts for a given Active Directory Domain Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
configuration_listAddsConfigurations (new)
Description :  Gets the service configurations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
grouping:
{
Description: The grouping for configurations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of configuration. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
dimensions_listAddsDimensions (new)
Description :  Gets the dimensions for a given dimension type in a server.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
dimension:
{
Description: The dimension type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
health:
{
Description: The health status for the domain controller. ,
Enum:
{
Healthy: No description available. ,
Warning: No description available. ,
Error: No description available. ,
NotMonitored: No description available. ,
Missing: No description available. ,
}
,
Required: False ,
}
enum ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of dimensions. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServiceMembers_list (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name. ,
Required: False ,
}
string ,
siteName:
{
Description: The site name. ,
Required: False ,
}
string ,
addsRoles:
{
Description: The list of ADDS roles. ,
Required: False ,
}
[
string ,
]
,
gcReachable:
{
Description: Indicates if the global catalog for this domain is reachable or not. ,
Required: False ,
}
boolean ,
isAdvertising:
{
Description: Indicates if the Dc is advertising or not. ,
Required: False ,
}
boolean ,
pdcReachable:
{
Description: Indicates if the primary domain controller is reachable or not. ,
Required: False ,
}
boolean ,
sysvolState:
{
Description: Indicates if the SYSVOL state is healthy or not. ,
Required: False ,
}
boolean ,
dcTypes:
{
Description: The list of domain controller types. ,
Required: False ,
}
[
string ,
]
,
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service members. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
adDomainServiceMembers_list (new)
Description :  Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
isGroupbySite:
{
Description: Indicates if the result should be grouped by site or not. ,
Required: True ,
}
boolean ,
query:
{
Description: The custom query. ,
Required: False ,
}
string ,
nextPartitionKey:
{
Description: The next partition key to query for. ,
Required: True ,
}
string ,
nextRowKey:
{
Description: The next row key to query for. ,
Required: True ,
}
string ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name. ,
Required: False ,
}
string ,
siteName:
{
Description: The site name. ,
Required: False ,
}
string ,
addsRoles:
{
Description: The list of ADDS roles. ,
Required: False ,
}
[
string ,
]
,
gcReachable:
{
Description: Indicates if the global catalog for this domain is reachable or not. ,
Required: False ,
}
boolean ,
isAdvertising:
{
Description: Indicates if the Dc is advertising or not. ,
Required: False ,
}
boolean ,
pdcReachable:
{
Description: Indicates if the primary domain controller is reachable or not. ,
Required: False ,
}
boolean ,
sysvolState:
{
Description: Indicates if the SYSVOL state is healthy or not. ,
Required: False ,
}
boolean ,
dcTypes:
{
Description: The list of domain controller types. ,
Required: False ,
}
[
string ,
]
,
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service members. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServicesUserPreference_get (new)
Description :  Gets the user preferences for a given feature.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metricNames:
{
Description: The name of the metric. ,
Required: False ,
}
[
string ,
]
,
}
addsServicesUserPreference_delete (new)
Description :  Deletes the user preferences for a given feature.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
addsServicesUserPreference_add (new)
Description :  Adds the user preferences for a given feature.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
setting:
{
Description: The user preference setting. ,
Required: True ,
}
{
metricNames:
{
Description: The name of the metric. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
addsServices_getForestSummary (new)
Description :  Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
forestName:
{
Description: The forest name. ,
Required: False ,
}
string ,
domainCount:
{
Description: The domain count. ,
Required: False ,
}
integer ,
siteCount:
{
Description: The site count. ,
Required: False ,
}
integer ,
monitoredDcCount:
{
Description: The number of domain controllers that are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
totalDcCount:
{
Description: The total domain controllers. ,
Required: False ,
}
integer ,
domains:
{
Description: The list of domain controller names. ,
Required: False ,
}
[
string ,
]
,
sites:
{
Description: The list of site names. ,
Required: False ,
}
[
string ,
]
,
}
addsService_getMetrics (new)
Description :  Gets the server related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
addsServices_listMetricsAverage (new)
Description :  Gets the average of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_listMetricsSum (new)
Description :  Gets the sum of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_listMetricMetadata (new)
Description :  Gets the service related metrics information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata
{
$filter:
{
Description: The metric metadata property filter to apply. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
perfCounter:
{
Description: Indicates if only performance counter metrics are requested. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_getMetricMetadata (new)
Description :  Gets the service related metric information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
addsServices_getMetricMetadataForGroup (new)
Description :  Gets the service related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
addsServices_listReplicationDetails (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
withDetails:
{
Description: Indicates if InboundReplicationNeighbor details are required or not. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
targetServer:
{
Description: The domain controller name. ,
Required: False ,
}
string ,
site:
{
Description: The site name for a given domain controller. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for a given domain controller. ,
Required: False ,
}
string ,
status:
{
Description: The health status for a domain controller. ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time when a sync was attempted for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The time when the last successful sync happened for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
inboundNeighborCollection:
{
Description: List of individual domain controller neighbor's inbound replication status. ,
Required: False ,
}
[
{
sourceDomainController:
{
Description: The name of the source domain controller. ,
Required: False ,
}
string ,
consecutiveFailureCount:
{
Description: The number of consecutive failure counts. ,
Required: False ,
}
integer ,
namingContext:
{
Description: The naming context. ,
Required: False ,
}
string ,
status:
{
Description: The health status for the domain controller ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time a sync was attempted on the domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The last time when a successful sync happened. ,
Format: date-time ,
Required: False ,
}
string ,
lastErrorCode:
{
Description: The last error code. ,
Required: False ,
}
integer ,
lastErrorMessage:
{
Description: The error message of the last error. ,
Required: False ,
}
string ,
errorTitle:
{
Description: The error title. ,
Required: False ,
}
string ,
errorDescription:
{
Description: The error description. ,
Required: False ,
}
string ,
fixLink:
{
Description: The link for the fix of the error. ,
Required: False ,
}
string ,
fixDetails:
{
Description: The details of the fix. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The additional details. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
totalCount:
{
Description: The total count of replication detail elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}
addsServicesReplicationStatus_get (new)
Description :  Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
forestName:
{
Description: The forest name. ,
Required: False ,
}
string ,
totalDcCount:
{
Description: The total number of domain controllers for a given forest. ,
Required: False ,
}
integer ,
errorDcCount:
{
Description: The total number of domain controllers with error in a given forest. ,
Required: False ,
}
integer ,
}
addsServices_listReplicationSummary (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
isGroupbySite:
{
Description: Indicates if the result should be grouped by site or not. ,
Required: True ,
}
boolean ,
query:
{
Description: The custom query. ,
Required: True ,
}
string ,
nextPartitionKey:
{
Description: The next partition key to query for. ,
Required: True ,
}
string ,
nextRowKey:
{
Description: The next row key to query for. ,
Required: True ,
}
string ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
targetServer:
{
Description: The domain controller name. ,
Required: False ,
}
string ,
site:
{
Description: The site name for a given domain controller. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for a given domain controller. ,
Required: False ,
}
string ,
status:
{
Description: The health status for a domain controller. ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time when a sync was attempted for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The time when the last successful sync happened for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
inboundNeighborCollection:
{
Description: List of individual domain controller neighbor's inbound replication status. ,
Required: False ,
}
[
{
sourceDomainController:
{
Description: The name of the source domain controller. ,
Required: False ,
}
string ,
consecutiveFailureCount:
{
Description: The number of consecutive failure counts. ,
Required: False ,
}
integer ,
namingContext:
{
Description: The naming context. ,
Required: False ,
}
string ,
status:
{
Description: The health status for the domain controller ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time a sync was attempted on the domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The last time when a successful sync happened. ,
Format: date-time ,
Required: False ,
}
string ,
lastErrorCode:
{
Description: The last error code. ,
Required: False ,
}
integer ,
lastErrorMessage:
{
Description: The error message of the last error. ,
Required: False ,
}
string ,
errorTitle:
{
Description: The error title. ,
Required: False ,
}
string ,
errorDescription:
{
Description: The error description. ,
Required: False ,
}
string ,
fixLink:
{
Description: The link for the fix of the error. ,
Required: False ,
}
string ,
fixDetails:
{
Description: The details of the fix. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The additional details. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
addsServicesServiceMembers_list (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
dimensionType:
{
Description: The server specific dimension. ,
Required: False ,
}
string ,
dimensionSignature:
{
Description: The value of the dimension. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServicesServiceMembers_add (new)
Description :  Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service under which the server is to be onboarded. ,
Required: True ,
}
string ,
serviceMember:
{
Description: The server object. ,
Required: True ,
}
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
addsServiceMembers_get (new)
Description :  Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
addsServiceMembers_delete (new)
Description :  Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
confirm:
{
Description: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
addsServices_listServerAlerts (new)
Description :  Gets the details of an alert for a given Active Directory Domain Controller service and server combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts
{
serviceMemberId:
{
Description: The server Id for which the alert details needs to be queried. ,
Format: uuid ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServiceMembers_listCredentials (new)
Description :  Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The property filter to apply. ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
identifier:
{
Description: The credential identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of credential. ,
Required: False ,
}
string ,
credentialData:
{
Description: The credential data. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
addsServices_listPremiumServices (new)
Description :  Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
operations_list (new)
Description :  Lists the available Azure Data Factory API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/operations
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of operations supported by the Microsoft.ADHybridHealthService resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display details for the operation. ,
Required: False ,
}
object ,
}
,
]
,
totalCount:
{
Description: The total count of operations. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token to get next set of operations. ,
Required: False ,
}
string ,
}
configuration_add (new)
Description :  Onboards a tenant in Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/configuration
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
configuration_get (new)
Description :  Gets the details of a tenant onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/configuration
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
configuration_update (new)
Description :  Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/configuration
{
tenant:
{
Description: The tenant object with the properties set to the updated value. ,
Required: True ,
}
{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
reports_getDevOps (new)
Description :  Checks if the user is enabled for Dev Ops access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
boolean ,
}
services_list (new)
Description :  Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_add (new)
Description :  Onboards a service for a given tenant in Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
services_listPremium (new)
Description :  Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/premiumCheck
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_get (new)
Description :  Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
services_delete (new)
Description :  Deletes a service which is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
confirm:
{
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 ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
services_update (new)
Description :  Updates the service properties of an onboarded service.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
services_listAlerts (new)
Description :  Gets the alerts for a given service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_getFeatureAvailibility (new)
Description :  Checks if the service has all the pre-requisites met to use a feature.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
boolean ,
}
services_listExportErrors (new)
Description :  Gets the count of latest AAD export errors.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
errorBucket:
{
Description: The error bucket. ,
Required: False ,
}
string ,
count:
{
Description: The error count. ,
Required: False ,
}
integer ,
truncated:
{
Description: Indicates if the error count is truncated or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
services_listExportErrorsV2 (new)
Description :  Gets the categorized export errors.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
errorBucket:
{
Description: The error category to query for. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The error Id. ,
Required: False ,
}
string ,
incomingObjectDisplayName:
{
Description: The incoming object display name. ,
Required: False ,
}
string ,
incomingObjectType:
{
Description: The incoming object type. ,
Required: False ,
}
string ,
userPrincipalName:
{
Description: The user principal name ,
Required: False ,
}
string ,
type:
{
Description: The type of the error. ,
Required: False ,
}
string ,
attributeName:
{
Description: The attribute name. ,
Required: False ,
}
string ,
attributeValue:
{
Description: The attribute value. ,
Required: False ,
}
string ,
timeOccurred:
{
Description: The date and time when the error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
timeFirstOccurred:
{
Description: The time when the error first occurred. ,
Format: date-time ,
Required: False ,
}
string ,
csObjectId:
{
Description: the cs object Id. ,
Required: False ,
}
string ,
dn:
{
Description: the DN of the object. ,
Required: False ,
}
string ,
incomingObject:
{
Description: The incoming object details. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the object. ,
Required: False ,
}
string ,
distinguishedName:
{
Description: The distinguished name of the object. ,
Required: False ,
}
string ,
lastDirSyncTime:
{
Description: The last dirSync time. ,
Format: date-time ,
Required: False ,
}
string ,
mail:
{
Description: The email of the object. ,
Required: False ,
}
string ,
objectGuid:
{
Description: The object guid. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type. ,
Required: False ,
}
string ,
onpremisesUserPrincipalName:
{
Description: The On-premises UPN. ,
Required: False ,
}
string ,
proxyAddresses:
{
Description: The proxy addresses. ,
Required: False ,
}
string ,
sourceAnchor:
{
Description: The source anchor. ,
Required: False ,
}
string ,
sourceOfAuthority:
{
Description: The source of authority. ,
Required: False ,
}
string ,
timeOccurred:
{
Description: The time of the error. ,
Format: date-time ,
Required: False ,
}
string ,
userPrincipalName:
{
Description: The UPN. ,
Required: False ,
}
string ,
}
,
existingObject:
{
Description: The existing object ,
Required: False ,
}
{
displayName:
{
Description: The display name of the object. ,
Required: False ,
}
string ,
distinguishedName:
{
Description: The distinguished name of the object. ,
Required: False ,
}
string ,
lastDirSyncTime:
{
Description: The last dirSync time. ,
Format: date-time ,
Required: False ,
}
string ,
mail:
{
Description: The email of the object. ,
Required: False ,
}
string ,
objectGuid:
{
Description: The object guid. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type. ,
Required: False ,
}
string ,
onpremisesUserPrincipalName:
{
Description: The On-premises UPN. ,
Required: False ,
}
string ,
proxyAddresses:
{
Description: The proxy addresses. ,
Required: False ,
}
string ,
sourceAnchor:
{
Description: The source anchor. ,
Required: False ,
}
string ,
sourceOfAuthority:
{
Description: The source of authority. ,
Required: False ,
}
string ,
timeOccurred:
{
Description: The time of the error. ,
Format: date-time ,
Required: False ,
}
string ,
userPrincipalName:
{
Description: The UPN. ,
Required: False ,
}
string ,
}
,
modifiedOrRemovedAttributeValue:
{
Description: The modified or removed attribute value. ,
Required: False ,
}
string ,
runStepResultId:
{
Description: The run step result Id. ,
Format: uuid ,
Required: False ,
}
string ,
samAccountName:
{
Description: The sam account name. ,
Required: False ,
}
string ,
serverErrorDetail:
{
Description: The server error details. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
mergedEntityId:
{
Description: The merged entity Id. ,
Format: uuid ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the error was created. ,
Format: date-time ,
Required: False ,
}
string ,
exportErrorStatus:
{
Description: The export error status. ,
Required: False ,
}
integer ,
}
,
]
,
}
services_listExportStatus (new)
Description :  Gets the export status.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceId:
{
Description: The id of the service for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
endTime:
{
Description: The date and time when the export ended. ,
Format: date-time ,
Required: False ,
}
string ,
runStepResultId:
{
Description: The run step result Id. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_addAlertFeedback (new)
Description :  Adds an alert feedback submitted by customer.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
alertFeedback:
{
Description: The alert feedback. ,
Required: True ,
}
{
level:
{
Description: The alert level which indicates the severity of the alert. ,
Required: False ,
}
string ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Required: False ,
}
string ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
feedback:
{
Description: The feedback for the alert which indicates if the customer likes or dislikes the alert. ,
Required: False ,
}
string ,
comment:
{
Description: Additional comments related to the alert. ,
Required: False ,
}
string ,
consentedToShare:
{
Description: Indicates if the alert feedback can be shared from product team. ,
Required: False ,
}
boolean ,
serviceMemberId:
{
Description: The server Id of the alert. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
level:
{
Description: The alert level which indicates the severity of the alert. ,
Required: False ,
}
string ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Required: False ,
}
string ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
feedback:
{
Description: The feedback for the alert which indicates if the customer likes or dislikes the alert. ,
Required: False ,
}
string ,
comment:
{
Description: Additional comments related to the alert. ,
Required: False ,
}
string ,
consentedToShare:
{
Description: Indicates if the alert feedback can be shared from product team. ,
Required: False ,
}
boolean ,
serviceMemberId:
{
Description: The server Id of the alert. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
services_listAlertFeedback (new)
Description :  Gets a list of all alert feedback for a given tenant and alert type.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
shortName:
{
Description: The name of the alert. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
level:
{
Description: The alert level which indicates the severity of the alert. ,
Required: False ,
}
string ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Required: False ,
}
string ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
feedback:
{
Description: The feedback for the alert which indicates if the customer likes or dislikes the alert. ,
Required: False ,
}
string ,
comment:
{
Description: Additional comments related to the alert. ,
Required: False ,
}
string ,
consentedToShare:
{
Description: Indicates if the alert feedback can be shared from product team. ,
Required: False ,
}
boolean ,
serviceMemberId:
{
Description: The server Id of the alert. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
service_getMetrics (new)
Description :  Gets the server related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
services_listMetricsAverage (new)
Description :  Gets the average of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_listMetricsSum (new)
Description :  Gets the sum of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_listMetricMetadata (new)
Description :  Gets the service related metrics information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata
{
$filter:
{
Description: The metric metadata property filter to apply. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
perfCounter:
{
Description: Indicates if only performance counter metrics are requested. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_getMetricMetadata (new)
Description :  Gets the service related metrics information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
services_getMetricMetadataForGroup (new)
Description :  Gets the service related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
services_updateMonitoringConfiguration (new)
Description :  Updates the service level monitoring configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
configurationSetting:
{
Description: The monitoring configuration to update ,
Required: True ,
}
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
services_listMonitoringConfigurations (new)
Description :  Gets the service level monitoring configurations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
}
services_listUserBadPasswordReport (new)
Description :  Gets the bad password login attempt report for an user
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
dataSource:
{
Description: The source of data, if its test data or customer data. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
userId:
{
Description: The user ID value. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address corresponding to the last error event. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time when the last error event was logged. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueIpAddresses:
{
Description: The list of unique IP addresses. ,
Required: False ,
}
string ,
totalErrorAttempts:
{
Description: The total count of specific error events. ,
Required: False ,
}
integer ,
}
,
]
,
}
serviceMembers_list (new)
Description :  Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
dimensionType:
{
Description: The server specific dimension. ,
Required: False ,
}
string ,
dimensionSignature:
{
Description: The value of the dimension. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
serviceMembers_add (new)
Description :  Onboards a server, for a given service, to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service under which the server is to be onboarded. ,
Required: True ,
}
string ,
serviceMember:
{
Description: The server object. ,
Required: True ,
}
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
serviceMembers_get (new)
Description :  Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
serviceMembers_delete (new)
Description :  Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
confirm:
{
Description: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
serviceMembers_listAlerts (new)
Description :  Gets the details of an alert for a given service and server combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts
{
serviceMemberId:
{
Description: The server Id for which the alert details needs to be queried. ,
Format: uuid ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
serviceMembers_listConnectors (new)
Description :  Gets the connector details for a service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
connectorId:
{
Description: The connector Id. ,
Required: False ,
}
string ,
id:
{
Description: The connector Id. ,
Required: False ,
}
string ,
name:
{
Description: The connector name. ,
Required: False ,
}
string ,
version:
{
Description: The connector version ,
Required: False ,
}
integer ,
type:
{
Description: The connector type. ,
Required: False ,
}
string ,
description:
{
Description: The connector description. ,
Required: False ,
}
string ,
schemaXml:
{
Description: The schema xml for the connector. ,
Required: False ,
}
string ,
passwordManagementSettings:
{
Description: The password management settings of the connector. ,
Required: False ,
}
object ,
passwordHashSyncConfiguration:
{
Description: The password hash synchronization configuration of the connector. ,
Required: False ,
}
object ,
timeCreated:
{
Description: The date and time when this connector was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeLastModified:
{
Description: The date and time when this connector was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
partitions:
{
Description: The partitions of the connector. ,
Required: False ,
}
[
{
id:
{
Description: The partition Id. ,
Required: False ,
}
string ,
dn:
{
Description: The distinguished name for the partition. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the partition object is selected or not. ,
Required: False ,
}
boolean ,
timeCreated:
{
Description: The date and time when the partition is created. ,
Format: date-time ,
Required: False ,
}
string ,
timeLastModified:
{
Description: The time and date when the partition was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
partitionScope:
{
Description: The scope of the partition. ,
Required: False ,
}
{
isDefault:
{
Description: Indicates if the partition scope is default or not. ,
Required: False ,
}
boolean ,
objectClasses:
{
Description: The in-scope object classes. ,
Required: False ,
}
[
string ,
]
,
containersIncluded:
{
Description: The list of containers included. ,
Required: False ,
}
[
string ,
]
,
containersExcluded:
{
Description: The list of containers excluded. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the partition. ,
Required: False ,
}
string ,
isDomain:
{
Description: Indicates if the partition is a domain or not. ,
Required: False ,
}
boolean ,
type:
{
Description: The partition type. ,
Required: False ,
}
string ,
}
,
]
,
runProfiles:
{
Description: The run profiles of the connector. ,
Required: False ,
}
[
{
id:
{
Description: The run profile Id. ,
Required: False ,
}
string ,
name:
{
Description: The run profile name ,
Required: False ,
}
string ,
runSteps:
{
Description: The run steps of the run profile. ,
Required: False ,
}
[
{
batchSize:
{
Description: The batch size used by the run step. ,
Required: False ,
}
integer ,
objectProcessLimit:
{
Description: The object processing limit. ,
Required: False ,
}
integer ,
objectDeleteLimit:
{
Description: The object deletion limit. ,
Required: False ,
}
integer ,
pageSize:
{
Description: The page size of the run step. ,
Required: False ,
}
integer ,
partitionId:
{
Description: The Id of the partition that a current run step operation is executing. ,
Required: False ,
}
string ,
operationType:
{
Description: The run step operation types. ,
Required: False ,
}
integer ,
timeout:
{
Description: The operation timeout. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classesIncluded:
{
Description: The class inclusion list of the connector. ,
Required: False ,
}
[
string ,
]
,
attributesIncluded:
{
Description: The attribute inclusion list of the connector. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
serviceMembers_listCredentials (new)
Description :  Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The property filter to apply. ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
identifier:
{
Description: The credential identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of credential. ,
Required: False ,
}
string ,
credentialData:
{
Description: The credential data. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
serviceMembers_deleteData (new)
Description :  Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
serviceMembers_listDataFreshness (new)
Description :  Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
}
serviceMembers_listExportStatus (new)
Description :  Gets the export status.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceId:
{
Description: The id of the service for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
endTime:
{
Description: The date and time when the export ended. ,
Format: date-time ,
Required: False ,
}
string ,
runStepResultId:
{
Description: The run step result Id. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
serviceMembers_listGlobalConfiguration (new)
Description :  Gets the global configuration.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
version:
{
Description: The version for the global configuration. ,
Required: False ,
}
integer ,
schemaXml:
{
Description: The schema for the configuration. ,
Required: False ,
}
string ,
passwordSyncEnabled:
{
Description: Indicates if password sync is enabled or not. ,
Required: False ,
}
boolean ,
numSavedPwdEvent:
{
Description: The number of saved password events. ,
Required: False ,
}
integer ,
featureSet:
{
Description: The list of additional feature sets. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
serviceMembers_getMetrics (new)
Description :  Gets the server related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server id. ,
Format: uuid ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
serviceMembers_getServiceConfiguration (new)
Description :  Gets the service configuration.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
version:
{
Description: The version of the sync service. ,
Required: False ,
}
string ,
serviceType:
{
Description: The service type of the server. ,
Required: False ,
}
integer ,
serviceAccount:
{
Description: The service account. ,
Required: False ,
}
string ,
sqlServer:
{
Description: The SQL server information. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
sqlEdition:
{
Description: The SQL edition ,
Required: False ,
}
string ,
sqlInstance:
{
Description: The SQL instance details. ,
Required: False ,
}
string ,
sqlDatabaseName:
{
Description: The SQL database. ,
Required: False ,
}
string ,
sqlDatabaseSize:
{
Description: The SQL database size. ,
Required: False ,
}
integer ,
}
services_getTenantWhitelisting (new)
Description :  Checks if the tenant, to which a service is registered, is listed as allowed to use a feature.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
boolean ,
}
services_listAllRiskyIpDownloadReport (new)
Description :  Gets all Risky IP report URIs for the last 7 days.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of blob uris. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id for whom the report belongs to. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id for whom the report belongs to. ,
Required: False ,
}
string ,
resultSasUri:
{
Description: The blob uri for the report. ,
Required: False ,
}
string ,
blobCreateDateTime:
{
Description: Time at which the new Risky IP report was requested. ,
Format: date-time ,
Required: False ,
}
string ,
jobCompletionTime:
{
Description: Time at which the blob creation job for the new Risky IP report was completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the Risky IP report generation. ,
Required: False ,
}
string ,
}
,
]
,
}
services_listCurrentRiskyIpDownloadReport (new)
Description :  Initiate the generation of a new Risky IP report. Returns the URI for the new one.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of blob uris. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id for whom the report belongs to. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id for whom the report belongs to. ,
Required: False ,
}
string ,
resultSasUri:
{
Description: The blob uri for the report. ,
Required: False ,
}
string ,
blobCreateDateTime:
{
Description: Time at which the new Risky IP report was requested. ,
Format: date-time ,
Required: False ,
}
string ,
jobCompletionTime:
{
Description: Time at which the blob creation job for the new Risky IP report was completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the Risky IP report generation. ,
Required: False ,
}
string ,
}
,
]
,
}
serviceMembers_getConnectorMetadata (new)
Description :  Gets the list of connectors and run profile names.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The service member id. ,
Format: uuid ,
Required: True ,
}
string ,
metricName:
{
Description: The name of the metric. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
connectors:
{
Description: The list of connectors. ,
Required: False ,
}
[
{
connectorId:
{
Description: The Connector Id. ,
Required: False ,
}
string ,
connectorDisplayName:
{
Description: The Connector Display Name ,
Required: False ,
}
string ,
}
,
]
,
runProfileNames:
{
Description: The list of run profile names. ,
Required: False ,
}
[
string ,
]
,
}
list_IPAddressAggregatesByService (new)
Description :  Gets the IP address aggregates for a given service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregates
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
skiptoken:
{
Description: A continuationtoken value returned in paginated result to load different pages. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID ,
Required: False ,
}
string ,
serviceId:
{
Description: The service ID ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address from where the attempted login originated from. ,
Required: False ,
}
string ,
timestamp:
{
Description: When the event occurred ,
Required: False ,
}
string ,
firstAuditTimestamp:
{
Description: The first audit timestamp ,
Required: False ,
}
string ,
lastAuditTimestamp:
{
Description: The last audit timestamp ,
Required: False ,
}
string ,
extranetLockoutErrorCount:
{
Description: The extranet lockout error count ,
Required: False ,
}
integer ,
badPasswordErrorCount:
{
Description: The bad password error count ,
Required: False ,
}
integer ,
uniqueUsernamesAttemptedCount:
{
Description: The unique usernames attempted ,
Required: False ,
}
integer ,
attemptCountThresholdIsExceeded:
{
Description: A value indicating whether the attempt count threshold been exceeded ,
Required: False ,
}
boolean ,
timeSpan:
{
Description: The duration of the event ,
Required: False ,
}
string ,
isWhitelistedIpAddress:
{
Description: A value indicating whether the IP address has been listed as allowed. ,
Required: False ,
}
boolean ,
networkLocation:
{
Description: The network location ,
Required: False ,
}
string ,
attemptCountThresholdOnTrigger:
{
Description: The attempted count threshold on trigger. ,
Required: False ,
}
integer ,
attemptThresholdTypeOnTrigger:
{
Description: The attempted threshold type on trigger. ,
Required: False ,
}
string ,
geographicLocation:
{
Description: The geographic location. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of IP Aggregate list results if there are any. ,
Required: False ,
}
string ,
totalCount:
{
Description: The number of results. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
list_IPAddressAggregateSettings (new)
Description :  Gets the IP address aggregate settings.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
badPasswordAndExtranetLockoutCombinedDailyThreshold:
{
Description: This threshold setting defines the per day trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
badPasswordAndExtranetLockoutCombinedHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutDailyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
emailNotificationEnabled:
{
Description: A value indicating whether email notification has been enabled. ,
Required: False ,
}
boolean ,
}
update_IPAddressAggregateSettings (new)
Description :  Updates the IP address aggregate settings alert thresholds.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
IPAddressAggregateSetting:
{
Description: The IP address aggregate setting object. ,
Required: True ,
}
{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
badPasswordAndExtranetLockoutCombinedDailyThreshold:
{
Description: This threshold setting defines the per day trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
badPasswordAndExtranetLockoutCombinedHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutDailyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
emailNotificationEnabled:
{
Description: A value indicating whether email notification has been enabled. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
badPasswordAndExtranetLockoutCombinedDailyThreshold:
{
Description: This threshold setting defines the per day trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
badPasswordAndExtranetLockoutCombinedHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutDailyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
emailNotificationEnabled:
{
Description: A value indicating whether email notification has been enabled. ,
Required: False ,
}
boolean ,
}
addsServices_list (removed)
Description :  Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_add (removed)
Description :  Onboards a service for a given tenant in Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/addsservices
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
addsServices_get (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
addsServices_delete (removed)
Description :  Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
confirm:
{
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 ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
addsServices_update (removed)
Description :  Updates an Active Directory Domain Service properties of an onboarded service.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
alerts_listAddsAlerts (removed)
Description :  Gets the alerts for a given Active Directory Domain Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
configuration_listAddsConfigurations (removed)
Description :  Gets the service configurations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
grouping:
{
Description: The grouping for configurations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of configuration. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
dimensions_listAddsDimensions (removed)
Description :  Gets the dimensions for a given dimension type in a server.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
dimension:
{
Description: The dimension type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
health:
{
Description: The health status for the domain controller. ,
Enum:
{
Healthy: No description available. ,
Warning: No description available. ,
Error: No description available. ,
NotMonitored: No description available. ,
Missing: No description available. ,
}
,
Required: False ,
}
enum ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of dimensions. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServiceMembers_list (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name. ,
Required: False ,
}
string ,
siteName:
{
Description: The site name. ,
Required: False ,
}
string ,
addsRoles:
{
Description: The list of ADDS roles. ,
Required: False ,
}
[
string ,
]
,
gcReachable:
{
Description: Indicates if the global catalog for this domain is reachable or not. ,
Required: False ,
}
boolean ,
isAdvertising:
{
Description: Indicates if the Dc is advertising or not. ,
Required: False ,
}
boolean ,
pdcReachable:
{
Description: Indicates if the primary domain controller is reachable or not. ,
Required: False ,
}
boolean ,
sysvolState:
{
Description: Indicates if the SYSVOL state is healthy or not. ,
Required: False ,
}
boolean ,
dcTypes:
{
Description: The list of domain controller types. ,
Required: False ,
}
[
string ,
]
,
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service members. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
adDomainServiceMembers_list (removed)
Description :  Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
isGroupbySite:
{
Description: Indicates if the result should be grouped by site or not. ,
Required: True ,
}
boolean ,
query:
{
Description: The custom query. ,
Required: False ,
}
string ,
nextPartitionKey:
{
Description: The next partition key to query for. ,
Required: True ,
}
string ,
nextRowKey:
{
Description: The next row key to query for. ,
Required: True ,
}
string ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name. ,
Required: False ,
}
string ,
siteName:
{
Description: The site name. ,
Required: False ,
}
string ,
addsRoles:
{
Description: The list of ADDS roles. ,
Required: False ,
}
[
string ,
]
,
gcReachable:
{
Description: Indicates if the global catalog for this domain is reachable or not. ,
Required: False ,
}
boolean ,
isAdvertising:
{
Description: Indicates if the Dc is advertising or not. ,
Required: False ,
}
boolean ,
pdcReachable:
{
Description: Indicates if the primary domain controller is reachable or not. ,
Required: False ,
}
boolean ,
sysvolState:
{
Description: Indicates if the SYSVOL state is healthy or not. ,
Required: False ,
}
boolean ,
dcTypes:
{
Description: The list of domain controller types. ,
Required: False ,
}
[
string ,
]
,
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
[
{
kbName:
{
Description: The name of the hotfix KB. ,
Required: False ,
}
string ,
link:
{
Description: The link to the KB Article. ,
Required: False ,
}
string ,
installedDate:
{
Description: The date and time, in UTC, when the KB was installed in the server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service members. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServicesUserPreference_get (removed)
Description :  Gets the user preferences for a given feature.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metricNames:
{
Description: The name of the metric. ,
Required: False ,
}
[
string ,
]
,
}
addsServicesUserPreference_delete (removed)
Description :  Deletes the user preferences for a given feature.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
addsServicesUserPreference_add (removed)
Description :  Adds the user preferences for a given feature.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
setting:
{
Description: The user preference setting. ,
Required: True ,
}
{
metricNames:
{
Description: The name of the metric. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
addsServices_getForestSummary (removed)
Description :  Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
forestName:
{
Description: The forest name. ,
Required: False ,
}
string ,
domainCount:
{
Description: The domain count. ,
Required: False ,
}
integer ,
siteCount:
{
Description: The site count. ,
Required: False ,
}
integer ,
monitoredDcCount:
{
Description: The number of domain controllers that are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
totalDcCount:
{
Description: The total domain controllers. ,
Required: False ,
}
integer ,
domains:
{
Description: The list of domain controller names. ,
Required: False ,
}
[
string ,
]
,
sites:
{
Description: The list of site names. ,
Required: False ,
}
[
string ,
]
,
}
addsService_getMetrics (removed)
Description :  Gets the server related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
addsServices_listMetricsAverage (removed)
Description :  Gets the average of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_listMetricsSum (removed)
Description :  Gets the sum of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_listMetricMetadata (removed)
Description :  Gets the service related metrics information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata
{
$filter:
{
Description: The metric metadata property filter to apply. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
perfCounter:
{
Description: Indicates if only performance counter metrics are requested. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServices_getMetricMetadata (removed)
Description :  Gets the service related metric information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
addsServices_getMetricMetadataForGroup (removed)
Description :  Gets the service related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
addsServices_listReplicationDetails (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
withDetails:
{
Description: Indicates if InboundReplicationNeighbor details are required or not. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
targetServer:
{
Description: The domain controller name. ,
Required: False ,
}
string ,
site:
{
Description: The site name for a given domain controller. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for a given domain controller. ,
Required: False ,
}
string ,
status:
{
Description: The health status for a domain controller. ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time when a sync was attempted for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The time when the last successful sync happened for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
inboundNeighborCollection:
{
Description: List of individual domain controller neighbor's inbound replication status. ,
Required: False ,
}
[
{
sourceDomainController:
{
Description: The name of the source domain controller. ,
Required: False ,
}
string ,
consecutiveFailureCount:
{
Description: The number of consecutive failure counts. ,
Required: False ,
}
integer ,
namingContext:
{
Description: The naming context. ,
Required: False ,
}
string ,
status:
{
Description: The health status for the domain controller ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time a sync was attempted on the domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The last time when a successful sync happened. ,
Format: date-time ,
Required: False ,
}
string ,
lastErrorCode:
{
Description: The last error code. ,
Required: False ,
}
integer ,
lastErrorMessage:
{
Description: The error message of the last error. ,
Required: False ,
}
string ,
errorTitle:
{
Description: The error title. ,
Required: False ,
}
string ,
errorDescription:
{
Description: The error description. ,
Required: False ,
}
string ,
fixLink:
{
Description: The link for the fix of the error. ,
Required: False ,
}
string ,
fixDetails:
{
Description: The details of the fix. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The additional details. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
totalCount:
{
Description: The total count of replication detail elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}
addsServicesReplicationStatus_get (removed)
Description :  Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
forestName:
{
Description: The forest name. ,
Required: False ,
}
string ,
totalDcCount:
{
Description: The total number of domain controllers for a given forest. ,
Required: False ,
}
integer ,
errorDcCount:
{
Description: The total number of domain controllers with error in a given forest. ,
Required: False ,
}
integer ,
}
addsServices_listReplicationSummary (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
isGroupbySite:
{
Description: Indicates if the result should be grouped by site or not. ,
Required: True ,
}
boolean ,
query:
{
Description: The custom query. ,
Required: True ,
}
string ,
nextPartitionKey:
{
Description: The next partition key to query for. ,
Required: True ,
}
string ,
nextRowKey:
{
Description: The next row key to query for. ,
Required: True ,
}
string ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
targetServer:
{
Description: The domain controller name. ,
Required: False ,
}
string ,
site:
{
Description: The site name for a given domain controller. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for a given domain controller. ,
Required: False ,
}
string ,
status:
{
Description: The health status for a domain controller. ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time when a sync was attempted for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The time when the last successful sync happened for a given domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
inboundNeighborCollection:
{
Description: List of individual domain controller neighbor's inbound replication status. ,
Required: False ,
}
[
{
sourceDomainController:
{
Description: The name of the source domain controller. ,
Required: False ,
}
string ,
consecutiveFailureCount:
{
Description: The number of consecutive failure counts. ,
Required: False ,
}
integer ,
namingContext:
{
Description: The naming context. ,
Required: False ,
}
string ,
status:
{
Description: The health status for the domain controller ,
Required: False ,
}
integer ,
lastAttemptedSync:
{
Description: The last time a sync was attempted on the domain controller. ,
Format: date-time ,
Required: False ,
}
string ,
lastSuccessfulSync:
{
Description: The last time when a successful sync happened. ,
Format: date-time ,
Required: False ,
}
string ,
lastErrorCode:
{
Description: The last error code. ,
Required: False ,
}
integer ,
lastErrorMessage:
{
Description: The error message of the last error. ,
Required: False ,
}
string ,
errorTitle:
{
Description: The error title. ,
Required: False ,
}
string ,
errorDescription:
{
Description: The error description. ,
Required: False ,
}
string ,
fixLink:
{
Description: The link for the fix of the error. ,
Required: False ,
}
string ,
fixDetails:
{
Description: The details of the fix. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The additional details. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
addsServicesServiceMembers_list (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
dimensionType:
{
Description: The server specific dimension. ,
Required: False ,
}
string ,
dimensionSignature:
{
Description: The value of the dimension. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServicesServiceMembers_add (removed)
Description :  Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service under which the server is to be onboarded. ,
Required: True ,
}
string ,
serviceMember:
{
Description: The server object. ,
Required: True ,
}
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
addsServiceMembers_get (removed)
Description :  Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
addsServiceMembers_delete (removed)
Description :  Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
confirm:
{
Description: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
addsServices_listServerAlerts (removed)
Description :  Gets the details of an alert for a given Active Directory Domain Controller service and server combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts
{
serviceMemberId:
{
Description: The server Id for which the alert details needs to be queried. ,
Format: uuid ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
addsServiceMembers_listCredentials (removed)
Description :  Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The property filter to apply. ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
identifier:
{
Description: The credential identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of credential. ,
Required: False ,
}
string ,
credentialData:
{
Description: The credential data. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
addsServices_listPremiumServices (removed)
Description :  Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
operations_list (removed)
Description :  Lists the available Azure Data Factory API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/operations
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of operations supported by the Microsoft.ADHybridHealthService resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display details for the operation. ,
Required: False ,
}
object ,
}
,
]
,
totalCount:
{
Description: The total count of operations. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token to get next set of operations. ,
Required: False ,
}
string ,
}
configuration_add (removed)
Description :  Onboards a tenant in Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/configuration
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
configuration_get (removed)
Description :  Gets the details of a tenant onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/configuration
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
configuration_update (removed)
Description :  Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/configuration
{
tenant:
{
Description: The tenant object with the properties set to the updated value. ,
Required: True ,
}
{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The Id of the tenant. ,
Required: False ,
}
string ,
aadLicense:
{
Description: The Azure Active Directory license of the tenant. ,
Required: False ,
}
string ,
aadPremium:
{
Description: Indicate if the tenant has Azure Active Directory Premium license or not. ,
Required: False ,
}
boolean ,
agentAutoUpdate:
{
Description: Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features. ,
Required: False ,
}
boolean ,
alertSuppressionTimeInMins:
{
Description: The time in minutes after which an alert will be auto-suppressed. ,
Required: False ,
}
integer ,
consentedToMicrosoftDevOps:
{
Description: Indicates if the tenant data can be seen by Microsoft through Azure portal. ,
Required: False ,
}
boolean ,
countryLetterCode:
{
Description: The country letter code of the tenant. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
devOpsTtl:
{
Description: The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal. ,
Format: date-time ,
Required: False ,
}
string ,
disabled:
{
Description: Indicates if the tenant is disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason due to which the tenant was disabled in Azure Active Directory Connect Health. ,
Required: False ,
}
integer ,
globalAdminsEmail:
{
Description: The list of global administrators for the tenant. ,
Required: False ,
}
[
string ,
]
,
initialDomain:
{
Description: The initial domain of the tenant. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
lastVerified:
{
Description: The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified. ,
Format: date-time ,
Required: False ,
}
string ,
onboardingAllowed:
{
Description: Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
onboarded:
{
Description: Indicates if the tenant is already onboarded to Azure Active Directory Connect Health. ,
Required: False ,
}
boolean ,
pksCertificate:
{
Description: The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
privatePreviewTenant:
{
Description: Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features. ,
Required: False ,
}
boolean ,
tenantInQuarantine:
{
Description: Indicates if data collection for this tenant is disabled or not. ,
Required: False ,
}
boolean ,
tenantName:
{
Description: The name of the tenant. ,
Required: False ,
}
string ,
}
reports_getDevOps (removed)
Description :  Checks if the user is enabled for Dev Ops access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
boolean ,
}
services_list (removed)
Description :  Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_add (removed)
Description :  Onboards a service for a given tenant in Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
services_listPremium (removed)
Description :  Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/premiumCheck
{
$filter:
{
Description: The service property filter to apply. ,
Required: False ,
}
string ,
serviceType:
{
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 ,
}
string ,
skipCount:
{
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 ,
}
integer ,
takeCount:
{
Description: The take count , which specifies the number of elements that can be returned from a sequence. ,
Required: False ,
}
integer ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_get (removed)
Description :  Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
services_delete (removed)
Description :  Deletes a service which is onboarded to Azure Active Directory Connect Health.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
confirm:
{
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 ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
services_update (removed)
Description :  Updates the service properties of an onboarded service.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}
{
serviceName:
{
Description: The name of the service which needs to be deleted. ,
Required: True ,
}
string ,
service:
{
Description: The service object. ,
Required: True ,
}
{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the service. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The count of alerts that are currently active for the service. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information related to the service. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
customNotificationEmails:
{
Description: The list of additional emails that are configured to receive notifications about the service. ,
Required: False ,
}
[
string ,
]
,
disabled:
{
Description: Indicates if the service is disabled or not. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the service. ,
Required: False ,
}
string ,
health:
{
Description: The health of the service. ,
Required: False ,
}
string ,
lastDisabled:
{
Description: The date and time, in UTC, when the service was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date or time , in UTC, when the service properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
notificationEmailEnabled:
{
Description: Indicates if email notification is enabled or not. ,
Required: False ,
}
boolean ,
notificationEmailEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmailsEnabledForGlobalAdmins:
{
Description: Indicates if email notification is enabled for global administrators of the tenant. ,
Required: False ,
}
boolean ,
notificationEmails:
{
Description: The list of emails to whom service notifications will be sent. ,
Required: False ,
}
[
string ,
]
,
originalDisabledState:
{
Description: Gets the original disable state. ,
Required: False ,
}
boolean ,
resolvedAlerts:
{
Description: The total count of alerts that has been resolved for the service. ,
Required: False ,
}
integer ,
serviceId:
{
Description: The id of the service. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: False ,
}
string ,
signature:
{
Description: The signature of the service. ,
Required: False ,
}
string ,
simpleProperties:
{
Description: List of service specific configuration properties. ,
Required: False ,
}
object ,
tenantId:
{
Description: The id of the tenant to which the service is registered to. ,
Required: False ,
}
string ,
type:
{
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 ,
}
string ,
}
services_listAlerts (removed)
Description :  Gets the alerts for a given service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_getFeatureAvailibility (removed)
Description :  Checks if the service has all the pre-requisites met to use a feature.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
boolean ,
}
services_listExportErrors (removed)
Description :  Gets the count of latest AAD export errors.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
errorBucket:
{
Description: The error bucket. ,
Required: False ,
}
string ,
count:
{
Description: The error count. ,
Required: False ,
}
integer ,
truncated:
{
Description: Indicates if the error count is truncated or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
services_listExportErrorsV2 (removed)
Description :  Gets the categorized export errors.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
errorBucket:
{
Description: The error category to query for. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: The error Id. ,
Required: False ,
}
string ,
incomingObjectDisplayName:
{
Description: The incoming object display name. ,
Required: False ,
}
string ,
incomingObjectType:
{
Description: The incoming object type. ,
Required: False ,
}
string ,
userPrincipalName:
{
Description: The user principal name ,
Required: False ,
}
string ,
type:
{
Description: The type of the error. ,
Required: False ,
}
string ,
attributeName:
{
Description: The attribute name. ,
Required: False ,
}
string ,
attributeValue:
{
Description: The attribute value. ,
Required: False ,
}
string ,
timeOccurred:
{
Description: The date and time when the error occurred. ,
Format: date-time ,
Required: False ,
}
string ,
timeFirstOccurred:
{
Description: The time when the error first occurred. ,
Format: date-time ,
Required: False ,
}
string ,
csObjectId:
{
Description: the cs object Id. ,
Required: False ,
}
string ,
dn:
{
Description: the DN of the object. ,
Required: False ,
}
string ,
incomingObject:
{
Description: The incoming object details. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the object. ,
Required: False ,
}
string ,
distinguishedName:
{
Description: The distinguished name of the object. ,
Required: False ,
}
string ,
lastDirSyncTime:
{
Description: The last dirSync time. ,
Format: date-time ,
Required: False ,
}
string ,
mail:
{
Description: The email of the object. ,
Required: False ,
}
string ,
objectGuid:
{
Description: The object guid. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type. ,
Required: False ,
}
string ,
onpremisesUserPrincipalName:
{
Description: The On-premises UPN. ,
Required: False ,
}
string ,
proxyAddresses:
{
Description: The proxy addresses. ,
Required: False ,
}
string ,
sourceAnchor:
{
Description: The source anchor. ,
Required: False ,
}
string ,
sourceOfAuthority:
{
Description: The source of authority. ,
Required: False ,
}
string ,
timeOccurred:
{
Description: The time of the error. ,
Format: date-time ,
Required: False ,
}
string ,
userPrincipalName:
{
Description: The UPN. ,
Required: False ,
}
string ,
}
,
existingObject:
{
Description: The existing object ,
Required: False ,
}
{
displayName:
{
Description: The display name of the object. ,
Required: False ,
}
string ,
distinguishedName:
{
Description: The distinguished name of the object. ,
Required: False ,
}
string ,
lastDirSyncTime:
{
Description: The last dirSync time. ,
Format: date-time ,
Required: False ,
}
string ,
mail:
{
Description: The email of the object. ,
Required: False ,
}
string ,
objectGuid:
{
Description: The object guid. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type. ,
Required: False ,
}
string ,
onpremisesUserPrincipalName:
{
Description: The On-premises UPN. ,
Required: False ,
}
string ,
proxyAddresses:
{
Description: The proxy addresses. ,
Required: False ,
}
string ,
sourceAnchor:
{
Description: The source anchor. ,
Required: False ,
}
string ,
sourceOfAuthority:
{
Description: The source of authority. ,
Required: False ,
}
string ,
timeOccurred:
{
Description: The time of the error. ,
Format: date-time ,
Required: False ,
}
string ,
userPrincipalName:
{
Description: The UPN. ,
Required: False ,
}
string ,
}
,
modifiedOrRemovedAttributeValue:
{
Description: The modified or removed attribute value. ,
Required: False ,
}
string ,
runStepResultId:
{
Description: The run step result Id. ,
Format: uuid ,
Required: False ,
}
string ,
samAccountName:
{
Description: The sam account name. ,
Required: False ,
}
string ,
serverErrorDetail:
{
Description: The server error details. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
mergedEntityId:
{
Description: The merged entity Id. ,
Format: uuid ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time, in UTC, when the error was created. ,
Format: date-time ,
Required: False ,
}
string ,
exportErrorStatus:
{
Description: The export error status. ,
Required: False ,
}
integer ,
}
,
]
,
}
services_listExportStatus (removed)
Description :  Gets the export status.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceId:
{
Description: The id of the service for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
endTime:
{
Description: The date and time when the export ended. ,
Format: date-time ,
Required: False ,
}
string ,
runStepResultId:
{
Description: The run step result Id. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_addAlertFeedback (removed)
Description :  Adds an alert feedback submitted by customer.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
alertFeedback:
{
Description: The alert feedback. ,
Required: True ,
}
{
level:
{
Description: The alert level which indicates the severity of the alert. ,
Required: False ,
}
string ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Required: False ,
}
string ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
feedback:
{
Description: The feedback for the alert which indicates if the customer likes or dislikes the alert. ,
Required: False ,
}
string ,
comment:
{
Description: Additional comments related to the alert. ,
Required: False ,
}
string ,
consentedToShare:
{
Description: Indicates if the alert feedback can be shared from product team. ,
Required: False ,
}
boolean ,
serviceMemberId:
{
Description: The server Id of the alert. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
level:
{
Description: The alert level which indicates the severity of the alert. ,
Required: False ,
}
string ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Required: False ,
}
string ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
feedback:
{
Description: The feedback for the alert which indicates if the customer likes or dislikes the alert. ,
Required: False ,
}
string ,
comment:
{
Description: Additional comments related to the alert. ,
Required: False ,
}
string ,
consentedToShare:
{
Description: Indicates if the alert feedback can be shared from product team. ,
Required: False ,
}
boolean ,
serviceMemberId:
{
Description: The server Id of the alert. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
services_listAlertFeedback (removed)
Description :  Gets a list of all alert feedback for a given tenant and alert type.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
shortName:
{
Description: The name of the alert. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
level:
{
Description: The alert level which indicates the severity of the alert. ,
Required: False ,
}
string ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Required: False ,
}
string ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
feedback:
{
Description: The feedback for the alert which indicates if the customer likes or dislikes the alert. ,
Required: False ,
}
string ,
comment:
{
Description: Additional comments related to the alert. ,
Required: False ,
}
string ,
consentedToShare:
{
Description: Indicates if the alert feedback can be shared from product team. ,
Required: False ,
}
boolean ,
serviceMemberId:
{
Description: The server Id of the alert. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
service_getMetrics (removed)
Description :  Gets the server related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
services_listMetricsAverage (removed)
Description :  Gets the average of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_listMetricsSum (removed)
Description :  Gets the sum of the metric values for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of metrics. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_listMetricMetadata (removed)
Description :  Gets the service related metrics information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata
{
$filter:
{
Description: The metric metadata property filter to apply. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
perfCounter:
{
Description: Indicates if only performance counter metrics are requested. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
services_getMetricMetadata (removed)
Description :  Gets the service related metrics information.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metricsProcessorClassName:
{
Description: The name of the class which retrieve and process the metric. ,
Required: False ,
}
string ,
metricName:
{
Description: The metric name ,
Required: False ,
}
string ,
groupings:
{
Description: The groupings for the metrics. ,
Required: False ,
}
[
{
key:
{
Description: The key for the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the group. ,
Required: False ,
}
string ,
invisibleForUi:
{
Description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI. ,
Required: False ,
}
boolean ,
}
,
]
,
displayName:
{
Description: The display name for the metric. ,
Required: False ,
}
string ,
valueKind:
{
Description: Indicates if the metrics is a rate,value, percent or duration type. ,
Required: False ,
}
string ,
minValue:
{
Description: The minimum value. ,
Required: False ,
}
integer ,
maxValue:
{
Description: The maximum value. ,
Required: False ,
}
integer ,
kind:
{
Description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart. ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates if the metric is a default metric or not. ,
Required: False ,
}
boolean ,
isPerfCounter:
{
Description: Indicates if the metric is a performance counter metric or not. ,
Required: False ,
}
boolean ,
isDevOps:
{
Description: Indicates if the metric is visible to DevOps or not. ,
Required: False ,
}
boolean ,
}
services_getMetricMetadataForGroup (removed)
Description :  Gets the service related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
services_updateMonitoringConfiguration (removed)
Description :  Updates the service level monitoring configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
configurationSetting:
{
Description: The monitoring configuration to update ,
Required: True ,
}
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
services_listMonitoringConfigurations (removed)
Description :  Gets the service level monitoring configurations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
}
services_listUserBadPasswordReport (removed)
Description :  Gets the bad password login attempt report for an user
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
dataSource:
{
Description: The source of data, if its test data or customer data. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
userId:
{
Description: The user ID value. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address corresponding to the last error event. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time when the last error event was logged. ,
Format: date-time ,
Required: False ,
}
string ,
uniqueIpAddresses:
{
Description: The list of unique IP addresses. ,
Required: False ,
}
string ,
totalErrorAttempts:
{
Description: The total count of specific error events. ,
Required: False ,
}
integer ,
}
,
]
,
}
serviceMembers_list (removed)
Description :  Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The server property filter to apply. ,
Required: False ,
}
string ,
dimensionType:
{
Description: The server specific dimension. ,
Required: False ,
}
string ,
dimensionSignature:
{
Description: The value of the dimension. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
serviceMembers_add (removed)
Description :  Onboards a server, for a given service, to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers
{
serviceName:
{
Description: The name of the service under which the server is to be onboarded. ,
Required: True ,
}
string ,
serviceMember:
{
Description: The server object. ,
Required: True ,
}
{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
serviceMembers_get (removed)
Description :  Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceMemberId:
{
Description: The id of the server. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id to whom this server belongs. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id to whom this server belongs. ,
Required: False ,
}
string ,
activeAlerts:
{
Description: The total number of alerts that are currently active for the server. ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: The additional information, if any, for the server. ,
Required: False ,
}
string ,
createdDate:
{
Description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: The server specific configuration related dimensions. ,
Required: False ,
}
object ,
disabled:
{
Description: Indicates if the server is disabled or not. ,
Required: False ,
}
boolean ,
disabledReason:
{
Description: The reason for disabling the server. ,
Required: False ,
}
integer ,
installedQfes:
{
Description: The list of installed QFEs for the server. ,
Required: False ,
}
object ,
lastDisabled:
{
Description: The date and time , in UTC, when the server was last disabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastReboot:
{
Description: The date and time, in UTC, when the server was last rebooted. ,
Format: date-time ,
Required: False ,
}
string ,
lastServerReportedMonitoringLevelChange:
{
Description: The date and time, in UTC, when the server's data monitoring configuration was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the server properties were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
machineId:
{
Description: The id of the machine. ,
Required: False ,
}
string ,
machineName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
monitoringConfigurationsComputed:
{
Description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
monitoringConfigurationsCustomized:
{
Description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health. ,
Required: False ,
}
object ,
osName:
{
Description: The name of the operating system installed in the machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the operating system installed in the machine. ,
Required: False ,
}
string ,
properties:
{
Description: Server specific properties. ,
Required: False ,
}
object ,
recommendedQfes:
{
Description: The list of recommended hotfixes for the server. ,
Required: False ,
}
object ,
resolvedAlerts:
{
Description: The total count of alerts that are resolved for this server. ,
Required: False ,
}
integer ,
role:
{
Description: The service role that is being monitored in the server. ,
Required: False ,
}
string ,
serverReportedMonitoringLevel:
{
Description: The monitoring level reported by the server. ,
Enum:
{
Partial: No description available. ,
Full: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The health status of the server. ,
Required: False ,
}
string ,
}
serviceMembers_delete (removed)
Description :  Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
confirm:
{
Description: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
serviceMembers_listAlerts (removed)
Description :  Gets the details of an alert for a given service and server combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts
{
serviceMemberId:
{
Description: The server Id for which the alert details needs to be queried. ,
Format: uuid ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The alert property filter to apply. ,
Required: False ,
}
string ,
state:
{
Description: The alert state to query for. ,
Required: False ,
}
string ,
from:
{
Description: The start date to query for. ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: The end date till when to query for. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
alertId:
{
Description: The alert Id. ,
Format: uuid ,
Required: False ,
}
string ,
level:
{
Description: The alert level which indicates the severity of the alert. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
PreWarning: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The alert state which can be either active or resolved with multiple resolution types. ,
Enum:
{
Active: No description available. ,
ResolvedByPositiveResult: No description available. ,
ResolvedManually: No description available. ,
ResolvedByTimer: No description available. ,
ResolvedByStateChange: No description available. ,
}
,
Required: False ,
}
enum ,
shortName:
{
Description: The alert short name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the alert. ,
Required: False ,
}
string ,
description:
{
Description: The alert description. ,
Required: False ,
}
string ,
remediation:
{
Description: The alert remediation. ,
Required: False ,
}
string ,
relatedLinks:
{
Description: The help links to get more information related to the alert. ,
Required: False ,
}
[
{
title:
{
Description: The title for the link. ,
Required: False ,
}
string ,
url:
{
Description: The url for the help document. ,
Required: False ,
}
string ,
}
,
]
,
scope:
{
Description: The scope of the alert. Indicates if it is a service or a server related alert. ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information related to the alert. ,
Required: False ,
}
[
{
titleName:
{
Description: The title name for the property. ,
Required: False ,
}
string ,
titleValue:
{
Description: The title value for the property. ,
Required: False ,
}
string ,
properties:
{
Description: The list of properties which are included in the additional information. ,
Required: False ,
}
object ,
hasProperties:
{
Description: Indicates if properties are present or not. ,
Required: False ,
}
boolean ,
}
,
]
,
createdDate:
{
Description: The date and time,in UTC,when the alert was created. ,
Format: date-time ,
Required: False ,
}
string ,
resolvedDate:
{
Description: The date and time, in UTC, when the alert was resolved. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The date and time, in UTC, when the alert was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
monitorRoleType:
{
Description: The monitoring role type for which the alert was raised. ,
Required: False ,
}
string ,
activeAlertProperties:
{
Description: The active alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
resolvedAlertProperties:
{
Description: The resolved alert properties. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
tenantId:
{
Description: The tenant Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceId:
{
Description: The service Id. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
totalCount:
{
Description: The total count of alert elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
serviceMembers_listConnectors (removed)
Description :  Gets the connector details for a service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
connectorId:
{
Description: The connector Id. ,
Required: False ,
}
string ,
id:
{
Description: The connector Id. ,
Required: False ,
}
string ,
name:
{
Description: The connector name. ,
Required: False ,
}
string ,
version:
{
Description: The connector version ,
Required: False ,
}
integer ,
type:
{
Description: The connector type. ,
Required: False ,
}
string ,
description:
{
Description: The connector description. ,
Required: False ,
}
string ,
schemaXml:
{
Description: The schema xml for the connector. ,
Required: False ,
}
string ,
passwordManagementSettings:
{
Description: The password management settings of the connector. ,
Required: False ,
}
object ,
passwordHashSyncConfiguration:
{
Description: The password hash synchronization configuration of the connector. ,
Required: False ,
}
object ,
timeCreated:
{
Description: The date and time when this connector was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeLastModified:
{
Description: The date and time when this connector was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
partitions:
{
Description: The partitions of the connector. ,
Required: False ,
}
[
{
id:
{
Description: The partition Id. ,
Required: False ,
}
string ,
dn:
{
Description: The distinguished name for the partition. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the partition object is selected or not. ,
Required: False ,
}
boolean ,
timeCreated:
{
Description: The date and time when the partition is created. ,
Format: date-time ,
Required: False ,
}
string ,
timeLastModified:
{
Description: The time and date when the partition was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
partitionScope:
{
Description: The scope of the partition. ,
Required: False ,
}
{
isDefault:
{
Description: Indicates if the partition scope is default or not. ,
Required: False ,
}
boolean ,
objectClasses:
{
Description: The in-scope object classes. ,
Required: False ,
}
[
string ,
]
,
containersIncluded:
{
Description: The list of containers included. ,
Required: False ,
}
[
string ,
]
,
containersExcluded:
{
Description: The list of containers excluded. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the partition. ,
Required: False ,
}
string ,
isDomain:
{
Description: Indicates if the partition is a domain or not. ,
Required: False ,
}
boolean ,
type:
{
Description: The partition type. ,
Required: False ,
}
string ,
}
,
]
,
runProfiles:
{
Description: The run profiles of the connector. ,
Required: False ,
}
[
{
id:
{
Description: The run profile Id. ,
Required: False ,
}
string ,
name:
{
Description: The run profile name ,
Required: False ,
}
string ,
runSteps:
{
Description: The run steps of the run profile. ,
Required: False ,
}
[
{
batchSize:
{
Description: The batch size used by the run step. ,
Required: False ,
}
integer ,
objectProcessLimit:
{
Description: The object processing limit. ,
Required: False ,
}
integer ,
objectDeleteLimit:
{
Description: The object deletion limit. ,
Required: False ,
}
integer ,
pageSize:
{
Description: The page size of the run step. ,
Required: False ,
}
integer ,
partitionId:
{
Description: The Id of the partition that a current run step operation is executing. ,
Required: False ,
}
string ,
operationType:
{
Description: The run step operation types. ,
Required: False ,
}
integer ,
timeout:
{
Description: The operation timeout. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classesIncluded:
{
Description: The class inclusion list of the connector. ,
Required: False ,
}
[
string ,
]
,
attributesIncluded:
{
Description: The attribute inclusion list of the connector. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
serviceMembers_listCredentials (removed)
Description :  Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
$filter:
{
Description: The property filter to apply. ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
identifier:
{
Description: The credential identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of credential. ,
Required: False ,
}
string ,
credentialData:
{
Description: The credential data. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
serviceMembers_deleteData (removed)
Description :  Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
serviceMembers_listDataFreshness (removed)
Description :  Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
}
serviceMembers_listExportStatus (removed)
Description :  Gets the export status.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
serviceId:
{
Description: The id of the service for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
serviceMemberId:
{
Description: The server Id for whom the export status is being reported. ,
Format: uuid ,
Required: False ,
}
string ,
endTime:
{
Description: The date and time when the export ended. ,
Format: date-time ,
Required: False ,
}
string ,
runStepResultId:
{
Description: The run step result Id. ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count of service elements. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
serviceMembers_listGlobalConfiguration (removed)
Description :  Gets the global configuration.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
version:
{
Description: The version for the global configuration. ,
Required: False ,
}
integer ,
schemaXml:
{
Description: The schema for the configuration. ,
Required: False ,
}
string ,
passwordSyncEnabled:
{
Description: Indicates if password sync is enabled or not. ,
Required: False ,
}
boolean ,
numSavedPwdEvent:
{
Description: The number of saved password events. ,
Required: False ,
}
integer ,
featureSet:
{
Description: The list of additional feature sets. ,
Required: False ,
}
[
{
key:
{
Description: The key for the property. ,
Required: False ,
}
string ,
value:
{
Description: The value for the key. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
serviceMembers_getMetrics (removed)
Description :  Gets the server related metrics for a given metric and group combination.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
metricName:
{
Description: The metric name ,
Required: True ,
}
string ,
groupName:
{
Description: The group name ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server id. ,
Format: uuid ,
Required: True ,
}
string ,
groupKey:
{
Description: The group key ,
Required: False ,
}
string ,
fromDate:
{
Description: The start date. ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: The end date. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sets:
{
Description: The list of metric set. ,
Required: False ,
}
[
{
setName:
{
Description: The name of the set. ,
Required: False ,
}
string ,
values:
{
Description: The list of the metric values. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
timeStamps:
{
Description: The list of timestamps for each metric in the metric set. ,
Required: False ,
}
[
string ,
]
,
}
serviceMembers_getServiceConfiguration (removed)
Description :  Gets the service configuration.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The server Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
version:
{
Description: The version of the sync service. ,
Required: False ,
}
string ,
serviceType:
{
Description: The service type of the server. ,
Required: False ,
}
integer ,
serviceAccount:
{
Description: The service account. ,
Required: False ,
}
string ,
sqlServer:
{
Description: The SQL server information. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
sqlEdition:
{
Description: The SQL edition ,
Required: False ,
}
string ,
sqlInstance:
{
Description: The SQL instance details. ,
Required: False ,
}
string ,
sqlDatabaseName:
{
Description: The SQL database. ,
Required: False ,
}
string ,
sqlDatabaseSize:
{
Description: The SQL database size. ,
Required: False ,
}
integer ,
}
services_getTenantWhitelisting (removed)
Description :  Checks if the tenant, to which a service is registered, is listed as allowed to use a feature.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
boolean ,
}
services_listAllRiskyIpDownloadReport (removed)
Description :  Gets all Risky IP report URIs for the last 7 days.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of blob uris. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id for whom the report belongs to. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id for whom the report belongs to. ,
Required: False ,
}
string ,
resultSasUri:
{
Description: The blob uri for the report. ,
Required: False ,
}
string ,
blobCreateDateTime:
{
Description: Time at which the new Risky IP report was requested. ,
Format: date-time ,
Required: False ,
}
string ,
jobCompletionTime:
{
Description: Time at which the blob creation job for the new Risky IP report was completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the Risky IP report generation. ,
Required: False ,
}
string ,
}
,
]
,
}
services_listCurrentRiskyIpDownloadReport (removed)
Description :  Initiate the generation of a new Risky IP report. Returns the URI for the new one.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of blob uris. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id for whom the report belongs to. ,
Required: False ,
}
string ,
serviceId:
{
Description: The service id for whom the report belongs to. ,
Required: False ,
}
string ,
resultSasUri:
{
Description: The blob uri for the report. ,
Required: False ,
}
string ,
blobCreateDateTime:
{
Description: Time at which the new Risky IP report was requested. ,
Format: date-time ,
Required: False ,
}
string ,
jobCompletionTime:
{
Description: Time at which the blob creation job for the new Risky IP report was completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the Risky IP report generation. ,
Required: False ,
}
string ,
}
,
]
,
}
serviceMembers_getConnectorMetadata (removed)
Description :  Gets the list of connectors and run profile names.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
serviceMemberId:
{
Description: The service member id. ,
Format: uuid ,
Required: True ,
}
string ,
metricName:
{
Description: The name of the metric. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
connectors:
{
Description: The list of connectors. ,
Required: False ,
}
[
{
connectorId:
{
Description: The Connector Id. ,
Required: False ,
}
string ,
connectorDisplayName:
{
Description: The Connector Display Name ,
Required: False ,
}
string ,
}
,
]
,
runProfileNames:
{
Description: The list of run profile names. ,
Required: False ,
}
[
string ,
]
,
}
list_IPAddressAggregatesByService (removed)
Description :  Gets the IP address aggregates for a given service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregates
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
skiptoken:
{
Description: A continuationtoken value returned in paginated result to load different pages. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value returned by the operation. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID ,
Required: False ,
}
string ,
serviceId:
{
Description: The service ID ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address from where the attempted login originated from. ,
Required: False ,
}
string ,
timestamp:
{
Description: When the event occurred ,
Required: False ,
}
string ,
firstAuditTimestamp:
{
Description: The first audit timestamp ,
Required: False ,
}
string ,
lastAuditTimestamp:
{
Description: The last audit timestamp ,
Required: False ,
}
string ,
extranetLockoutErrorCount:
{
Description: The extranet lockout error count ,
Required: False ,
}
integer ,
badPasswordErrorCount:
{
Description: The bad password error count ,
Required: False ,
}
integer ,
uniqueUsernamesAttemptedCount:
{
Description: The unique usernames attempted ,
Required: False ,
}
integer ,
attemptCountThresholdIsExceeded:
{
Description: A value indicating whether the attempt count threshold been exceeded ,
Required: False ,
}
boolean ,
timeSpan:
{
Description: The duration of the event ,
Required: False ,
}
string ,
isWhitelistedIpAddress:
{
Description: A value indicating whether the IP address has been listed as allowed. ,
Required: False ,
}
boolean ,
networkLocation:
{
Description: The network location ,
Required: False ,
}
string ,
attemptCountThresholdOnTrigger:
{
Description: The attempted count threshold on trigger. ,
Required: False ,
}
integer ,
attemptThresholdTypeOnTrigger:
{
Description: The attempted threshold type on trigger. ,
Required: False ,
}
string ,
geographicLocation:
{
Description: The geographic location. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of IP Aggregate list results if there are any. ,
Required: False ,
}
string ,
totalCount:
{
Description: The number of results. ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The continuation token for paginated calls. ,
Required: False ,
}
string ,
}
list_IPAddressAggregateSettings (removed)
Description :  Gets the IP address aggregate settings.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
badPasswordAndExtranetLockoutCombinedDailyThreshold:
{
Description: This threshold setting defines the per day trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
badPasswordAndExtranetLockoutCombinedHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutDailyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
emailNotificationEnabled:
{
Description: A value indicating whether email notification has been enabled. ,
Required: False ,
}
boolean ,
}
update_IPAddressAggregateSettings (removed)
Description :  Updates the IP address aggregate settings alert thresholds.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings
{
serviceName:
{
Description: The name of the service. ,
Required: True ,
}
string ,
IPAddressAggregateSetting:
{
Description: The IP address aggregate setting object. ,
Required: True ,
}
{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
badPasswordAndExtranetLockoutCombinedDailyThreshold:
{
Description: This threshold setting defines the per day trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
badPasswordAndExtranetLockoutCombinedHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutDailyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
emailNotificationEnabled:
{
Description: A value indicating whether email notification has been enabled. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID for the entree ,
Required: False ,
}
string ,
badPasswordAndExtranetLockoutCombinedDailyThreshold:
{
Description: This threshold setting defines the per day trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
badPasswordAndExtranetLockoutCombinedHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutDailyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
extranetLockoutHourlyThreshold:
{
Description: This threshold setting defines the per hour trigger for a new event to be generated in the report. ,
Required: False ,
}
integer ,
emailNotificationEnabled:
{
Description: A value indicating whether email notification has been enabled. ,
Required: False ,
}
boolean ,
}