Compartir a través de

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

Se aplica a: Centro de asociados | Centro de asociados operado por 21Vianet | Centro de asociados para la Nube de Microsoft para el Gobierno de los EE. UU.

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

Prerrequisitos

Solicitud REST

Sintaxis de la solicitud

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

Parámetros de URI

Utilice el siguiente parámetro de ruta requerido para identificar su organización y filtrar la búsqueda.

Nombre Tipo Obligatorio Descripción
filter_string cuerda / cadena Sí El filtro que se va a aplicar a los análisis de suscripciones. Consulte las secciones Sintaxis de filtro y Campos de filtro para conocer la sintaxis, los campos y los operadores que se deben utilizar en este parámetro.

Sintaxis de filtro

El parámetro de filtro debe componerse como una serie de combinaciones de campos, valores y operadores. Se pueden combinar múltiples combinaciones usando and operadores o or .

Un ejemplo sin codificar tiene el siguiente aspecto:

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

Filtrar campos

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 con los eq operadores or ne . Algunos campos también admiten los containsoperadores , , gtlt, ge, y le . Las instrucciones se pueden combinar mediante and operadores or 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 los operadores de compatibilidad para el parámetro de filtro. Los valores de cadena deben ir entre comillas simples.

Parámetro Operadores compatibles Descripción
autoRenewEnabled eq, ne Valor que indica si la suscripción se renueva automáticamente.
commitmentEndDate eq, ne, gt, lt, , ge, le La fecha en que finaliza la suscripción.
fechaDeCreación eq, ne, gt, lt, , ge, le La fecha en que se creó la suscripción.
currentStateEndDate eq, ne, gt, lt, , ge, le La fecha en que cambiará el estado actual de la suscripción.
customerMarket eq, ne El país o región en el que el cliente hace negocios.
nombreDelCliente contains Nombre del cliente.
customerTenantId eq, ne Cadena con formato GUID que identifica al inquilino del cliente.
deprovisionedDate eq, ne, gt, lt, , ge, le La fecha en que se desaprovisionó la suscripción. El valor predeterminado es null.
fecha de inicio efectiva eq, ne, gt, lt, , ge, le La fecha de inicio de la suscripción.
nombre amistoso contains Nombre de la suscripción.
identificación eq, ne Cadena con formato GUID que identifica la suscripción.
lastRenewalDate eq, ne, gt, lt, , ge, le La fecha en que se renovó por última vez la suscripción. El valor predeterminado es null.
lastUsageDate eq, ne, gt, lt, , ge, le La fecha en que se usó por última vez la suscripción. El valor predeterminado es null.
partnerId eq, ne El PartnerID. En el caso de un revendedor directo, este valor es el PartnerID del asociado. En el caso de un revendedor indirecto, este valor es el PartnerID del revendedor indirecto.
partnerName cuerda / cadena Nombre del asociado para el que se compró la suscripción
Nombre del producto contains, eq, ne El nombre del producto.
nombreDelProveedor cuerda / cadena 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.
estado eq, ne Estado de la suscripción. Los valores admitidos son: ACTIVE,SUSPENDED oDEPROVISIONED.
subscriptionType eq, ne El tipo de suscripción. Nota: Este campo distingue entre mayúsculas y minúsculas. Los valores admitidos son: Office, Azure, Microsoft365, Dynamics, EMS.
trialStartDate eq, ne, gt, lt, , ge, le La 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 La fecha en que la suscripción pasa de prueba a paga. El valor predeterminado es null.

Cabeceras de solicitud

Para más información, consulte 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: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

Respuesta REST

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

Códigos de éxito y de error de la respuesta

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: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd

{
    "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "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

  • Last updated on