Obtener la información de uso de licencias

Artículo
07/17/2024

Cómo obtener información de uso de licencias en el nivel de carga de trabajo para Office y Dynamics.

Requisitos previos

Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación con credenciales de aplicación y usuario.

Solicitud REST

Sintaxis de la solicitud

Método	URI de la solicitud
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Encabezados de solicitud

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

Parámetros del identificador URI

Parámetro	Tipo	Descripción	Obligatorio
top	string	Número de filas de datos que se devuelven en la solicitud. El valor máximo y el valor predeterminado, si no se especifican, es 10 000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo que puedes usar para solicitar la siguiente página de datos.	No
skip	int	Número de filas que se omiten en la consulta. Usa este parámetro para consultar grandes conjuntos de datos. Por ejemplo, los valores top=10000 y skip=0 recuperan las primeras 10 000 filas de datos, los valores top=10000 y skip=10000 recuperan las siguientes 10 000 filas de datos, y así sucesivamente.	No
filter	string	El parámetro filter de la solicitud contiene una o más 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` , y las instrucciones se pueden combinar mediante `and` o `or`. Estos son algunos ejemplos de parámetros filter: filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' o (channel eq 'Reseller') Puedes especificar los siguientes campos: workloadCode workloadName serviceCode Servicename channel customerTenantId Nombre_cliente productId Productname	No
groupby	string	Una instrucción que aplica la agregación de datos únicamente a los campos especificados. Puedes especificar los siguientes campos: workloadCode workloadName serviceCode Servicename channelcustomerTenantId Nombre_cliente productId Productname Las filas de datos devueltas contendrán los campos especificados en el parámetro groupby y lo siguiente: licensesActive licensesQualified	No
processedDateTime	DateTime	Puede especificar la fecha desde la que se procesaron los datos de uso. El valor predeterminado es la fecha más reciente en la que se procesaron los datos.	No

Ejemplo de solicitud

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/usage/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: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Respuesta REST

Si se ejecuta correctamente, el cuerpo de la respuesta contiene los siguientes campos que contienen datos sobre el uso de licencias.

Campo	Tipo	Descripción
workloadCode	string	Código de carga de trabajo
workloadName	string	Nombre de la carga de trabajo
serviceCode	string	Código de servicio
serviceName	string	Nombre del servicio
canal	string	Nombre del canal, revendedor
customerTenantId	string	Identificador único para el cliente
customerName	string	Nombre de cliente
productId	string	Identificador único del producto
ProductName	string	Nombre de producto
licensesActive	long	Número de licencias activas por carga de trabajo
licensesQualified	long	Número de licencias calificadas para la carga de trabajo
processedDateTime	DateTime	Fecha en que se procesaron por última vez los datos

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.

Ejemplo de respuesta

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": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "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": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "45A2423B-E884-448D-A831-D9E139C52D2F",
      "productName": "EXCHANGE ONLINE PROTECTION",
      "licenseActive": 0,
      "licensesQualified": 1
    }
}

Compartir vía