service_members

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

Overview

Name	service_members
Type	Resource
Id	azure.ad_hybrid_health_service.service_members

Fields

The following fields are returned by SELECT queries:

get

The specific service member.

Name	Datatype	Description
activeAlerts	integer	The total number of alerts that are currently active for the server.
additionalInformation	string	The additional information, if any, for the server.
createdDate	string (date-time)	The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.
dimensions	object	The server specific configuration related dimensions.
disabled	boolean	Indicates if the server is disabled or not.
disabledReason	integer	The reason for disabling the server.
installedQfes	object	The list of installed QFEs for the server.
lastDisabled	string (date-time)	The date and time , in UTC, when the server was last disabled.
lastReboot	string (date-time)	The date and time, in UTC, when the server was last rebooted.
lastServerReportedMonitoringLevelChange	string (date-time)	The date and time, in UTC, when the server's data monitoring configuration was last changed.
lastUpdated	string (date-time)	The date and time, in UTC, when the server properties were last updated.
machineId	string	The id of the machine.
machineName	string	The name of the server.
monitoringConfigurationsComputed	object	The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
monitoringConfigurationsCustomized	object	The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
osName	string	The name of the operating system installed in the machine.
osVersion	string	The version of the operating system installed in the machine.
properties	object	Server specific properties.
recommendedQfes	object	The list of recommended hotfixes for the server.
resolvedAlerts	integer	The total count of alerts that are resolved for this server.
role	string	The service role that is being monitored in the server.
serverReportedMonitoringLevel	string	The monitoring level reported by the server.
serviceId	string	The service id to whom this server belongs.
serviceMemberId	string	The id of the server.
status	string	The health status of the server.
tenantId	string	The tenant id to whom this server belongs.

list

The list of service members.

Name	Datatype	Description
activeAlerts	integer	The total number of alerts that are currently active for the server.
additionalInformation	string	The additional information, if any, for the server.
createdDate	string (date-time)	The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.
dimensions	object	The server specific configuration related dimensions.
disabled	boolean	Indicates if the server is disabled or not.
disabledReason	integer	The reason for disabling the server.
installedQfes	object	The list of installed QFEs for the server.
lastDisabled	string (date-time)	The date and time , in UTC, when the server was last disabled.
lastReboot	string (date-time)	The date and time, in UTC, when the server was last rebooted.
lastServerReportedMonitoringLevelChange	string (date-time)	The date and time, in UTC, when the server's data monitoring configuration was last changed.
lastUpdated	string (date-time)	The date and time, in UTC, when the server properties were last updated.
machineId	string	The id of the machine.
machineName	string	The name of the server.
monitoringConfigurationsComputed	object	The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
monitoringConfigurationsCustomized	object	The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
osName	string	The name of the operating system installed in the machine.
osVersion	string	The version of the operating system installed in the machine.
properties	object	Server specific properties.
recommendedQfes	object	The list of recommended hotfixes for the server.
resolvedAlerts	integer	The total count of alerts that are resolved for this server.
role	string	The service role that is being monitored in the server.
serverReportedMonitoringLevel	string	The monitoring level reported by the server.
serviceId	string	The service id to whom this server belongs.
serviceMemberId	string	The id of the server.
status	string	The health status of the server.
tenantId	string	The tenant id to whom this server belongs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	serviceName, serviceMemberId		Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
list	select	serviceName	$filter, dimensionType, dimensionSignature	Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
delete	delete	serviceName, serviceMemberId	confirm	Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.
add	exec	serviceName		Onboards a server, for a given service, to Azure Active Directory Connect Health Service.
delete_data	exec	serviceName, serviceMemberId		Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.

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
serviceMemberId	string (uuid)	The server Id.
serviceName	string	The name of the service.
$filter	string	The server property filter to apply.
confirm	boolean	Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.
dimensionSignature	string	The value of the dimension.
dimensionType	string	The server specific dimension.

SELECT examples

get

Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.

SELECT
activeAlerts,
additionalInformation,
createdDate,
dimensions,
disabled,
disabledReason,
installedQfes,
lastDisabled,
lastReboot,
lastServerReportedMonitoringLevelChange,
lastUpdated,
machineId,
machineName,
monitoringConfigurationsComputed,
monitoringConfigurationsCustomized,
osName,
osVersion,
properties,
recommendedQfes,
resolvedAlerts,
role,
serverReportedMonitoringLevel,
serviceId,
serviceMemberId,
status,
tenantId
FROM azure.ad_hybrid_health_service.service_members
WHERE serviceName = '{{ serviceName }}' -- required
AND serviceMemberId = '{{ serviceMemberId }}' -- required
;

list

Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.

SELECT
activeAlerts,
additionalInformation,
createdDate,
dimensions,
disabled,
disabledReason,
installedQfes,
lastDisabled,
lastReboot,
lastServerReportedMonitoringLevelChange,
lastUpdated,
machineId,
machineName,
monitoringConfigurationsComputed,
monitoringConfigurationsCustomized,
osName,
osVersion,
properties,
recommendedQfes,
resolvedAlerts,
role,
serverReportedMonitoringLevel,
serviceId,
serviceMemberId,
status,
tenantId
FROM azure.ad_hybrid_health_service.service_members
WHERE serviceName = '{{ serviceName }}' -- required
AND $filter = '{{ $filter }}'
AND dimensionType = '{{ dimensionType }}'
AND dimensionSignature = '{{ dimensionSignature }}'
;

DELETE examples

delete

Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.

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

Lifecycle Methods

add

Onboards a server, for a given service, to Azure Active Directory Connect Health Service.

EXEC azure.ad_hybrid_health_service.service_members.add 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"serviceMemberId": "{{ serviceMemberId }}", 
"serviceId": "{{ serviceId }}", 
"tenantId": "{{ tenantId }}", 
"activeAlerts": {{ activeAlerts }}, 
"additionalInformation": "{{ additionalInformation }}", 
"createdDate": "{{ createdDate }}", 
"dimensions": "{{ dimensions }}", 
"disabled": {{ disabled }}, 
"disabledReason": {{ disabledReason }}, 
"installedQfes": "{{ installedQfes }}", 
"lastDisabled": "{{ lastDisabled }}", 
"lastReboot": "{{ lastReboot }}", 
"lastServerReportedMonitoringLevelChange": "{{ lastServerReportedMonitoringLevelChange }}", 
"lastUpdated": "{{ lastUpdated }}", 
"machineId": "{{ machineId }}", 
"machineName": "{{ machineName }}", 
"monitoringConfigurationsComputed": "{{ monitoringConfigurationsComputed }}", 
"monitoringConfigurationsCustomized": "{{ monitoringConfigurationsCustomized }}", 
"osName": "{{ osName }}", 
"osVersion": "{{ osVersion }}", 
"properties": "{{ properties }}", 
"recommendedQfes": "{{ recommendedQfes }}", 
"resolvedAlerts": {{ resolvedAlerts }}, 
"role": "{{ role }}", 
"serverReportedMonitoringLevel": "{{ serverReportedMonitoringLevel }}", 
"status": "{{ status }}"
}'
;

delete_data

Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.

EXEC azure.ad_hybrid_health_service.service_members.delete_data 
@serviceName='{{ serviceName }}' --required, 
@serviceMemberId='{{ serviceMemberId }}' --required
;