创建 cloudPcExportJob

  • 项目

命名空间：microsoft.graph

重要

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

创建新的 cloudPcExportJob 资源，以开始下载报表的整个或指定部分。

使用 GET cloudPcExportJob 操作验证 cloudPcExportJob 资源的 exportJobStatus 属性。 当属性结果为 completed时，报表已完成下载到 exportUrl 属性指定的位置。

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

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

权限

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

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

HTTP 请求

POST /deviceManagement/virtualEndpoint/reports/exportJobs

请求标头

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

请求正文

在请求正文中，提供 cloudPcExportJob 对象的 JSON 表示形式。

创建 cloudPcExportJob 时，可以指定以下属性。

属性 类型 说明
filter String 对报表应用的筛选器。 可选。
format String 导出报表的格式。 可选。
reportName cloudPcReportName 报表名称。 可能的值为：remoteConnectionHistoricalReports、、dailyAggregatedRemoteConnectionReports、、totalAggregatedRemoteConnectionReports、noLicenseAvailableConnectivityFailureReportunknownFutureValuefrontlineLicenseUsageReportsharedUseLicenseUsageRealTimeReportsharedUseLicenseUsageReport、、frontlineLicenseUsageRealTimeReportremoteConnectionQualityReports、、 。 inaccessibleCloudPcReports 必须使用Prefer: include-unknown-enum-members请求标头来获取以下值 (在此可演变枚举中的) ：noLicenseAvailableConnectivityFailureReport、、frontlineLicenseUsageReportfrontlineLicenseUsageRealTimeReport、inaccessibleCloudPcReports。
select 字符串集合 报表的选定列。 可选。

响应

如果成功，此方法在 201 Created 响应正文中返回响应代码和 cloudPcExportJob 对象。

示例

示例 1：创建导出作业以下载 TotalAggregatedRemoteConnectionReports 报告

以下示例演示如何创建导出作业以下载 TotalAggregatedRemoteConnectionReports 报表。

请求

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

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

{
  "reportName": "TotalAggregatedRemoteConnectionReports",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "DaysSinceLastSignIn",
    "TotalUsageInHour"
  ]
}

响应

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/reports/exportJobs/$entity",
  "id": "TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff",
  "reportName": "totalAggregatedRemoteConnectionReports",
  "filter": null,
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "DaysSinceLastSignIn",
    "TotalUsageInHour"
  ],
  "format": null,
  "expirationDateTime": "0001-01-01T00:00:00Z",
  "requestDateTime": "2022-09-16T12:00:06.5137388Z",
  "exportJobStatus": "inProgress",
  "exportUrl": null
}

示例 2：创建导出作业以下载 RemoteConnectionQualityReports 报告。

以下示例演示如何创建导出作业以下载 RemoteConnectionQualityReports 报表。

请求

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

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

{
  "reportName": "RemoteConnectionQualityReports",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "EventDateTime"
  ],
  "filter": "EventDateTime gt datetime'2023-06-14T07:40:41.694Z'"
}

响应

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/reports/exportJobs/$entity",
  "id": "RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330",
  "reportName": "remoteConnectionQualityReports",
  "filter": "EventDateTime gt datetime'2023-06-14T07:40:41.694Z'",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "EventDateTime"
  ],
  "format": null,
  "expirationDateTime": null,
  "requestDateTime": "2023-06-14T07:40:41.694Z",
  "exportJobStatus": "inProgress",
  "exportUrl": null
}