Modifier

Partager via


Get alertConfiguration

Namespace: microsoft.graph.healthMonitoring

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Read the properties and relationships of a Microsoft Entra health monitoring alertConfiguration object. The returned alertConfiguration object contains the settings for the distribution groups where alert notifications are to be sent.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) HealthMonitoringAlertConfig.Read.All HealthMonitoringAlertConfig.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application HealthMonitoringAlertConfig.Read.All Not available.

In addition to the delegated permissions, the signed-in user needs to belong to a Microsoft Entra role that allows them to view alert configurations. The following least privileged roles are supported for this operation.

  • Global Reader
  • Security Administrator
  • Security Operator
  • Security Reader
  • Helpdesk Administrator
  • Reports Reader

HTTP request

GET /reports/healthMonitoring/alertConfigurations/{alertConfigurationId}

Optional query parameters

This method supports the $select OData query parameter to help customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a microsoft.graph.healthMonitoring.alertConfiguration object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/healthMonitoring/alertConfigurations/{alertConfigurationId}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alertConfigurations/$entity",
  "id": "mfaSignInFailure",
  "emailNotificationConfigurations": [
    {
      "groupId": "c5140914-9507-4180-b60c-04d5ec5eddcb",
      "isEnabled": true
    }
  ]
}