Skip to main content

services

Overview

Nameservices
TypeResource
Idazure.ad_hybrid_health_service.services

Fields

NameDatatypeDescription
idstringThe id of the service.
activeAlertsintegerThe count of alerts that are currently active for the service.
additionalInformationstringThe additional information related to the service.
createdDatestringThe date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.
customNotificationEmailsarrayThe list of additional emails that are configured to receive notifications about the service.
disabledbooleanIndicates if the service is disabled or not.
displayNamestringThe display name of the service.
healthstringThe health of the service.
lastDisabledstringThe date and time, in UTC, when the service was last disabled.
lastUpdatedstringThe date or time , in UTC, when the service properties were last updated.
monitoringConfigurationsComputedobjectThe monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.
monitoringConfigurationsCustomizedobjectThe customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.
notificationEmailEnabledbooleanIndicates if email notification is enabled or not.
notificationEmailEnabledForGlobalAdminsbooleanIndicates if email notification is enabled for global administrators of the tenant.
notificationEmailsarrayThe list of emails to whom service notifications will be sent.
notificationEmailsEnabledForGlobalAdminsbooleanIndicates if email notification is enabled for global administrators of the tenant.
originalDisabledStatebooleanGets the original disable state.
resolvedAlertsintegerThe total count of alerts that has been resolved for the service.
serviceIdstringThe id of the service.
serviceNamestringThe name of the service.
signaturestringThe signature of the service.
simplePropertiesobjectList of service specific configuration properties.
tenantIdstringThe id of the tenant to which the service is registered to.
typestringThe 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.

Methods

NameAccessible byRequired ParamsDescription
getSELECTserviceNameGets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
listSELECTGets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.
addINSERTOnboards a service for a given tenant in Azure Active Directory Connect Health.
deleteDELETEserviceNameDeletes a service which is onboarded to Azure Active Directory Connect Health.
_listEXECGets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.
add_alert_feedbackEXECserviceNameAdds an alert feedback submitted by customer.
updateEXECserviceNameUpdates the service properties of an onboarded service.