cloudPcReport：retrieveCloudPcRecommendationReports

命名空间：microsoft.graph

重要

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

检索云电脑建议报告，以优化使用情况并节省成本。使用情况类别报表将云电脑分类为 Undersized、 Oversized、 Rightsized或 Underutilized，并在云电脑不是 Rightsized时提供建议的 SKU。

注意

此 API 将替换已弃用的 cloudPcReports： retrieveCloudPcRecommendationReports API，该 API 将于 2025 年 12 月 31 日停止返回数据。

此 API 可用于以下国家级云部署。

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

权限

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

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

HTTP 请求

POST /deviceManagement/virtualEndpoint/report/retrieveCloudPcRecommendationReports

请求标头

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

请求正文

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

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

参数	类型	说明
filter	String	OData `$filter` 语法。支持的筛选器包括：`and`、、`or`、`lt`、`legt`、 `ge`和 `eq`。可选。
groupBy	字符串集合	指定如何对报表进行分组。如果使用，则必须具有与 select 参数相同的内容。可选。
orderBy	字符串集合	指定如何对报表进行排序。可选。
reportType	cloudPcRecommendationReportType	报表类型。支持 cloudPcRecommendationReportType 的值子集。支持的值为 `cloudPcUsageCategoryReport`。必填。
search	String	指定要搜索的字符串。可选。
select	字符串集合	OData `$select` 语法。报表的选定列。可选。
skip	Int32	要跳过的记录数。可选。
top	Int32	要返回的排名靠前的记录数。可选。

响应

如果成功，此作将在200 OK响应正文中返回响应代码和Stream。

示例

示例 1：获取按服务计划和使用情况类别分组的设备建议报告

以下示例演示如何获取按服务计划和使用情况类别分组的设备建议报告。

请求

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

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

{
  "reportType": "cloudPcUsageCategoryReport",
  "select": [
    "ServicePlanId",
    "ServicePlanName",
    "UsageCategory"
  ],
  "groupBy": [
    "ServicePlanId",
    "ServicePlanName",
    "UsageCategory"
  ]
}

响应

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

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

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

{
  "TotalRowCount": 15,
  "Schema": [
    {
      "Column": "__Count",
      "PropertyType": "Int32"
    },
    {
      "Column": "ServicePlanId",
      "PropertyType": "String"
    },
    {
      "Column": "ServicePlanName",
      "PropertyType": "String"
    },
    {
      "Column": "UsageCategory",
      "PropertyType": "String"
    }
  ],
  "Values": [
    [
      26,
      "d3468c8c-3545-4f44-a32f-b465934d2498",
      "Cloud PC Enterprise 2vCPU/8GB/256GB",
      "Undersized"
    ],
    [
      12,
      "d3468c8c-3545-4f44-a32f-b465934d2498",
      "Cloud PC Enterprise 2vCPU/8GB/256GB",
      "Oversized"
    ],
    [
      300,
      "d3468c8c-3545-4f44-a32f-b465934d2498",
      "Cloud PC Enterprise 2vCPU/8GB/256GB",
      "Rightsized"
    ],
    [
      4,
      "d3468c8c-3545-4f44-a32f-b465934d2498",
      "Cloud PC Enterprise 2vCPU/8GB/256GB",
      "Underutilized"
    ]
  ]
}

示例 2：获取云电脑的设备使用情况类别报告

以下示例演示如何获取单个云电脑的详细使用情况类别报告。

请求