adds_services

Creates, updates, deletes, gets or lists an adds_services resource.

Overview

Name	adds_services
Type	Resource
Id	azure.ad_hybrid_health_service.adds_services

Fields

The following fields are returned by SELECT queries:

get

The Active Directory Domain Controller service as specified by the serviceName property.

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 (date-time)	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 (date-time)	The date and time, in UTC, when the service was last disabled.
lastUpdated	string (date-time)	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.

list

The list of Active Directory Domain Controller services.

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 (date-time)	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 (date-time)	The date and time, in UTC, when the service was last disabled.
lastUpdated	string (date-time)	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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	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.
list	select		$filter, serviceType, skipCount, takeCount	Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.
update	update	serviceName		Updates an Active Directory Domain Service properties of an onboarded service.
delete	delete	serviceName	confirm	Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.
add	exec			Onboards a service for a given tenant in Azure Active Directory Connect Health.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
serviceName	string	The name of the service which needs to be deleted.
$filter	string	The service property filter to apply.
confirm	boolean	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.
serviceType	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.
skipCount	integer	The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
takeCount	integer	The take count , which specifies the number of elements that can be returned from a sequence.

SELECT examples

get

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.

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.adds_services
WHERE serviceName = '{{ serviceName }}' -- required
;

list

Gets the details of Active Directory Domain Service, 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.adds_services
WHERE $filter = '{{ $filter }}'
AND serviceType = '{{ serviceType }}'
AND skipCount = '{{ skipCount }}'
AND takeCount = '{{ takeCount }}'
;

UPDATE examples

update

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

UPDATE azure.ad_hybrid_health_service.adds_services
SET 
data__id = '{{ id }}',
data__activeAlerts = {{ activeAlerts }},
data__additionalInformation = '{{ additionalInformation }}',
data__createdDate = '{{ createdDate }}',
data__customNotificationEmails = '{{ customNotificationEmails }}',
data__disabled = {{ disabled }},
data__displayName = '{{ displayName }}',
data__health = '{{ health }}',
data__lastDisabled = '{{ lastDisabled }}',
data__lastUpdated = '{{ lastUpdated }}',
data__monitoringConfigurationsComputed = '{{ monitoringConfigurationsComputed }}',
data__monitoringConfigurationsCustomized = '{{ monitoringConfigurationsCustomized }}',
data__notificationEmailEnabled = {{ notificationEmailEnabled }},
data__notificationEmailEnabledForGlobalAdmins = {{ notificationEmailEnabledForGlobalAdmins }},
data__notificationEmailsEnabledForGlobalAdmins = {{ notificationEmailsEnabledForGlobalAdmins }},
data__notificationEmails = '{{ notificationEmails }}',
data__originalDisabledState = {{ originalDisabledState }},
data__resolvedAlerts = {{ resolvedAlerts }},
data__serviceId = '{{ serviceId }}',
data__serviceName = '{{ serviceName }}',
data__signature = '{{ signature }}',
data__simpleProperties = '{{ simpleProperties }}',
data__tenantId = '{{ tenantId }}',
data__type = '{{ type }}'
WHERE 
serviceName = '{{ serviceName }}' --required
RETURNING
id,
activeAlerts,
additionalInformation,
createdDate,
customNotificationEmails,
disabled,
displayName,
health,
lastDisabled,
lastUpdated,
monitoringConfigurationsComputed,
monitoringConfigurationsCustomized,
notificationEmailEnabled,
notificationEmailEnabledForGlobalAdmins,
notificationEmails,
notificationEmailsEnabledForGlobalAdmins,
originalDisabledState,
resolvedAlerts,
serviceId,
serviceName,
signature,
simpleProperties,
tenantId,
type;

DELETE examples

delete

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

DELETE FROM azure.ad_hybrid_health_service.adds_services
WHERE serviceName = '{{ serviceName }}' --required
AND confirm = '{{ confirm }}'
;

Lifecycle Methods

add

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

EXEC azure.ad_hybrid_health_service.adds_services.add 
@@json=
'{
"id": "{{ id }}", 
"activeAlerts": {{ activeAlerts }}, 
"additionalInformation": "{{ additionalInformation }}", 
"createdDate": "{{ createdDate }}", 
"customNotificationEmails": "{{ customNotificationEmails }}", 
"disabled": {{ disabled }}, 
"displayName": "{{ displayName }}", 
"health": "{{ health }}", 
"lastDisabled": "{{ lastDisabled }}", 
"lastUpdated": "{{ lastUpdated }}", 
"monitoringConfigurationsComputed": "{{ monitoringConfigurationsComputed }}", 
"monitoringConfigurationsCustomized": "{{ monitoringConfigurationsCustomized }}", 
"notificationEmailEnabled": {{ notificationEmailEnabled }}, 
"notificationEmailEnabledForGlobalAdmins": {{ notificationEmailEnabledForGlobalAdmins }}, 
"notificationEmailsEnabledForGlobalAdmins": {{ notificationEmailsEnabledForGlobalAdmins }}, 
"notificationEmails": "{{ notificationEmails }}", 
"originalDisabledState": {{ originalDisabledState }}, 
"resolvedAlerts": {{ resolvedAlerts }}, 
"serviceId": "{{ serviceId }}", 
"serviceName": "{{ serviceName }}", 
"signature": "{{ signature }}", 
"simpleProperties": "{{ simpleProperties }}", 
"tenantId": "{{ tenantId }}", 
"type": "{{ type }}"
}'
;