cloudPcReports:getInaccessibleCloudPcReports

命名空间:microsoft.graph

重要

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

获取无法访问的云电脑及其详细信息,包括最新运行状况状态、失败连接计数、故障运行状况检查计数和系统状态。 无法访问的云电脑表示处于不可用状态的云电脑, (至少有一个运行状况检查) 失败或用户连接连续失败。

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

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

权限

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

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

HTTP 请求

POST /deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports

请求标头

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

请求正文

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

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

参数 类型 说明
filter String OData $filter 语法。 目前仅and支持 、orgtgeeq
groupBy 字符串集合 指定如何对报表进行分组。 如果使用,则必须具有与 select 参数相同的内容。
orderBy 字符串集合 指定如何对报表进行排序。
reportName cloudPCInaccessibleReportName 报表名称。 可能的值包括 inaccessibleCloudPcReportsinaccessibleCloudPcTrendReportunknownFutureValue。 如果 reportName 为空,则默认值inaccessibleCloudPcReports为 。
search String 指定要搜索的字符串。
select 字符串集合 OData $select 语法。 表示报表的选定列。
skip Int32 要跳过的记录数。
top Int32 要返回的排名靠前的记录数。

cloudPCInaccessibleReportName 值

成员 说明
inaccessibleCloudPcReports 指示包含无法访问的云电脑的详细信息的报告,包括那些连续连接失败或处于不可用状态的电脑。
inaccessibleCloudPcTrendReport 指示指定时段的每日聚合报告,其中包含无法访问的云电脑的详细信息,包括那些连续连接失败或处于不可用状态的电脑。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。

响应

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

示例

请求

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

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

{
  "filter": "region eq 'westus2'",
  "orderBy": [
    "cloudPcId"
  ],
  "select": [
    "cloudPcId",
    "aadDeviceId",
    "cloudPcName",
    "userPrincipalName",
    "provisioningStatus",
    "region",
    "deviceHealthStatus",
    "deviceHealthStatusDateTime",
    "recentDeviceHealthFailureCount",
    "recentConnectionFailureCount",
    "systemStatus",
    "systemStatusDateTime"
  ],
  "top": 10,
  "skip": 0
}

响应

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

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

{
  "TotalRowCount": 2,
  "Schema": [
    {
      "Column": "cloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "aadDeviceId",
      "PropertyType": "String"
    },
    {
      "Column": "cloudPcName",
      "PropertyType": "String"
    },
    {
      "Column": "userPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "provisioningStatus",
      "PropertyType": "String"
    },
    {
      "Column": "region",
      "PropertyType": "String"
    },
    {
      "Column": "deviceHealthStatus",
      "PropertyType": "String"
    },
    {
      "Column": "deviceHealthStatusDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "recentDeviceHealthFailureCount",
      "PropertyType": "Int32"
    },
    {
      "Column": "recentConnectionFailureCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "systemStatus",
      "PropertyType": "String"
    },
    {
      "Column": "systemStatusDateTime",
      "PropertyType": "DateTime"
    }
  ],
  "Values": [
    [
      "04e279c5-b228-4700-93c3-6f1339c7c86d",
      "a8f78191-8e43-4165-9191-16867d372161",
      "CPC-test1-VGTEK",
      "bob@fabrikam.com",
      "Provisioned",
      "westus2",
      "ErrorVMNotRunning",
      "2023-06-26T03:55:04",
      3,
      0,
      "",
      null
    ],
    [
      "818ff73d-9764-4412-ad99-fc65a396daf3",
      "daefef60-a912-4180-a5c0-f607e346878f",
      "CPC-test2-C84W3",
      "megan@fabrikam.com",
      "Provisioned",
      "westus2",
      "ErrorVMNotRunning",
      "2023-06-26T04:03:49",
      3,
      0,
      "",
      null
    ]
  ]
}