services

Creates, updates, deletes, gets or lists a services resource.

Overview

Name	services
Type	Resource
Id	azure.ad_hybrid_health_service.services

Fields

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	serviceName	Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.
list	SELECT		Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.
delete	DELETE	serviceName	Deletes a service which is onboarded to Azure Active Directory Connect Health.
update	UPDATE	serviceName	Updates the service properties of an onboarded service.
add	EXEC		Onboards a service for a given tenant in Azure Active Directory Connect Health.
add_alert_feedback	EXEC	serviceName	Adds an alert feedback submitted by customer.
update_monitoring_configuration	EXEC	serviceName	Updates the service level monitoring configuration.

SELECT examples

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

SELECT
id,
activeAlerts,
additionalInformation,
createdDate,
customNotificationEmails,
disabled,
displayName,
health,
lastDisabled,
lastUpdated,
monitoringConfigurationsComputed,
monitoringConfigurationsCustomized,
notificationEmailEnabled,
notificationEmailEnabledForGlobalAdmins,
notificationEmails,
notificationEmailsEnabledForGlobalAdmins,
originalDisabledState,
resolvedAlerts,
serviceId,
serviceName,
signature,
simpleProperties,
tenantId,
type
FROM azure.ad_hybrid_health_service.services
;

UPDATE example

Updates a services resource.

/*+ update */
UPDATE azure.ad_hybrid_health_service.services
SET 
id = '{{ id }}',
activeAlerts = '{{ activeAlerts }}',
additionalInformation = '{{ additionalInformation }}',
createdDate = '{{ createdDate }}',
customNotificationEmails = '{{ customNotificationEmails }}',
disabled = true|false,
displayName = '{{ displayName }}',
health = '{{ health }}',
lastDisabled = '{{ lastDisabled }}',
lastUpdated = '{{ lastUpdated }}',
monitoringConfigurationsComputed = '{{ monitoringConfigurationsComputed }}',
monitoringConfigurationsCustomized = '{{ monitoringConfigurationsCustomized }}',
notificationEmailEnabled = true|false,
notificationEmailEnabledForGlobalAdmins = true|false,
notificationEmailsEnabledForGlobalAdmins = true|false,
notificationEmails = '{{ notificationEmails }}',
originalDisabledState = true|false,
resolvedAlerts = '{{ resolvedAlerts }}',
serviceId = '{{ serviceId }}',
serviceName = '{{ serviceName }}',
signature = '{{ signature }}',
simpleProperties = '{{ simpleProperties }}',
tenantId = '{{ tenantId }}',
type = '{{ type }}'
WHERE 
serviceName = '{{ serviceName }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM azure.ad_hybrid_health_service.services
WHERE serviceName = '{{ serviceName }}';