Obter informações de uso de licenças

Artigo
07/17/2024

Como obter informações de uso de licenças no nível da carga de trabalho do Office e do Dynamics.

Pré-requisitos

Credenciais, conforme descrito em Autenticação do Partner Center. Este cenário dá suporte à autenticação com credenciais de aplicativo + usuário.

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Cabeçalhos de solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Parâmetros do URI

Parâmetro	Type	Descrição	Obrigatório
top	string	O número de linhas de dados a serem retornadas na solicitação. O valor máximo e o valor padrão; se não forem especificados, será 10.000. Se houver mais linhas na consulta, o corpo da resposta incluirá um link que você poderá usar para solicitar a próxima página de dados.	Não
skip	INT	O número de linhas a serem ignoradas na consulta. Use este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recuperam as primeiras 10.000 linhas de dados, top=10000 e skip=10000 recuperam as próximas 10.000 linhas de dados e assim por diante.	Não
filter	string	O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas da resposta. Cada instrução contém um campo e um valor associados aos `eq` operadores ou `ne` , e as instruções podem ser combinadas usando `and` ou `or`. Estes são alguns exemplos dos parâmetros filter: filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' ou (channel eq 'Reseller') Você pode especificar os campos a seguir: workloadCode workloadName serviceCode Servicename canal customerTenantId Customername productId Productname	Não
groupby	string	Uma instrução que aplica a agregação de dados apenas aos campos especificados. Você pode especificar os campos a seguir: workloadCode workloadName serviceCode Servicename channelcustomerTenantId Customername productId Productname As linhas de dados retornadas conterão os campos especificados no parâmetro groupby e o seguinte: licensesActive licensesQualified	Não
processedDateTime	Datetime	É possível especificar a data da qual os dados de uso foram processados. O padrão é a data mais recente em que os dados foram processados	Não

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/usage/license?filter=customerTenantId%20eq%20%27aaaabbbb-0000-cccc-1111-dddd2222eeee%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

Resposta REST

Se tiver êxito, o corpo da resposta conterá os campos a seguir que contêm dados sobre o uso de licenças.

Campo	Type	Descrição
workloadCode	string	Código da carga de trabalho
workloadName	string	Nome da carga de trabalho
serviceCode	string	Código de serviço
serviceName	string	Nome do serviço
channel	string	Nome do canal, revendedor
customerTenantId	string	Identificador exclusivo para o cliente
customerName	string	Nome do cliente
productId	string	Identificador exclusivo para o produto
productName	string	Nome do produto
licensesActive	long	Número de licenças ativas por carga de trabalho
licensesQualified	long	Número de licenças qualificadas para a carga de trabalho
processedDateTime	Datetime	Data em que os dados foram processados pela última vez

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplo de resposta

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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "customerName": "TEST COMPANY",
      "productId": "45A2423B-E884-448D-A831-D9E139C52D2F",
      "productName": "EXCHANGE ONLINE PROTECTION",
      "licenseActive": 0,
      "licensesQualified": 1
    }
}

Compartilhar via