cloudPcReports: getConnectionQualityReports

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 die allgemeinen Verbindungsqualitätsberichte für alle Geräte innerhalb eines aktuellen Mandanten während eines bestimmten Zeitraums ab, einschließlich Metriken wie der durchschnittlichen Roundtripzeit (P50), der durchschnittlichen verfügbaren Bandbreite und dem Udp-Verbindungsprozentsatz. Rufen Sie auch andere Echtzeitmetriken ab, z. B. den Zeitpunkt der letzten Verbindungsrunde, die Client-IP-Adresse der letzten Verbindung, das letzte Verbindungsgateway und das letzte Verbindungsprotokoll.

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

Globaler Dienst	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	❌	❌	❌

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. 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/getConnectionQualityReports

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über die 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 mit dieser Aktion verwendet werden können.

Parameter	Typ	Beschreibung
filter	Zeichenfolge	OData-Syntax $filter . Unterstützte Filter sind: and, or, lt, le, gt, geund eq.
Groupby	Zeichenfolgenauflistung	Geben Sie an, wie die Berichte gruppiert werden sollen. Wenn verwendet, muss derselbe Inhalt wie der select-Parameter aufweisen.
Orderby	Zeichenfolgenauflistung	Geben Sie an, wie die Berichte sortiert werden sollen.
search	Zeichenfolge	Gibt eine zu durchsuchende Zeichenfolge an.
select	Zeichenfolgensammlung	OData-Syntax $select . Die ausgewählten Spalten der Berichte.
skip	Int32	Anzahl der zu überspringenden Datensätze.
Nach oben	Int32	Die Anzahl der wichtigsten Datensätze, die zurückgegeben werden sollen.

Antwort

Bei erfolgreicher Ausführung gibt diese Aktion einen 200 OK Antwortcode und einen Stream im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

{
  "filter": "EventDateTime gt datetime'2023-04-16T07:40:41.694Z'",
  "search": "",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "LastActiveTime"
  ],
  "skip": "0",
  "top": "25",
  "orderBy": []
}

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": 3,
  "Schema": [
    {
      "Column": "CloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "ManagedDeviceName",
      "PropertyType": "String"
    },
    {
      "Column": "AvgRoundTripTimeInMsP50",
      "PropertyType": "Double"
    },
    {
      "Column": "LastConnectionRoundTripTimeInMs",
      "PropertyType": "Double"
    },
    {
      "Column": "AvgAvailableBandwidthInMBpsP50",
      "PropertyType": "Double"
    },
    {
      "Column": "LastConnectionAvailableBandWidthInMSps",
      "PropertyType": "Double"
    },
    {
      "Column": "AvgRemoteSignInTimeInSecP50",
      "PropertyType": "Double"
    },
    {
      "Column": "UDPConnectionPercentage",
      "PropertyType": "Double"
    },
    {
      "Column": "LastConnectionGateway",
      "PropertyType": "String"
    },
    {
      "Column": "LastConnectionProtocol",
      "PropertyType": "String"
    },
    {
      "Column": "LastActiveTime",
      "PropertyType": "DateTime"
    }
  ],
  "Values": [
    [
      "1", "f5ff445f-7488-40f8-8ab9-ee784a9c1f33", "Cloud PC-Ana Bowman", "110", "90", "0.32", "0.41", "10.15", "0.80", "East US 2", "192.168.1.01", "UDP (STUN)", "2023-04-17T00:00:00Z"
    ],
    [
      "1", "f5ff445f-7488-40f8-8ab9-ee784a9c1f33", "Cloud PC-Isabel Bowman", "201", "72", "1.22", "1.7", "10.37", "0.62", "West US 3", "192.168.1.02", "UDP (STUN)", "2023-04-18T00:00:00Z"
    ],
    [
      "1", "f5ff445f-7488-40f8-8ab9-ee784a9c1f33", "Cloud PC-Mary Bowman", "213", "200", "1.74", "0.88", "12.35", "0.45", "East US 2", "192.168.1.03", "TCP", "2023-04-19T00:00:00Z"
    ]
  ]
}