Partager via

cloudPcReports : retrieveCloudPcTenantMetricsReport

  • Article

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 .

Obtenez un rapport sur les performances des PC cloud.

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.Read.All CloudPC.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application CloudPC.Read.All CloudPC.ReadWrite.All

Requête HTTP

POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport

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 des paramètres.

Le tableau suivant présente les paramètres que vous pouvez utiliser avec cette méthode.

Paramètre Type Description
filtre String Syntaxe OData $filter . Les filtres pris en charge sont les suivants : and, orgt, et eq.
groupBy String collection Spécifie comment regrouper les rapports. S’il est utilisé, doit avoir le même contenu que le paramètre select .
orderBy String collection Spécifie comment trier les rapports.
reportName cloudPCPerformanceReportName Nom du rapport. Les valeurs possibles sont performanceTrendReport, unknownFutureValue, cloudPcInsightReport. Utilisez l’en-tête Prefer: include-unknown-enum-members de requête pour obtenir la valeur suivante dans cette énumération évolutive : cloudPcInsightReport.
recherche String Spécifie une chaîne à rechercher.
select String collection Syntaxe OData $select . Colonnes sélectionnées des rapports.
skip Int32 Nombre d’enregistrements à ignorer.
top Int32 Spécifie la taille de la page. S’il n’est pas défini, la valeur par défaut est 25, avec une valeur maximale de 100.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet Stream dans le corps de la réponse.

Exemples

Exemple 1 : Obtenir un rapport de tendance des performances

L’exemple suivant montre comment obtenir le rapport de tendance des performances avec des données agrégées quotidiennes qui fournissent une liste de métriques de qualité de connexion pour les PC cloud au cours des sept derniers jours au sein d’un locataire.

Demande

L’exemple suivant illustre une demande.

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

{
  "reportName": "performanceTrendReport",
  "filter": "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
  "select": [
    "EventDateTime",
    "SlowRoundTripTimeCloudPcCount",
    "LowUdpConnectionPercentageCount",
    "NoActiveTimeConnectedCount",
    "LowActiveTimeConnectedCount"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "TotalRowCount": 2,
  "Schema": [
    {
      "Column": "EventDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "SlowRoundTripTimeCloudPcCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "LowUdpConnectionPercentageCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "NoActiveTimeConnectedCount",
      "PropertyType": "Int64"
    },
    {
      "Column": "LowActiveTimeConnectedCount",
      "PropertyType": "Int64"
    }
  ],
  "Values": [
    [
      "2023-10-16T00:00:00Z",
      3,
      8,
      3,
      92
    ],
    [
      "2023-10-15T00:00:00Z",
      4,
      6,
      5,
      91
    ]
  ]
}

Exemple 2 : Obtenir un rapport d’insights sur les PC cloud

L’exemple suivant montre comment obtenir le rapport Cloud PC Insight qui fournit des données de configuration et des insights au niveau du PC cloud.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport

{
  "reportName": "cloudPcInsightReport",
  "filter": "",
  "select": [
    "ManagedDeviceName",
    "DeviceId",
    "ClientOS",
    "ClientVersion",
    "MultimediaRedirectVersion",
    "TeamsClientVersion",
    "HostOSVersion",
    "HostSxSStackVersion",
    "HostAgentVersion",
    "PolicyName",
    "UserSettingName",
    "HostRegion",
    "AzureNetworkConnectName"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK

{
  "TotalRowCount": 1,
  "Schema": [
    {
      "Column": "ManagedDeviceName",
      "PropertyType": "String"
    },
    {
      "Column": "DeviceId",
      "PropertyType": "String"
    },
    {
      "Column": "ClientOS",
      "PropertyType": "String"
    },
    {
      "Column": "ClientVersion",
      "PropertyType": "String"
    },
    {
      "Column": "MultimediaRedirectVersion",
      "PropertyType": "String"
    },
    {
      "Column": "TeamsClientVersion",
      "PropertyType": "String"
    },
    {
      "Column": "HostOSVersion",
      "PropertyType": "String"
    },
    {
      "Column": "HostOSVersion",
      "PropertyType": "String"
    },
    {
      "Column": "HostSxSStackVersion",
      "PropertyType": "String"
    },
    {
      "Column": "HostAgentVersion",
      "PropertyType": "String"
    },
    {
      "Column": "PolicyName",
      "PropertyType": "String"
    },
    {
      "Column": "UserSettingName",
      "PropertyType": "String"
    },
    {
      "Column": "HostRegion",
      "PropertyType": "String"
    },
    {
      "Column": "AzureNetworkConnectName",
      "PropertyType": "String"
    }
  ],
  "Values": [
    [
      "CPC_96718d38-74ef-4026-8d54-508d52901763",
      "96718d38-74ef-4026-8d54-508d52901763",
      "Windows 10",
      "2.0.02817.898",
      "1.0.2311.2004",
      "1.7.00.26062",
      "10.0.22631.4169",
      "rdp-sxs240705700",
      "1.0.9742.1900_release",
      "zengyantestPolicy",
      "mingjunTest",
      "eastus",
      "CRUD_TestIntuneAdminWSubReader"
    ]
  ]
}