reportRoot: getOffice365ServicesUserCounts

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

Важно!

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

Узнайте, сколько пользователей были активны и неактивны в каждой службе.

Примечание. Подробные сведения о различных представлениях и названиях отчетов см. в статье Отчеты Microsoft 365 — Активные Пользователи.

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

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

Разрешения

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

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

Примечание. Чтобы делегированные разрешения разрешали приложениям читать отчеты об использовании служб от имени пользователя, администратор клиента должен назначить пользователю соответствующую ограниченную роль администратора Microsoft Entra ID. Дополнительные сведения см. в разделе Авторизация api для чтения отчетов об использовании Microsoft 365.

HTTP-запрос

GET /reports/getOffice365ServicesUserCounts(period='{period_value}')

Параметры функции

В URL-адресе запроса укажите приведенный ниже параметр и действительное значение.

Параметр	Тип	Описание
period	string	Указывает отчетный период. Поддерживаемые значения {period_value}: D7, D30, D90 и D180. Эти значения указываются в формате Dn, где n — количество дней в отчетном периоде. Обязательный.

Этот метод поддерживает $formatпараметр запроса OData для настройки ответа. Тип выходных данных по умолчанию — text/csv. Однако если вы хотите указать тип выходных данных, можно использовать параметр запроса OData $format, для которого задано значение text/csv или application/json.

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

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

Отклик

CSV

В случае успешного выполнения этот метод возвращает отклик 302 Found, который перенаправляет на URL-адрес, для которого выполнена предварительная аутентификация, для скачивания отчета. Этот URL-адрес можно найти в заголовке Location отклика.

URL-адреса загрузки с предварительной проверкой подлинности действительны только в течение короткого периода времени (несколько минут) и не требуют заголовка Authorization .

CSV-файл содержит столбцы со следующими заголовками:

• Report Refresh Date (дата обновления отчета)
• Exchange Active (активны в Exchange)
• Exchange Inactive (неактивны в Exchange)
• OneDrive Active (активны в OneDrive)
• OneDrive Inactive (неактивны в OneDrive)
• SharePoint Active (активны в SharePoint)
• SharePoint Inactive (неактивны в SharePoint)
• Skype For Business Active (активны в Skype для бизнеса)
• Skype For Business Inactive (неактивны в Skype для бизнеса)
• Yammer Active (активны в Yammer)
• Yammer Inactive (неактивны в Yammer)
• Teams Active (активны в Teams)
• Teams Inactive (неактивны в Teams)
• Office 365 Active
• Неактивный Office 365
• "Report Period" (Отчетный период).

Следующие столбцы не поддерживаются в Microsoft Graph для Китая, управляемом 21Vianet:

• Yammer Active (активны в Yammer)
• Yammer Inactive (неактивны в Yammer)
• Teams Active (активны в Teams)
• Teams Inactive (неактивны в Teams)

JSON

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

Следующие свойства объекта office365ServicesUserCounts не поддерживаются в Microsoft Graph для Китая под управлением 21Vianet:

• yammerActive
• yammerInactive
• teamsActive
• teamsInactive

Пример

CSV

Ниже приведен пример вывода CSV-файла.

Запрос

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

GET https://graph.microsoft.com/beta/reports/getOffice365ServicesUserCounts(period='D7')?$format=text/csv

Отклик

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

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Следуйте перенаправлению 302 и CSV-файл, который загружается, имеет следующую схему.

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

Report Refresh Date,Exchange Active,Exchange Inactive,OneDrive Active,OneDrive Inactive,SharePoint Active,SharePoint Inactive,Skype For Business Active,Skype For Business Inactive,Yammer Active,Yammer Inactive,Teams Active,Teams Inactive,Office 365 Active,Office 365 Inactive,Report Period

JSON

Ниже приведен пример, возвращающий JSON.

Запрос

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

GET https://graph.microsoft.com/beta/reports/getOffice365ServicesUserCounts(period='D7')?$format=application/json

Отклик

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365ServicesUserCounts)", 
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "exchangeActive": 2591, 
      "exchangeInactive": 1426, 
      "oneDriveActive": 1800, 
      "oneDriveInactive": 2451, 
      "sharePointActive": 2286, 
      "sharePointInactive": 1815, 
      "skypeForBusinessActive": 2463, 
      "skypeForBusinessInactive": 1947, 
      "yammerActive": 473, 
      "yammerInactive": 2526, 
      "teamsActive": 846, 
      "teamsInactive": 1960, 
      "office365Active": 2791,
      "office365Inactive": 503,
      "reportPeriod": "7"
    }
  ]
}