Créer cloudPcExportJob

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez une ressource cloudPcExportJob pour lancer le téléchargement de la partie entière ou spécifiée d’un rapport.

Utilisez l’opération GET cloudPcExportJob pour vérifier la propriété exportJobStatus de la ressource cloudPcExportJob . Lorsque le résultat de la propriété est completed, le rapport termine le téléchargement vers l’emplacement spécifié par la propriété exportUrl .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) CloudPC.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application CloudPC.ReadWrite.All Non disponible.

Requête HTTP

POST /deviceManagement/virtualEndpoint/reports/exportJobs

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet cloudPcExportJob .

Vous pouvez spécifier les propriétés suivantes lorsque vous créez un cloudPcExportJob.

Propriété Type Description
filtre Chaîne Filtre appliqué au rapport. Optional.
reportName cloudPcReportName Nom du rapport. Les valeurs possibles sont : remoteConnectionHistoricalReports, dailyAggregatedRemoteConnectionReports, totalAggregatedRemoteConnectionReports, sharedUseLicenseUsageReport, sharedUseLicenseUsageRealTimeReport, unknownFutureValuenoLicenseAvailableConnectivityFailureReport, frontlineLicenseUsageReport, frontlineLicenseUsageRealTimeReport, remoteConnectionQualityReports, inaccessibleCloudPcReports, crossRegionDisasterRecoveryReport, regionalConnectionQualityTrendReport, , regionalConnectionQualityInsightsReport, , . remoteConnectionQualityReport Vous devez utiliser l’en-tête Prefer: include-unknown-enum-members de requête pour obtenir les valeurs suivantes dans cette énumération évolutive : noLicenseAvailableConnectivityFailureReport, frontlineLicenseUsageReport, frontlineLicenseUsageRealTimeReport, remoteConnectionQualityReports, inaccessibleCloudPcReports, crossRegionDisasterRecoveryReport.
select String collection Colonnes sélectionnées du rapport. Facultatif.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet cloudPcExportJob dans le corps de la réponse.

Exemples

Exemple 1 : Créer un travail d’exportation pour télécharger le rapport TotalAggregatedRemoteConnectionReports

L’exemple suivant montre comment créer une tâche d’exportation pour télécharger le TotalAggregatedRemoteConnectionReports rapport.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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
}

Exemple 2 : Créez un travail d’exportation pour télécharger le rapport RemoteConnectionQualityReports.

L’exemple suivant montre comment créer une tâche d’exportation pour télécharger le RemoteConnectionQualityReports rapport.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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
}