Freigeben über

cloudPcReports: retrieveCloudPcTenantMetricsReport

  • Artikel

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.

Rufen Sie einen Bericht zur Leistung von Cloud-PCs ab.

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.Read.All CloudPC.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung CloudPC.Read.All CloudPC.ReadWrite.All

HTTP-Anforderung

POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport

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 der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die Sie mit dieser Methode verwenden können.

Parameter Typ Beschreibung
filter Zeichenfolge OData-Syntax $filter . Unterstützte Filter sind: and, or, gtund eq.
groupBy String collection Gibt an, wie die Berichte gruppiert werden. Wenn verwendet, muss der gleiche Inhalt wie der Select-Parameter aufweisen.
orderBy Zeichenfolgensammlung Gibt an, wie die Berichte sortiert werden.
reportName cloudPCPerformanceReportName Der Berichtsname. Die möglichen Werte sind: performanceTrendReport, unknownFutureValue, cloudPcInsightReport. Verwenden Sie den Anforderungsheader Prefer: include-unknown-enum-members , um den folgenden Wert in dieser verteilbaren Enumeration abzurufen: cloudPcInsightReport.
search Zeichenfolge Gibt eine zu durchsuchende Zeichenfolge an.
select String collection OData-Syntax $select . Die ausgewählten Spalten der Berichte.
skip Int32 Anzahl der zu überspringenden Datensätze.
Nach oben Int32 Gibt die Seitengröße an. Wenn nicht definiert, ist der Standardwert 25 mit einem maximalen Wert von 100.

Antwort

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und ein Stream -Objekt im Antworttext zurückgegeben.

Beispiele

Beispiel 1: Abrufen eines Leistungstrendberichts

Das folgende Beispiel zeigt, wie Sie den Leistungstrendbericht mit täglich aggregierten Daten abrufen, der eine Liste der Verbindungsqualitätsmetriken für Cloud-PCs in den letzten sieben Tagen innerhalb eines Mandanten bereitstellt.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

Beispiel 2: Abrufen eines Cloud-PC-Erkenntnisberichts

Das folgende Beispiel zeigt, wie Sie den Cloud-PC-Erkenntnisbericht abrufen, der Konfigurationsdaten und Erkenntnisse auf Cloud-PC-Ebene bereitstellt.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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