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

Получение аналитических сведений о подписках с фильтрацией по поисковому запросу

  • Мақала

Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government

Как получить сведения об аналитике подписок для клиентов, отфильтрованных по поисковому запросу.

Необходимые компоненты

Запрос REST

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

Способ URI запроса
GET {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

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

Используйте следующий обязательный параметр пути для идентификации организации и фильтрации поиска.

Имя. Type Обязательно Описание
filter_string строка Да Фильтр для применения к аналитике подписки. См. разделы "Синтаксис фильтра" и "Фильтрация полей" для синтаксиса, полей и операторов, используемых в этом параметре.

Синтаксис выражений фильтрации

Параметр фильтра должен быть составлен в виде ряда сочетаний полей, значений и операторов. Несколько сочетаний можно объединить с помощью and или or операторов.

Пример без кода выглядит следующим образом:

  • String: ?filter=Field operator 'Value'.
  • Логическое значение: ?filter=Field operator Value
  • Содержит ?filter=contains(field,'value')

Поля фильтра

Параметр фильтра запроса содержит одну или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит поле и значение, связанное с eq операторами или ne операторами. Некоторые поля также поддерживают containsоператоры , gt, ltgeи le операторы. Операторы могут объединяться с помощью операторов или or операторовand.

Ниже приведены примеры строк фильтра:

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

В следующей таблице показан список поддерживаемых полей и операторов поддержки для параметра фильтра. Строковые значения должны быть окружены одними кавычками.

Параметр Поддерживаемые операторы Description
autoRenewEnabled eq, ne Значение, указывающее, обновляется ли подписка автоматически.
commitmentEndDate eq, , neltgtge,le Дата окончания подписки.
creationDate eq, , neltgtge,le Дата создания подписки.
currentStateEndDate eq, , neltgtge,le Дата изменения текущего состояния подписки.
customerMarket eq, ne Страна или регион, в который работает клиент.
customerName contains Имя клиента.
customerTenantId eq, ne Строка с форматом GUID, определяющая клиент клиента.
deprovisionedDate eq, , neltgtge,le Дата отзыва подписки. По умолчанию используется значение NULL.
effectiveStartDate eq, , neltgtge,le Дата начала подписки.
friendlyName contains Имя подписки.
id eq, ne Строка в формате GUID, определяющая подписку.
lastRenewalDate eq, , neltgtge,le Дата последнего продления подписки. По умолчанию используется значение NULL.
LastUsageDate eq, , neltgtge,le Дата последнего использования подписки. По умолчанию используется значение NULL.
partnerId eq, ne The PartnerID. Для прямого торгового посредника это значение является PartnerID партнера. Для косвенного торгового посредника это значение является PartnerID косвенного торгового посредника.
partnerName строка Имя партнера, для которого была приобретена подписка
productName contains, , eqne Название продукта.
Providername строка Если транзакция подписки для косвенного торгового посредника, имя поставщика является косвенным поставщиком, который купил подписку.
статус eq, ne Состояние подписки. Поддерживаемые значения: ACTIVE, SUSPENDED или DEPROVISIONED.
subscriptionType eq, ne Тип подписки. Примечание. Это поле учитывает регистр. Поддерживаемые значения: Office, Azure, Microsoft365, Dynamics, EMS.
trialStartDate eq, , neltgtge,le Дата начала пробного периода подписки. По умолчанию используется значение NULL.
trialToPaidConversionDate eq, , neltgtge,le Дата преобразования подписки из пробной версии в платную. По умолчанию используется значение NULL.

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

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

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

Нет.

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

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
Content-Type: application/json
Content-Length: 0

Ответ REST

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

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

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

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

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123

{
    "customerTenantId": "735920EB-A564-4C72-9FE5-52632562712C",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
    "friendlyName": "MICROSOFT AZURE",
    "creationDate": "2017-06-02T23:11:58.747",
    "effectiveStartDate": "2017-06-02T00:00:00",
    "commitmentEndDate": null,
    "currentStateEndDate": null,
    "trialToPaidConversionDate": null,
    "trialStartDate": null,
    "trialEndDate": null,
    "lastUsageDate": null,
    "deprovisionedDate": null,
    "lastRenewalDate": null,
    "licenseCount": 0
}

См. также