Sign in

v14

latestSwagger 2.0raw.githubusercontent.com2022-12-097793207.8 KB
Services

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

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

Path parameters

serviceNamestring required

The name of the service.

Query parameters

api-versionstring required

The version of the API to be used with the client request.

Response

The list of services.

idstring

The id of the service.

activeAlertsinteger

The count of alerts that are currently active for the service.

additionalInformationstring

The additional information related to the service.

createdDatestring date-time

The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.

customNotificationEmailsstring[]

The list of additional emails that are configured to receive notifications about the service.

disabledboolean

Indicates if the service is disabled or not.

displayNamestring

The display name of the service.

healthstring

The health of the service.

lastDisabledstring date-time

The date and time, in UTC, when the service was last disabled.

lastUpdatedstring date-time

The date or time , in UTC, when the service properties were last updated.

monitoringConfigurationsComputedobject

The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.

monitoringConfigurationsCustomizedobject

The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.

notificationEmailEnabledboolean

Indicates if email notification is enabled or not.

notificationEmailEnabledForGlobalAdminsboolean

Indicates if email notification is enabled for global administrators of the tenant.

notificationEmailsEnabledForGlobalAdminsboolean

Indicates if email notification is enabled for global administrators of the tenant.

notificationEmailsstring[]

The list of emails to whom service notifications will be sent.

originalDisabledStateboolean

Gets the original disable state.

resolvedAlertsinteger

The total count of alerts that has been resolved for the service.

serviceIdstring

The id of the service.

serviceNamestring

The name of the service.

signaturestring

The signature of the service.

simplePropertiesobject

List of service specific configuration properties.

tenantIdstring

The id of the tenant to which the service is registered to.

typestring

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.