APIHub
Back to Explore

ADHybridHealthService

The ADHybridHealthService REST API lets you onboard, configure, and manage Azure AD Connect Health monitoring for Active Directory Domain Services, exposing operations to retrieve service configurations, server members, health metrics, alerts, replication details, and user preferences for each registered AD DS service.

Cloud
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

119ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration

Gets the service configurations.

  • serviceName (path, required) — The name of the service.
  • grouping (query) — The grouping for configurations.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}

Gets the dimensions for a given dimension type in a server.

  • serviceName (path, required) — The name of the service.
  • dimension (path, required) — The dimension type.
  • api-version (query, required) — The version of the API to be used with the client request.
PATCH

/providers/Microsoft.ADHybridHealthService/services/{serviceName}

Updates the service properties of an onboarded service.

  • serviceName (path, required) — The name of the service which needs to be deleted.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

  • $filter (query) — The service property filter to apply.
  • serviceType (query) — 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.
  • skipCount (query) — The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
  • takeCount (query) — The take count , which specifies the number of elements that can be returned from a sequence.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/addsservices

Onboards a service for a given tenant in Azure Active Directory Connect Health.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck

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.

  • $filter (query) — The service property filter to apply.
  • serviceType (query) — 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.
  • skipCount (query) — The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
  • takeCount (query) — The take count , which specifies the number of elements that can be returned from a sequence.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}

Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.

  • serviceName (path, required) — The name of the service which needs to be deleted.
  • confirm (query) — 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.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}

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.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
PATCH

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}

Updates an Active Directory Domain Service properties of an onboarded service.

  • serviceName (path, required) — The name of the service which needs to be deleted.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers

Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The server property filter to apply.
  • isGroupbySite (query, required) — Indicates if the result should be grouped by site or not.
  • query (query) — The custom query.
  • nextPartitionKey (query, required) — The next partition key to query for.
  • nextRowKey (query, required) — The next row key to query for.
  • takeCount (query) — The take count , which specifies the number of elements that can be returned from a sequence.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers

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.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The server property filter to apply.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts

Gets the alerts for a given Active Directory Domain Service.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The alert property filter to apply.
  • state (query) — The alert state to query for.
  • from (query) — The start date to query for.
  • to (query) — The end date till when to query for.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference

Deletes the user preferences for a given feature.

  • serviceName (path, required) — The name of the service.
  • featureName (path, required) — The name of the feature.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference

Gets the user preferences for a given feature.

  • serviceName (path, required) — The name of the service.
  • featureName (path, required) — The name of the feature.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference

Adds the user preferences for a given feature.

  • serviceName (path, required) — The name of the service.
  • featureName (path, required) — The name of the feature.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary

Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata

Gets the service related metrics information.

  • $filter (query) — The metric metadata property filter to apply.
  • serviceName (path, required) — The name of the service.
  • perfCounter (query) — Indicates if only performance counter metrics are requested.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}

Gets the service related metric information.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}

Gets the service related metrics for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • groupKey (query) — The group key
  • fromDate (query) — The start date.
  • toDate (query) — The end date.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}

Gets the server related metrics for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • groupKey (query) — The group key
  • fromDate (query) — The start date.
  • toDate (query) — The end date.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average

Gets the average of the metric values for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum

Gets the sum of the metric values for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}

Checks if the tenant, to which a service is registered, is whitelisted to use a feature.

  • serviceName (path, required) — The name of the service.
  • featureName (path, required) — The name of the feature.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails

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.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The server property filter to apply.
  • withDetails (query) — Indicates if InboundReplicationNeighbor details are required or not.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus

Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary

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.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The server property filter to apply.
  • isGroupbySite (query, required) — Indicates if the result should be grouped by site or not.
  • query (query, required) — The custom query.
  • nextPartitionKey (query, required) — The next partition key to query for.
  • nextRowKey (query, required) — The next row key to query for.
  • takeCount (query) — The take count , which specifies the number of elements that can be returned from a sequence.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The server property filter to apply.
  • dimensionType (query) — The server specific dimension.
  • dimensionSignature (query) — The value of the dimension.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers

Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service under which the server is to be onboarded.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}

Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • confirm (query) — 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.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}

Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

  • serviceMemberId (path, required) — The server Id for which the alert details needs to be queried.
  • serviceName (path, required) — The name of the service.
  • $filter (query) — The alert property filter to apply.
  • state (query) — The alert state to query for.
  • from (query) — The start date to query for.
  • to (query) — The end date till when to query for.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average

Gets the average of the metric values for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The property filter to apply.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/configuration

Gets the details of a tenant onboarded to Azure Active Directory Connect Health.

  • api-version (query, required) — The version of the API to be used with the client request.
PATCH

/providers/Microsoft.ADHybridHealthService/configuration

Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.

  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/configuration

Onboards a tenant in Azure Active Directory Connect Health.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/operations

Lists the available Azure Data Factory API operations.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps

Checks if the user is enabled for Dev Ops access.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors

Gets the connector details for a service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services

Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.

  • $filter (query) — The service property filter to apply.
  • serviceType (query) — 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.
  • skipCount (query) — The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
  • takeCount (query) — The take count , which specifies the number of elements that can be returned from a sequence.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/services

Onboards a service for a given tenant in Azure Active Directory Connect Health.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/premiumCheck

Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

  • $filter (query) — The service property filter to apply.
  • serviceType (query) — 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.
  • skipCount (query) — The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
  • takeCount (query) — The take count , which specifies the number of elements that can be returned from a sequence.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/providers/Microsoft.ADHybridHealthService/services/{serviceName}

Deletes a service which is onboarded to Azure Active Directory Connect Health.

  • serviceName (path, required) — The name of the service which needs to be deleted.
  • confirm (query) — 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.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}

Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts

Gets the alerts for a given service.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The alert property filter to apply.
  • state (query) — The alert state to query for.
  • from (query) — The start date to query for.
  • to (query) — The end date till when to query for.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}

Checks if the service has all the pre-requisites met to use a feature.

  • serviceName (path, required) — The name of the service.
  • featureName (path, required) — The name of the feature.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts

Gets the count of latest AAD export errors.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2

Gets the categorized export errors.

  • serviceName (path, required) — The name of the service.
  • errorBucket (query, required) — The error category to query for.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus

Gets the export status.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback

Adds an alert feedback submitted by customer.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback

Gets a list of all alert feedback for a given tenant and alert type.

  • serviceName (path, required) — The name of the service.
  • shortName (path, required) — The name of the alert.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata

Gets the service related metrics information.

  • $filter (query) — The metric metadata property filter to apply.
  • serviceName (path, required) — The name of the service.
  • perfCounter (query) — Indicates if only performance counter metrics are requested.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}

Gets the service related metrics information.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}

Gets the service related metrics for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • groupKey (query) — The group key
  • fromDate (query) — The start date.
  • toDate (query) — The end date.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}

Gets the server related metrics for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • groupKey (query) — The group key
  • fromDate (query) — The start date.
  • toDate (query) — The end date.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum

Gets the sum of the metric values for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • api-version (query, required) — The version of the API to be used with the client request.
PATCH

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration

Updates the service level monitoring configuration.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations

Gets the service level monitoring configurations.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user

Gets the bad password login attempt report for an user

  • serviceName (path, required) — The name of the service.
  • dataSource (query) — The source of data, if its test data or customer data.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris

Gets all Risky IP report URIs for the last 7 days.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri

Initiate the generation of a new Risky IP report. Returns the URI for the new one.

  • serviceName (path, required) — The name of the service.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers

Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The server property filter to apply.
  • dimensionType (query) — The server specific dimension.
  • dimensionSignature (query) — The value of the dimension.
  • api-version (query, required) — The version of the API to be used with the client request.
POST

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers

Onboards a server, for a given service, to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service under which the server is to be onboarded.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}

Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • confirm (query) — 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.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}

Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts

Gets the details of an alert for a given service and server combination.

  • serviceMemberId (path, required) — The server Id for which the alert details needs to be queried.
  • serviceName (path, required) — The name of the service.
  • $filter (query) — The alert property filter to apply.
  • state (query) — The alert state to query for.
  • from (query) — The start date to query for.
  • to (query) — The end date till when to query for.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • $filter (query) — The property filter to apply.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data

Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness

Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus

Gets the export status.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration

Gets the global configuration.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server id.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}

Gets the list of connectors and run profile names.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The service member id.
  • metricName (path, required) — The name of the metric.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}

Gets the server related metrics for a given metric and group combination.

  • serviceName (path, required) — The name of the service.
  • metricName (path, required) — The metric name
  • groupName (path, required) — The group name
  • serviceMemberId (path, required) — The server id.
  • groupKey (query) — The group key
  • fromDate (query) — The start date.
  • toDate (query) — The end date.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration

Gets the service configuration.

  • serviceName (path, required) — The name of the service.
  • serviceMemberId (path, required) — The server Id.
  • api-version (query, required) — The version of the API to be used with the client request.

74 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://management.azure.com/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration"

management.azure.com · HTTPS only