cloudPcReports：retrieveCloudPcTenantMetricsReport

项目
01/28/2025

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。不支持在生产应用程序中使用这些 API。若要确定 API 是否在 v1.0 中可用，请使用版本选择器。

获取与云电脑性能相关的报告。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	CloudPC.Read.All	CloudPC.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	CloudPC.Read.All	CloudPC.ReadWrite.All

HTTP 请求

POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 必需。

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表显示了可用于此方法的参数。

参数	类型	说明
filter	String	OData `$filter` 语法。支持的筛选器包括： `and`、 `or`、 `gt`和 `eq`。
groupBy	字符串集合	指定如何对报表进行分组。如果使用，则必须具有与 select 参数相同的内容。
orderBy	字符串集合	指定如何对报表进行排序。
reportName	cloudPCPerformanceReportName	报表名称。可能的值包括 `performanceTrendReport`、`unknownFutureValue`、`cloudPcInsightReport`。使用 `Prefer: include-unknown-enum-members` 请求标头获取此可演变枚举中的以下值： `cloudPcInsightReport`。
search	String	指定要搜索的字符串。
select	字符串集合	OData `$select` 语法。报表的选定列。
skip	Int32	要跳过的记录数。
top	Int32	指定页面大小。如果未定义，则默认值为 25，最大值为 100。

响应

如果成功，此方法在200 OK响应正文中返回响应代码和Stream 对象。

示例

示例 1：获取性能趋势报告

以下示例演示如何获取包含每日聚合数据的性能趋势报告，这些数据提供租户中过去 7 天内云电脑的连接质量指标列表。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport
Content-Type: application/json

{
  "reportName": "performanceTrendReport",
  "filter": "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
  "select": [
    "EventDateTime",
    "SlowRoundTripTimeCloudPcCount",
    "LowUdpConnectionPercentageCount",
    "NoActiveTimeConnectedCount",
    "LowActiveTimeConnectedCount"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/octet-stream

{
  "TotalRowCount": 2,
  "Schema": [
    {
      "Column": "EventDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "SlowRoundTripTimeCloudPcCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "LowUdpConnectionPercentageCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "NoActiveTimeConnectedCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "LowActiveTimeConnectedCount",
      "PropertyType": "Int64"
    }
  ],
  "Values": [
    [
      "2023-10-16T00:00:00Z",
      3,
      8,
      3,
      92
    ],
    [
      "2023-10-15T00:00:00Z",
      4,
      6,
      5,
      91
    ]
  ]
}

示例 2：获取云电脑见解报表

以下示例演示如何获取在云电脑级别提供配置数据和见解的云电脑见解报表。

请求