cloudPcReports: getActionStatusReports

  • Статья

Пространство имен: 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/getActionStatusReports

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

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

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

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

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

Параметр Тип Описание
filter String Синтаксис OData $filter . Поддерживаемые фильтры: and, or, gt ,ge и eq.
Groupby Коллекция строк Указывает, как группировать отчеты. Если используется, содержимое должно совпадать с параметром select .
Orderby Коллекция строк Задает порядок по имени столбцов. Столбец orderBy по умолчанию — RequestDateTime.
search String Указывает строку для поиска.
select Коллекция строк Синтаксис OData $select . Выбранные столбцы отчетов.
skip Int32 Количество записей, которые нужно пропустить.
top Int32 Количество возвращаемых верхних записей. Если значение не указано, ограничение по умолчанию — 25, максимум 100.

Отклик

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

Примеры

Запрос

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

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

{
  "filter": "ActionState eq 'failed'",
  "select": [
    "Id",
    "CloudPcDeviceDisplayName",
    "BulkActionId",
    "BulkActionDisplayName",
    "CloudPcId",
    "InitiatedByUserPrincipalName",
    "DeviceOwnerUserPrincipalName",
    "Action",
    "ActionState",
    "RequestDateTime",
    "LastUpdatedDateTime",
    "ActionParameters"
  ],
  "skip": 0,
  "top": 50
}

Отклик

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

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

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

{
  "TotalRowCount": 1,
  "Schema": [
    {
      "Column": "Id",
      "PropertyType": "String"
    },
    {
      "Column": "CloudPcDeviceDisplayName",
      "PropertyType": "String"
    },
    {
      "Column": "BulkActionId",
      "PropertyType": "String"
    },
    {
      "Column": "BulkActionDisplayName",
      "PropertyType": "String"
    },
    {
      "Column": "CloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "InitiatedByUserPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "DeviceOwnerUserPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "Action",
      "PropertyType": "String"
    },
    {
      "Column": "ActionState",
      "PropertyType": "String"
    },
    {
      "Column": "RequestDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "LastUpdatedDateTime",
      "PropertyType": "DateTime"
    },
    {
      "Column": "ActionParameters",
      "PropertyType": "Json"
    }
  ],
  "Values": [
    [
      "662009bc-7732-4f6f-8726-25883518b33e",
      "CloudPC-Connie",
      "bdc8e6dd-0455-4412-83d9-c818664fe1f1",
      "Resize to 64GB RAM - John",
      "bdc8e6dd-0455-4412-83d9-c818664fe1f1",
      "john@contoso.com",
      "connie@contoso.com",
      "Resize",
      "failed",
      "2020-07-23T10:10:57Z",
      "2023-07-23T18:14:34Z",
      {
        "targetServicePlanId": "3bba9856-7cf2-4396-904a-00de74fba3a4"
      }
    ]
  ]
}