adds_services_server_alerts
Creates, updates, deletes, gets or lists an adds_services_server_alerts
resource.
Overview
Name | adds_services_server_alerts |
Type | Resource |
Id | azure.ad_hybrid_health_service.adds_services_server_alerts |
Fields
The following fields are returned by SELECT
queries:
- list
The list of server alerts.
Name | Datatype | Description |
---|---|---|
activeAlertProperties | array | The active alert properties. |
additionalInformation | array | Additional information related to the alert. |
alertId | string (uuid) | The alert Id. |
createdDate | string (date-time) | The date and time,in UTC,when the alert was created. |
description | string | The alert description. |
displayName | string | The display name for the alert. |
lastUpdated | string (date-time) | The date and time, in UTC, when the alert was last updated. |
level | string | The alert level which indicates the severity of the alert. |
monitorRoleType | string | The monitoring role type for which the alert was raised. |
relatedLinks | array | The help links to get more information related to the alert. |
remediation | string | The alert remediation. |
resolvedAlertProperties | array | The resolved alert properties. |
resolvedDate | string (date-time) | The date and time, in UTC, when the alert was resolved. |
scope | string | The scope of the alert. Indicates if it is a service or a server related alert. |
serviceId | string (uuid) | The service Id. |
serviceMemberId | string (uuid) | The server Id. |
shortName | string | The alert short name. |
state | string | The alert state which can be either active or resolved with multiple resolution types. |
tenantId | string (uuid) | The tenant Id. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list | select | serviceMemberId , serviceName | $filter , state , from , to | Gets the details of an alert for a given Active Directory Domain Controller service and server combination. |
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 for which the alert details needs to be queried. |
serviceName | string | The name of the service. |
$filter | string | The alert property filter to apply. |
from | string (date-time) | The start date to query for. |
state | string | The alert state to query for. |
to | string (date-time) | The end date till when to query for. |
SELECT
examples
- list
Gets the details of an alert for a given Active Directory Domain Controller service and server combination.
SELECT
activeAlertProperties,
additionalInformation,
alertId,
createdDate,
description,
displayName,
lastUpdated,
level,
monitorRoleType,
relatedLinks,
remediation,
resolvedAlertProperties,
resolvedDate,
scope,
serviceId,
serviceMemberId,
shortName,
state,
tenantId
FROM azure.ad_hybrid_health_service.adds_services_server_alerts
WHERE serviceMemberId = '{{ serviceMemberId }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND $filter = '{{ $filter }}'
AND state = '{{ state }}'
AND from = '{{ from }}'
AND to = '{{ to }}'
;