Создание cloudPcExportJob

  • Статья

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

Важно!

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

Создайте ресурс cloudPcExportJob , чтобы инициировать скачивание всей или указанной части отчета.

Используйте операцию GET cloudPcExportJob , чтобы проверить свойство exportJobStatus ресурса cloudPcExportJob . Если результат свойства равен completed, отчет завершается скачивание в расположение, указанное свойством exportUrl .

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

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

Разрешения

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

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

HTTP-запрос

POST /deviceManagement/virtualEndpoint/reports/exportJobs

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

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

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

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

При создании cloudPcExportJob можно указать следующие свойства.

Свойство Тип Описание
filter String Фильтр, примененный к отчету. Необязательный параметр.
format String Формат экспортированного отчета. Необязательный параметр.
reportName cloudPcReportName Имя отчета. Возможные значения: remoteConnectionHistoricalReports, , dailyAggregatedRemoteConnectionReports, totalAggregatedRemoteConnectionReportssharedUseLicenseUsageReport, sharedUseLicenseUsageRealTimeReport, , unknownFutureValue, noLicenseAvailableConnectivityFailureReport, frontlineLicenseUsageReport, frontlineLicenseUsageRealTimeReport, remoteConnectionQualityReports, . inaccessibleCloudPcReports Необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующие значения в этом развиваемом перечислении: noLicenseAvailableConnectivityFailureReport, frontlineLicenseUsageReport, frontlineLicenseUsageRealTimeReport, . inaccessibleCloudPcReports
select Коллекция строк Выбранные столбцы отчета. Необязательный параметр.

Отклик

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

Примеры

Пример 1. Создание задания экспорта для скачивания отчета TotalAggregatedRemoteConnectionReports

В следующем примере показано, как создать задание экспорта для скачивания TotalAggregatedRemoteConnectionReports отчета.

Запрос

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

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

{
  "reportName": "TotalAggregatedRemoteConnectionReports",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "DaysSinceLastSignIn",
    "TotalUsageInHour"
  ]
}

Отклик

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/reports/exportJobs/$entity",
  "id": "TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff",
  "reportName": "totalAggregatedRemoteConnectionReports",
  "filter": null,
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "DaysSinceLastSignIn",
    "TotalUsageInHour"
  ],
  "format": null,
  "expirationDateTime": "0001-01-01T00:00:00Z",
  "requestDateTime": "2022-09-16T12:00:06.5137388Z",
  "exportJobStatus": "inProgress",
  "exportUrl": null
}

Пример 2. Создание задания экспорта для скачивания отчета RemoteConnectionQualityReports.

В следующем примере показано, как создать задание экспорта для скачивания RemoteConnectionQualityReports отчета.

Запрос

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

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

{
  "reportName": "RemoteConnectionQualityReports",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "EventDateTime"
  ],
  "filter": "EventDateTime gt datetime'2023-06-14T07:40:41.694Z'"
}

Отклик

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/virtualEndpoint/reports/exportJobs/$entity",
  "id": "RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330",
  "reportName": "remoteConnectionQualityReports",
  "filter": "EventDateTime gt datetime'2023-06-14T07:40:41.694Z'",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "AvgRoundTripTimeInMsP50",
    "LastConnectionRoundTripTimeInMs",
    "AvgAvailableBandwidthInMBpsP50",
    "LastConnectionAvailableBandWidthInMSps",
    "AvgRemoteSignInTimeInSecP50",
    "UDPConnectionPercentage",
    "LastConnectionGateway",
    "LastConnectionProtocol",
    "EventDateTime"
  ],
  "format": null,
  "expirationDateTime": null,
  "requestDateTime": "2023-06-14T07:40:41.694Z",
  "exportJobStatus": "inProgress",
  "exportUrl": null
}