cloudPcReports: getRealTimeRemoteConnectionLatency

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the real-time connection latency information for a Cloud PC.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) CloudPC.Read.All, CloudPC.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application CloudPC.Read.All, CloudPC.ReadWrite.All

HTTP request

GET /deviceManagement/virtualEndpoint/reports/getRealTimeRemoteConnectionLatency(cloudPcId='id')

Function parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description
cloudPcId String The ID of the Cloud PC.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a Stream in the response body.

Examples

Request

The following is an example of a request.

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getRealTimeRemoteConnectionLatency(cloudPcId='f5ff445f-7488-40f8-8ab9-ee784a9fffff')

Response

The following is an example of the response

Note: The response object shown here might be shortened for readability.

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

{
    "TotalRowCount": 1,
    "Schema": [
        {
            "Column": "CloudPcId",
            "PropertyType": "String"
        },
        {
            "Column": "ManagedDeviceName",
            "PropertyType": "String"
        },
        {
            "Column": "RoundTripTimeInMs",
            "PropertyType": "Double"
        },
        {
            "Column": "AvailableBandwidthInMBps",
            "PropertyType": "Double"
        },
        {
            "Column": "RemoteSignInTimeInSec",
            "PropertyType": "Double"
        }
    ],
    "Values": [
        [
            "40f9315c-5b63-4126-9f89-b7dcb14569a8",
            "CPC-DisplayName",
            305.0,
            1.9375,
            11.911
        ]
    ]
}