Obtener la información de análisis de las suscripciones, según las consultas de búsqueda

  • Artículo

Se aplica a: Centro de partners | Centro de partners operado por 21Vianet | Centro de partners para Microsoft Cloud for US Government

Cómo obtener información de análisis de suscripciones para los clientes filtrados por una consulta de búsqueda.

Requisitos previos

Solicitud REST

Sintaxis de la solicitud

Método URI de solicitud
GET {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

Parámetros del identificador URI

Use el siguiente parámetro de ruta de acceso necesario para identificar la organización y filtrar la búsqueda.

Nombre Type Obligatorio Descripción
filter_string string Sí Filtro que se va a aplicar al análisis de suscripciones. Consulte las secciones Sintaxis de filtro y Campos de filtro para ver la sintaxis, los campos y los operadores que se van a usar en este parámetro.

Sintaxis de filtro

El parámetro de filtro debe estar compuesto como una serie de combinaciones de campos, valores y operadores. Se pueden combinar varias combinaciones mediante and operadores o or .

Un ejemplo sin codificar tiene este aspecto:

  • Cadena: ?filter=Field operator 'Value'
  • Booleano: ?filter=Field operator Value
  • Contiene ?filter=contains(field,'value')

Campos de filtro

El parámetro filter de la solicitud contiene una o varias instrucciones que filtran las filas de la respuesta. Cada instrucción contiene un campo y un valor que están asociados a los eq operadores o ne . Algunos campos también admiten los containsoperadores , gt, lt, gey le . Las instrucciones se pueden combinar mediante and operadores o or .

A continuación se muestran ejemplos de cadenas de filtro:

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

En la tabla siguiente se muestra una lista de los campos admitidos y operadores de compatibilidad para el parámetro filter. Los valores de cadena deben estar rodeados de comillas simples.

Parámetro Operadores admitidos Descripción
autoRenewEnabled eq, ne Valor que indica si la suscripción se renueva automáticamente.
commitmentEndDate eq, ne, gt, lt, , ge, le Fecha en que finaliza la suscripción.
creationDate eq, ne, gt, lt, , ge, le Fecha en que se creó la suscripción.
currentStateEndDate eq, ne, gt, lt, , ge, le Fecha en que cambiará el estado actual de la suscripción.
customerMarket eq, ne País o región en el que el cliente realiza el negocio.
customerName contains El nombre del cliente.
customerTenantId eq, ne Cadena con formato GUID que identifica el inquilino del cliente.
desaprovisionedDate eq, ne, gt, lt, , ge, le Fecha en que se desaprovisionó la suscripción. El valor predeterminado es null.
effectiveStartDate eq, ne, gt, lt, , ge, le Fecha en que se inicia la suscripción.
friendlyName contains Nombre de la suscripción.
id eq, ne Cadena con formato de GUID que identifica la suscripción.
lastRenewalDate eq, ne, gt, lt, , ge, le Fecha en que se renueve por última vez la suscripción. El valor predeterminado es null.
lastUsageDate eq, ne, gt, lt, , ge, le Fecha en que se usó la suscripción por última vez. El valor predeterminado es null.
PartnerId eq, ne The PartnerID. Para un revendedor directo, este valor es partnerID del asociado. Para un revendedor indirecto, este valor es el PartnerID del revendedor indirecto.
partnerName string Nombre del asociado para el que se compró la suscripción
productName contains, , eq, ne El nombre del producto.
providerName string Cuando la transacción de suscripción es para el revendedor indirecto, el nombre del proveedor es el proveedor indirecto que compró la suscripción.
status eq, ne Estado de la suscripción. Los valores admitidos son: ACTIVE, SUSPENDED o DEPROVISIONED.
subscriptionType eq, ne Tipo de suscripción. Nota: Este campo distingue mayúsculas de minúsculas. Los valores admitidos son: Office, Azure, Microsoft365, Dynamics, EMS.
trialStartDate eq, ne, gt, lt, , ge, le Fecha en que se inició el período de prueba de la suscripción. El valor predeterminado es null.
trialToPaidConversionDate eq, ne, gt, lt, , ge, le Fecha en la que la suscripción se convierte de prueba a pago. El valor predeterminado es null.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

Ninguno.

Ejemplo de solicitud

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

Respuesta REST

Si se ejecuta correctamente, el cuerpo de la respuesta contiene una colección de recursos de suscripción que cumplen los criterios de filtro.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica información de éxito o error y depuración. Use una herramienta de seguimiento de red para leer este código, tipo de error y otros parámetros. Para obtener la lista completa, consulte Códigos de error.

Ejemplo de respuesta

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
}

Consulte también