命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
警告
此 API 已弃用,将于 2025 年 12 月 31 日停止返回数据。 今后,请使用 cloudPcReport: retrieveCloudPcRecommendationReports API。
获取云电脑的设备建议报告,例如使用情况类别报告。 使用情况类别报表将云电脑分类为 Undersized、 Oversized、 Rightsized或 Underutilized,并在云电脑不是 Rightsized时提供建议的 SKU。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派(工作或学校帐户) | CloudPC.ReadWrite.All | 不可用。 |
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
| 应用程序 | CloudPC.ReadWrite.All | 不可用。 |
HTTP 请求
POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcRecommendationReports
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type | application/json. 必需。 |
请求正文
在请求正文中,提供参数的 JSON 表示形式。
下表显示了可用于此操作的参数。
| 参数 | 类型 | 说明 |
|---|---|---|
| filter | String | OData $filter 语法。 支持的筛选器包括:and、、or、lt、legt、 ge和 eq。 |
| groupBy | 字符串集合 | 指定如何对报表进行分组。 如果使用,则必须具有与 select 参数相同的内容。 |
| orderBy | 字符串集合 | 指定如何对报表进行排序。 |
| reportName | cloudPcRecommendationReportType | 报表名称。 可能的值包括 cloudPcUsageCategoryReport、unknownFutureValue、cloudPcUsageCategoryReports。 使用 Prefer: include-unknown-enum-members 请求标头从此 可演变枚举中获取以下值: cloudPcUsageCategoryReports。 成员 cloudPcUsageCategoryReports 已弃用,将于 2025 年 12 月 31 日停止返回。 今后,请改为将 cloudPcUsageCategoryReport 成员与 cloudPcReport 资源配合使用。 |
| search | String | 指定要搜索的字符串。 |
| select | 字符串集合 | OData $select 语法。 报表的选定列。 |
| skip | Int32 | 要跳过的记录数。 |
| top | Int32 | 要返回的排名靠前的记录数。 |
响应
如果成功,此作将在200 OK响应正文中返回响应代码和Stream。
示例
示例 1:按设备列出建议报告
以下示例演示如何列出前 50 个设备的报表。
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcRecommendationReports
Content-Type: application/json
Content-length: 262
{
"reportName": "cloudPcUsageCategoryReports",
"top": 50,
"skip": 0,
"search": "",
"filter": "",
"select": [
"CloudPcId",
"ManagedDeviceName",
"UserPrincipalName",
"UsageInsight",
"CurrentSize",
"RecommendedSize",
"UsageInHour",
"DevicePerfSummary"
],
"orderBy": [
"ManagedDeviceName"
]
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/octet-stream
{
"TotalRowCount": 489,
"Schema": [
{
"Column": "CloudPcId",
"PropertyType": "String"
},
{
"Column": "ManagedDeviceName",
"PropertyType": "String"
},
{
"Column": "UserPrincipalName",
"PropertyType": "String"
},
{
"Column": "UsageInsight",
"PropertyType": "String"
},
{
"Column": "CurrentSize",
"PropertyType": "Json"
},
{
"Column": "RecommendedSize",
"PropertyType": "Json"
},
{
"Column": "UsageInHour",
"PropertyType": "Double"
},
{
"Column": "DevicePerfSummary",
"PropertyType": "Json"
}
],
"Values": [
[
"4db3619f-be92-42a7-8c74-43fab185da6f",
"1MoveHost",
"connie_1@contoso.com",
"Rightsized",
{
"NumvCPUs": 2,
"RamInGB": 8,
"OsDiskSizeInGB": 128
},
null,
0,
{
"CPUUsagePercentageP90": 0.3,
"RAMUsagePercentageP90": 0.4
}
],
[
"f2ee066c-f63e-4acd-a41e-e348db71cb4d",
"AXFBF",
"connie_2@contoso.com",
"Rightsized",
{
"NumvCPUs": 2,
"RamInGB": 8,
"OsDiskSizeInGB": 128
},
null,
0,
{
"CPUUsagePercentageP90": 0.2,
"RAMUsagePercentageP90": 0.3
}
]
]
}
示例 2:按使用情况见解获取摘要报告
以下示例演示如何按使用情况见解汇总报表。
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcRecommendationReports
Content-Type: application/json
Content-length: 262
{
"reportName": "cloudPcUsageCategoryReports",
"select": [
"UsageInsight"
],
"groupBy": [
"UsageInsight"
],
"filter": ""
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/octet-stream
{
"TotalRowCount": 4,
"Schema": [
{
"Column": "__Count",
"PropertyType": "Int32"
},
{
"Column": "UsageInsight",
"PropertyType": "String"
}
],
"Values": [
[
200,
"Rightsized"
],
[
50,
"Undersized"
],
[
30,
"Oversized"
],
[
40,
"Underutilized"
]
]
}