Freigeben über


Erstellen von cloudPcExportJob

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie eine neue cloudPcExportJob-Ressource , um das Herunterladen des gesamten oder angegebenen Teils eines Berichts zu initiieren.

Verwenden Sie den Get cloudPcExportJob-Vorgang , um die exportJobStatus-Eigenschaft der cloudPcExportJob-Ressource zu überprüfen. Wenn das Ergebnis der Eigenschaft ist completed, wird der Download des Berichts an den von der exportUrl-Eigenschaft angegebenen Speicherort abgeschlossen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) CloudPC.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung CloudPC.ReadWrite.All Nicht verfügbar.

HTTP-Anforderung

POST /deviceManagement/virtualEndpoint/reports/exportJobs

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des cloudPcExportJob-Objekts an.

Sie können die folgenden Eigenschaften angeben, wenn Sie einen cloudPcExportJob erstellen.

Eigenschaft Typ Beschreibung
filter Zeichenfolge Der auf den Bericht angewendete Filter. Optional.
Format Zeichenfolge Das Format des exportierten Berichts. Optional.
reportName cloudPcReportName Der Berichtsname. Die möglichen Werte sind: remoteConnectionHistoricalReports, dailyAggregatedRemoteConnectionReports, totalAggregatedRemoteConnectionReports, sharedUseLicenseUsageReport, sharedUseLicenseUsageRealTimeReport, , unknownFutureValue, frontlineLicenseUsageReportnoLicenseAvailableConnectivityFailureReport, frontlineLicenseUsageRealTimeReport, remoteConnectionQualityReportsinaccessibleCloudPcReportsperformanceTrendReportcrossRegionDisasterRecoveryReport, inaccessibleCloudPcTrendReport, regionalConnectionQualityTrendReport, regionalConnectionQualityInsightsReport, , . remoteConnectionQualityReport Verwenden Sie den AnforderungsheaderPrefer: include-unknown-enum-members, um die folgenden Werte in dieser verteilbaren Enumeration abzurufen: noLicenseAvailableConnectivityFailureReport, frontlineLicenseUsageReport, remoteConnectionQualityReportsfrontlineLicenseUsageRealTimeReport, , inaccessibleCloudPcReports, crossRegionDisasterRecoveryReport, regionalConnectionQualityTrendReportinaccessibleCloudPcTrendReportperformanceTrendReportregionalConnectionQualityInsightsReport, . remoteConnectionQualityReport
select String collection Die ausgewählten Spalten des Berichts. Optional.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein cloudPcExportJob-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Erstellen eines Exportauftrags zum Herunterladen des Berichts TotalAggregatedRemoteConnectionReports

Das folgende Beispiel zeigt, wie Sie einen Exportauftrag zum Herunterladen des TotalAggregatedRemoteConnectionReports Berichts erstellen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
  ]
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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
}

Beispiel 2: Erstellen Eines Exportauftrags zum Herunterladen des RemoteConnectionQualityReports-Berichts.

Das folgende Beispiel zeigt, wie Sie einen Exportauftrag zum Herunterladen des RemoteConnectionQualityReports Berichts erstellen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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'"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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
}