Получение сведений об использовании лицензий

Статья
05/31/2024

Сведения об использовании лицензий на уровне рабочей нагрузки для Office и Dynamics.

Предварительные условия

Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности с использованием учетных данных приложений и пользователей.

Запрос REST

Синтаксис запроса

Метод	Универсальный код ресурса (URI) запроса
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

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

Дополнительные сведения см. в статье о заголовках REST Центра партнеров.

Параметры универсального кода ресурса (URI)

Параметр	Тип	Описание	Обязательно
top	строка	Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию (если параметр не указан) — 10 000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данных	Нет
skip	INT	Количество строк, пропускаемых в запросе. Используйте этот параметр для постраничного перемещения по большим наборам данных. Например, при top=10000 и skip=0 извлекаются первые 10 000 строк данных; при top=10000 и skip=10000 извлекаются следующие 10 000 строк данных и т. д.	Нет
фильтр	строка	Параметр filter запроса содержит один или несколько операторов, фильтрующих строки в ответе. Каждая инструкция содержит поле и значение, связанные с операторами `eq` или `ne` , а операторы можно объединять с помощью `and` или `or`. Несколько примеров параметров filter: filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' или (channel eq 'Reseller') Можно указать следующие поля: workloadCode имя рабочей нагрузки serviceCode serviceName channel customerTenantId customerName productId Productname	Нет
groupby	строка	Выражение, которое применяет агрегирование данных только к указанным полям. Можно указать следующие поля: workloadCode имя рабочей нагрузки serviceCode serviceName channelcustomerTenantId customerName productId Productname Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , и следующие: licensesActive licensesQualified	Нет
processedDateTime	Дата и время	Можно указать дату обработки данных об использовании. По умолчанию используется последняя дата обработки данных.	Нет

Пример запроса

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/usage/license?filter=customerTenantId%20eq%20%27aaaabbbb-0000-cccc-1111-dddd2222eeee%27 HTTP 1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Ответ REST

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

Поле	Тип	Описание
workloadCode	строка	Код рабочей нагрузки
имя рабочей нагрузки	строка	Имя рабочей нагрузки
serviceCode	строка	код службы.
serviceName	строка	Имя службы
channel	строка	Название канала, торговый посредник
customerTenantId	строка	Уникальный идентификатор клиента
customerName	строка	имя пользователя;
productId	строка	Уникальный идентификатор продукта
productName	строка	Название продукта
licensesActive	long	Количество активных лицензий на рабочую нагрузку
licensesQualified	long	Количество квалифицированных лицензий для рабочей нагрузки
processedDateTime	Дата и время	Дата последней обработки данных

Коды успешного выполнения и ошибок в ответе

Каждый ответ сопровождается кодом состояния HTTP, обозначающим успешное или неудачное выполнение, и дополнительными сведениями для отладки. Используйте средство трассировки сети, чтобы просматривать этот код, тип ошибки и дополнительные параметры. Полный список ответов есть в статье Коды ошибок REST в Центре партнеров.

Пример ответа

HTTP/1.1 200 OK
Content-Length: 487
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CV: f0trvmq8mEScHcFS.0
MS-ServerId: 4
Date: Wed, 24 Oct 2018 22:37:18 GMT

{
"Value": [
    {
      "processedDateTime": "2018-10-14T00:00:00",
      "workloadCode": "SPO",
      "workloadName": "SharePoint",
      "serviceCode": "o365",
      "serviceName": "Microsoft Office 365",
      "channel": "reseller",
      "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "customerName": "TEST COMPANY",
      "productId": "6FD2C87F-B296-42F0-B197-1E91E994B900",
      "productName": "OFFICE 365 ENTERPRISE E3",
      "licenseActive": 0,
      "licensesQualified": 1
    },
    {
      "processedDateTime": "2018-10-14T00:00:00",
      "workloadCode": "EXO",
      "workloadName": "Exchange",
      "serviceCode": "o365",
      "serviceName": "Microsoft Office 365",
      "channel": "reseller",
      "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "customerName": "TEST COMPANY",
      "productId": "45A2423B-E884-448D-A831-D9E139C52D2F",
      "productName": "EXCHANGE ONLINE PROTECTION",
      "licenseActive": 0,
      "licensesQualified": 1
    }
}

Поделиться через