cloudPcReports: retrieveCloudPcTenantMetricsReport

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите отчет, связанный с производительностью облачных компьютеров.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	CloudPC.Read.All	CloudPC.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	CloudPC.Read.All	CloudPC.ReadWrite.All

HTTP-запрос

POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление параметров в формате JSON.

В следующей таблице показаны параметры, которые можно использовать с этим методом.

Параметр	Тип	Описание
filter	String	Синтаксис OData $filter . Поддерживаемые фильтры: and, or, gtи eq.
groupBy	Коллекция строк	Указывает, как группировать отчеты. Если используется, содержимое должно совпадать с параметром select .
orderBy	Коллекция строк	Указывает способ сортировки отчетов.
reportName	cloudPCPerformanceReportName	Имя отчета. Допустимые значения: performanceTrendReport, unknownFutureValue, cloudPcInsightReport. Prefer: include-unknown-enum-members Используйте заголовок запроса, чтобы получить следующее значение в этой развиваемой перечислении: cloudPcInsightReport.
search	String	Указывает строку для поиска.
select	Коллекция строк	Синтаксис OData $select . Выбранные столбцы отчетов.
skip	Int32	Количество записей, которые нужно пропустить.
top	Int32	Задает размер страницы. Если значение не определено, по умолчанию используется значение 25 с максимальным значением 100.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект Stream в теле отклика.

Примеры

Пример 1. Получение отчета о тенденциях производительности

В следующем примере показано, как получить отчет о тенденциях производительности с ежедневными агрегированными данными, которые предоставляют список метрик качества подключения для облачных компьютеров за последние семь дней в клиенте.

Запрос

Ниже показан пример запроса.

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
}

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

Пример 2. Получение аналитического отчета об облачном компьютере

В следующем примере показано, как получить аналитический отчет об облачном компьютере, который предоставляет данные конфигурации и аналитические сведения на уровне облачного компьютера.

Запрос

Ниже показан пример запроса.

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
}

Отклик

Ниже приводится пример отклика.

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