cloudPcExportJob resource type

Article
10/22/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the export job for downloading a specified Cloud PC report.

Methods

Method	Return type	Description
Create export job	cloudPcExportJob	Create a new cloudPcExportJob object to initiate downloading the entire or a specified portion of a report.
Get export job	cloudPcExportJob	Read the properties and relationships of a cloudPcExportJob object.

Properties

Property	Type	Description
expirationDateTime	DateTimeOffset	The date and time when the export job expires.
exportJobStatus	cloudPcExportJobStatus	The status of the export job. The possible values are: `notStarted`, `inProgress`, `completed`, `unknownFutureValue`. Read-only.
exportUrl	String	The storage account URL of the exported report. It can be used to download the file.
filter	String	The filter applied on the report.
format	String	The format of the exported report.
id	String	The unique identifier for the report. Read-only.
reportName	cloudPcReportName	The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `actionStatusReport`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`, `bulkActionStatusReport`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`.
requestDateTime	DateTimeOffset	The date and time when the export job was requested.
select	String collection	The selected columns of the report.

cloudPcExportJobStatus values

Member	Description
notStarted	The export job doesn't start yet.
inProgress	The export job is in progress.
completed	The export job is completed with the export URL returned.
failed	The export job has failed.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

cloudPcReportName values

Member	Description
remoteConnectionHistoricalReports	The historical aggregated remote connections report.
dailyAggregatedRemoteConnectionReports	The daily aggregated remote connections report.
totalAggregatedRemoteConnectionReports	The total aggregated remote connections report.
sharedUseLicenseUsageReport	The daily/hourly aggregated shared use license usage report.
sharedUseLicenseUsageRealTimeReport	The real-time data for shared use license usage.
unknownFutureValue	Evolvable enumeration sentinel value. Do not use.
noLicenseAvailableConnectivityFailureReport	The Cloud PCs that failed to connect because no licenses were available.
frontlineLicenseUsageReport	The daily/hourly aggregated Windows 365 Frontline license usage report.
frontlineLicenseUsageRealTimeReport	The real-time data for Windows 365 Frontline license usage.
remoteConnectionQualityReports (deprecated)	The overall connection quality report for all devices within a tenant. Starting from December 31, 2024, this member ('remoteConnectionQualityReports') will be deprecated and no longer supported. Please use 'remoteConnectionQualityReport' instead.
inaccessibleCloudPcReports	The Cloud PCs that are inaccessible.
actionStatusReport	The actions status report for the Cloud PCs.
rawRemoteConnectionReports	The raw real-time remote connection report.
cloudPcUsageCategoryReports	The usage category reports of Cloud PCs.
crossRegionDisasterRecoveryReport	The cross-region disaster recovery status for Cloud PCs.
regionalConnectionQualityTrendReport	The regional connection quality trend reports of Cloud PCs.
regionalConnectionQualityInsightsReport	The regional connection quality insights reports of Cloud PCs.
remoteConnectionQualityReport	The overall connection quality reports for all devices under a tenant.
bulkActionStatusReport	The details of Cloud PC bulk actions, including bulk action status, name, type, state, completion state, and request date time.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.cloudPcExportJob",
  "expirationDateTime": "String (timestamp)",
  "exportJobStatus": "String",
  "exportUrl": "String",
  "filter": "String",
  "format": "String",
  "id": "String (identifier)",
  "reportName": "String",
  "requestDateTime": "String (timestamp)",
  "select": [
    "String"
  ]
}

Share via