命名空间:microsoft.graph.healthMonitoring
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
获取过去 30 天内Microsoft Entra运行状况监视警报对象及其属性的列表。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
HealthMonitoringAlert.Read.All |
不可用。 |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
HealthMonitoringAlert.Read.All |
不可用。 |
重要
除了委派的权限外,已登录用户还需要属于允许他们查看警报的Microsoft Entra角色。 此作支持以下最低特权角色。
- 全局读取者
- 安全管理员
- 安全操作员
- 安全信息读取者
- 帮助台管理员
- 报告读取者
HTTP 请求
GET /reports/healthMonitoring/alerts
可选的查询参数
此方法支持 $count、、$expand、$filter、 $orderby$select和 $topOData 查询参数,以帮助自定义响应。 不支持 $skip。 默认和最大页面大小为 100 个警报对象。
$orderby 仅在 属性上 createdDateTime 受支持。
如果未添加任何 $expand 查询参数,则默认情况下,此 API 不会返回 resourceSampling 属性。 如果要检索触发根本原因调查警报所涉及的资源示例,可以添加 $expand=enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling 以在 directoryObjectImpactSummary 中查看resourceSampling。
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在 200 OK 响应正文中返回响应代码和 警报 对象集合。
示例
示例 1:获取所有警报
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Reports.HealthMonitoring.Alerts.GetAsync();
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
alerts, err := graphClient.Reports().HealthMonitoring().Alerts().Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.healthmonitoring.AlertCollectionResponse result = graphClient.reports().healthMonitoring().alerts().get();
const options = {
authProvider,
};
const client = Client.init(options);
let alerts = await client.api('/reports/healthMonitoring/alerts')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->reports()->healthMonitoring()->alerts()->get()->wait();
Import-Module Microsoft.Graph.Beta.Reports
Get-MgBetaReportHealthMonitoringAlert
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.reports.health_monitoring.alerts.get()
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts",
"value": [
{
"id": "0c56dfcb-13db-4128-bda2-fc3e42742467",
"alertType": "mfaSignInFailure",
"scenario": "mfa",
"category": "authentication",
"createdDateTime": "2024-06-19T11:23:44.1234567Z",
"state": "active",
"enrichment": {
"state": "enriched",
"impacts": [
{
"@odata.type": "#microsoft.graph.healthMonitoring.userImpactSummary",
"resourceType": "user",
"impactedCount": 143,
"impactedCountLimitExceeded": false
},
{
"@odata.type": "#microsoft.graph.healthMonitoring.applicationImpactSummary",
"resourceType": "application",
"impactedCount": 1,
"impactedCountLimitExceeded": true
}
],
"supportingData": {
"signIns": "https://graph.microsoft.com/beta/auditLogs/signIns?$filter=((status/errorCode eq 500121) and createdDateTime gt 2024-06-08T11:23:44.1234567Z and createdDateTime le 2024-06-19T11:23:44.1234567Z and (signInEventTypes/any(t:t eq 'interactiveUser' or t eq 'noninteractiveUser')))",
"audits": "https://graph.microsoft.com/beta/auditLogs/directoryaudits?$filter=(activityDateTime ge 2024-06-08T11:23:44.1234567Z and activityDateTime le 2024-06-19T11:23:44.1234567Z)&$top=50&$orderby=activityDateTime desc"
}
},
"signals": {
"mfaSignInFailure": "https://graph.microsoft.com/beta/reports/serviceActivity/getMetricsForMfaSignInFailure(inclusiveIntervalStartDateTime=2024-06-08T11:23:44.1234567Z, exclusiveIntervalEndDateTime=2024-06-19T11:23:44.1234567Z, aggregationIntervalInMinutes=5)"
},
"documentation": {
"troubleshootingGuide": "https://go.microsoft.com/fwlink/?linkid=2280158"
}
},
]
}
示例 2:获取所有活动警报
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts?$filter=state eq microsoft.graph.healthmonitoring.alertState'active'&$select=id, alertType
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Reports.HealthMonitoring.Alerts.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "state eq microsoft.graph.healthmonitoring.alertState'active'";
requestConfiguration.QueryParameters.Select = new string []{ "id"," alertType" };
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphreports "github.com/microsoftgraph/msgraph-beta-sdk-go/reports"
//other-imports
)
requestFilter := "state eq microsoft.graph.healthmonitoring.alertState'active'"
requestParameters := &graphreports.HealthMonitoringAlertsRequestBuilderGetQueryParameters{
Filter: &requestFilter,
Select: [] string {"id"," alertType"},
}
configuration := &graphreports.HealthMonitoringAlertsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
alerts, err := graphClient.Reports().HealthMonitoring().Alerts().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.healthmonitoring.AlertCollectionResponse result = graphClient.reports().healthMonitoring().alerts().get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "state eq microsoft.graph.healthmonitoring.alertState'active'";
requestConfiguration.queryParameters.select = new String []{"id", " alertType"};
});
const options = {
authProvider,
};
const client = Client.init(options);
let alerts = await client.api('/reports/healthMonitoring/alerts')
.version('beta')
.filter('state eq microsoft.graph.healthmonitoring.alertState\'active\'')
.select('id,alertType')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\HealthMonitoring\Alerts\AlertsRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new AlertsRequestBuilderGetRequestConfiguration();
$queryParameters = AlertsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "state eq microsoft.graph.healthmonitoring.alertState'active'";
$queryParameters->select = ["id"," alertType"];
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->reports()->healthMonitoring()->alerts()->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Reports
Get-MgBetaReportHealthMonitoringAlert -Filter "state eq microsoft.graph.healthmonitoring.alertState'active'" -Property "id, alertType"
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.reports.health_monitoring.alerts.alerts_request_builder import AlertsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = AlertsRequestBuilder.AlertsRequestBuilderGetQueryParameters(
filter = "state eq microsoft.graph.healthmonitoring.alertState'active'",
select = ["id"," alertType"],
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.reports.health_monitoring.alerts.get(request_configuration = request_configuration)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts(id,alertType)",
"value": [
{
"id": "0c56dfcb-13db-4128-bda2-fc3e42742467",
"alertType": "mfaSignInFailure"
},
{
"id": "564bc4e2-10f6-4d76-b10c-25657637f748",
"alertType": "managedDeviceSignInFailure"
},
]
}
示例 3:列出特定时间范围内所有警报的状态
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts?$filter=createdDateTime gt 2024-06-10T11:23:44Z&$select=id, alertType, createdDateTime, state
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Reports.HealthMonitoring.Alerts.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "createdDateTime gt 2024-06-10T11:23:44Z";
requestConfiguration.QueryParameters.Select = new string []{ "id"," alertType"," createdDateTime"," state" };
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphreports "github.com/microsoftgraph/msgraph-beta-sdk-go/reports"
//other-imports
)
requestFilter := "createdDateTime gt 2024-06-10T11:23:44Z"
requestParameters := &graphreports.HealthMonitoringAlertsRequestBuilderGetQueryParameters{
Filter: &requestFilter,
Select: [] string {"id"," alertType"," createdDateTime"," state"},
}
configuration := &graphreports.HealthMonitoringAlertsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
alerts, err := graphClient.Reports().HealthMonitoring().Alerts().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.healthmonitoring.AlertCollectionResponse result = graphClient.reports().healthMonitoring().alerts().get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "createdDateTime gt 2024-06-10T11:23:44Z";
requestConfiguration.queryParameters.select = new String []{"id", " alertType", " createdDateTime", " state"};
});
const options = {
authProvider,
};
const client = Client.init(options);
let alerts = await client.api('/reports/healthMonitoring/alerts')
.version('beta')
.filter('createdDateTime gt 2024-06-10T11:23:44Z')
.select('id,alertType,createdDateTime,state')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\HealthMonitoring\Alerts\AlertsRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new AlertsRequestBuilderGetRequestConfiguration();
$queryParameters = AlertsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "createdDateTime gt 2024-06-10T11:23:44Z";
$queryParameters->select = ["id"," alertType"," createdDateTime"," state"];
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->reports()->healthMonitoring()->alerts()->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Reports
Get-MgBetaReportHealthMonitoringAlert -Filter "createdDateTime gt 2024-06-10T11:23:44Z" -Property "id, alertType, createdDateTime, state"
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.reports.health_monitoring.alerts.alerts_request_builder import AlertsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = AlertsRequestBuilder.AlertsRequestBuilderGetQueryParameters(
filter = "createdDateTime gt 2024-06-10T11:23:44Z",
select = ["id"," alertType"," createdDateTime"," state"],
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.reports.health_monitoring.alerts.get(request_configuration = request_configuration)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts(id,alertType,createdDateTime,state)",
"value": [
{
"id": "0c56dfcb-13db-4128-bda2-fc3e42742467",
"alertType": "mfaSignInFailure",
"createdDateTime": "2024-06-19T11:23:44.1234567Z",
"state": "active"
},
{
"id": "564bc4e2-10f6-4d76-b10c-25657637f748",
"alertType": "managedDeviceSignInFailure",
"createdDateTime": "2024-06-11T01:25:24.1234567Z",
"state": "active"
},
]
}
示例 4:使用 $expand 通过目录对象资源采样获取所有警报
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts?$expand=enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling&$select=alertType, createdDateTime, enrichment'
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Reports.HealthMonitoring.Alerts.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Expand = new string []{ "enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling" };
requestConfiguration.QueryParameters.Select = new string []{ "alertType"," createdDateTime"," enrichment'" };
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphreports "github.com/microsoftgraph/msgraph-beta-sdk-go/reports"
//other-imports
)
requestParameters := &graphreports.HealthMonitoringAlertsRequestBuilderGetQueryParameters{
Expand: [] string {"enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling"},
Select: [] string {"alertType"," createdDateTime"," enrichment'"},
}
configuration := &graphreports.HealthMonitoringAlertsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
alerts, err := graphClient.Reports().HealthMonitoring().Alerts().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.healthmonitoring.AlertCollectionResponse result = graphClient.reports().healthMonitoring().alerts().get(requestConfiguration -> {
requestConfiguration.queryParameters.expand = new String []{"enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling"};
requestConfiguration.queryParameters.select = new String []{"alertType", " createdDateTime", " enrichment'"};
});
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\HealthMonitoring\Alerts\AlertsRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new AlertsRequestBuilderGetRequestConfiguration();
$queryParameters = AlertsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->expand = ["enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling"];
$queryParameters->select = ["alertType"," createdDateTime"," enrichment'"];
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->reports()->healthMonitoring()->alerts()->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Reports
Get-MgBetaReportHealthMonitoringAlert -ExpandProperty "enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling" -Property "alertType, createdDateTime, enrichment'"
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.reports.health_monitoring.alerts.alerts_request_builder import AlertsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = AlertsRequestBuilder.AlertsRequestBuilderGetQueryParameters(
expand = ["enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling"],
select = ["alertType"," createdDateTime"," enrichment'"],
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.reports.health_monitoring.alerts.get(request_configuration = request_configuration)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts(alertType,createdDateTime,enrichment,enrichment/impacts/microsoft.graph.healthMonitoring.directoryObjectImpactSummary/resourceSampling())",
"value": [
{
"alertType": "mfaSignInFailure",
"createdDateTime": "2024-06-19T11:23:44.1234567Z",
"enrichment": {
"state": "enriched",
"impacts": [
{
"@odata.type": "#microsoft.graph.healthMonitoring.userImpactSummary",
"resourceType": "user",
"impactedCount": 143,
"impactedCountLimitExceeded": false,
"resourceSampling": []
},
{
"@odata.type": "#microsoft.graph.healthMonitoring.applicationImpactSummary",
"resourceType": "application",
"impactedCount": 1,
"impactedCountLimitExceeded": true,
"resourceSampling": [
{
"id": "63c83fa4-d90c-4274-8460-5463e96f1113"
}
]
}
],
"supportingData": {
"signIns": "https://graph.microsoft.com/beta/auditLogs/signIns?$filter=((status/errorCode eq 500121) and createdDateTime gt 2024-06-08T11:23:44.1234567Z and createdDateTime le 2024-06-19T11:23:44.1234567Z and (signInEventTypes/any(t:t eq 'interactiveUser' or t eq 'noninteractiveUser')))",
"audits": "https://graph.microsoft.com/beta/auditLogs/directoryaudits?$filter=(activityDateTime ge 2024-06-08T11:23:44.1234567Z and activityDateTime le 2024-06-19T11:23:44.1234567Z)&$top=50&$orderby=activityDateTime desc"
}
}
},
]
}