adds_services_forest_summaries

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

Overview

Name	adds_services_forest_summaries
Type	Resource
Id	azure.ad_hybrid_health_service.adds_services_forest_summaries

Fields

The following fields are returned by SELECT queries:

get

The list of forest summary for the service.

Name	Datatype	Description
domainCount	integer	The domain count.
domains	array	The list of domain controller names.
forestName	string	The forest name.
monitoredDcCount	integer	The number of domain controllers that are monitored by Azure Active Directory Connect Health.
siteCount	integer	The site count.
sites	array	The list of site names.
totalDcCount	integer	The total domain controllers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	serviceName		Gets the forest summary for a given Active Directory Domain Service, that is onboarded to 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.

SELECT examples

get

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

SELECT
domainCount,
domains,
forestName,
monitoredDcCount,
siteCount,
sites,
totalDcCount
FROM azure.ad_hybrid_health_service.adds_services_forest_summaries
WHERE serviceName = '{{ serviceName }}' -- required
;