Получение cloudPcExportJob

  • Статья

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

Важно!

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

Чтение свойств и связей объекта cloudPcExportJob .

Вы можете скачать отчет, сначала создав новый ресурс cloudPcExportJob для начала скачивания.

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

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

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

Разрешения

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

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

Следующие разрешения на портале администрирования Облачного компьютера предоставляют доступ к определенным типам отчетов:

  • ActionStatus/Read
  • DeviceRecommendation/Read
  • CrossRegionDisasterRecovery/Read
  • FrontlineReports/Read
  • InaccessibleReports/Read
  • PerformanceReports/Read

HTTP-запрос

GET /deviceManagement/virtualEndpoint/reports/exportJobs/{cloudPcExportJobId}

Необязательные параметры запросов

Этот метод поддерживает некоторые параметры запросов OData для настройки отклика. Общие сведения см. в статье Параметры запроса OData.

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

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

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

Не указывайте текст запроса для этого метода.

Отклик

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

Примеры

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

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

Запрос

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

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/exportJobs/TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff

Отклик

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "#microsoft.graph.cloudPcExportJob",
    "id": "TotalAggregatedRemoteConnectionReports__d39979c9-a0a2-4916-a158-1b984742ffff",
    "reportName": "totalAggregatedRemoteConnectionReports",
    "format": "csv",
    "select": ["CloudPcId", "ManagedDeviceName", "UserPrincipalName", "DaysSinceLastSignIn", "TotalUsageInHour"],
    "filter": null,
    "requestDateTime": "2022-09-16T12:00:06.5137388Z",
    "expirationDateTime": "0001-01-01T00:00:00Z",
    "exportJobStatus": "completed",
    "exportUrl": "https://westus01repexpstorage.blob.core.windows.net/599fe3a3-0285-4e7f-9c83-ffdf37914e27/remoteConnectionEvents_af34378a-cf5a-418d-b735-54b0ee155118.zip"
  }
}

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

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

Запрос

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

GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/exportJobs/RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330

Отклик

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "#microsoft.graph.cloudPcExportJob",
    "id": "RemoteConnectionQualityReports__85678957-6202-4e29-97e6-eb26ef07f330",
    "reportName": "remoteConnectionQualityReports",
    "format": "csv",
    "select": ["CloudPcId", "ManagedDeviceName", "UserPrincipalName", "DaysSinceLastSignIn", "TotalUsageInHour"],
    "filter": null,
    "requestDateTime": "2023-06-14T07:40:41.694Z",
    "expirationDateTime": "",
    "exportJobStatus": "completed",
    "exportUrl": "https://westus01repexpstorage.blob.core.windows.net/599fe3a3-0285-4e7f-9c83-ffdf37914e27/remoteConnectionHistoricalReports_af34378a-cf5a-418d-b735-54b0ee155118.zip"
  }
}