Получение сведений о развертывании лицензий

Мақала
03/06/2024

Получение сведений о развертывании для лицензий Office и Dynamics.

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

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

Запрос REST

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

Метод	Универсальный код ресурса (URI) запроса
GET	{baseURL}/v1/analytics/commercial/deployment/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=serviceCode eq 'O365' filter=serviceCode eq 'O365' or (channel eq 'Reseller') Можно указать следующие поля: serviceCode serviceName channel customerTenantId customerName productId Productname	Нет
groupby	строка	Выражение, которое применяет агрегирование данных только к указанным полям. Можно указать следующие поля: serviceCode serviceName channel customerTenantId customerName productId Productname Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , и следующие: licensesDeployed licensesSold	Нет
processedDateTime	Дата и время	Можно указать дату обработки данных об использовании. По умолчанию используется последняя дата обработки данных.	Нет

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

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/deployment/license?filter=customerTenantId%20eq%20%270112A436-B14E-4888-967B-CA4BB2CF1234%27 HTTP 1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Ответ REST

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

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

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

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

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

HTTP/1.1 200 OK
Content-Length: 487
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
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",
      "serviceCode": "crm",
      "serviceName": "Microsoft Dynamics",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "54B84594-9C77-4499-8D65-5E0D5F410E78",
      "productName": "DYNAMICS AX TASK",
      "licensesDeployed": 0,
      "licensesSold": 9
    },
    {
      "processedDateTime": "2018-10-14T00:00:00",
      "serviceCode": "o365",
      "serviceName": "Microsoft Office 365",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "D3B4FE1F-9992-4930-8ACB-CA6EC609365E",
      "productName": "DOMESTIC AND INTERNATIONAL CALLING PLAN",
      "licensesDeployed": 0,
      "licensesSold": 5
    }
],
  "@nextLink": null,
  "TotalCount": 2
}

Бөлісу құралы: