Obter informações de utilização de licenças

Artigo
07/17/2024

Como obter informações de utilização de licenças ao nível da carga de trabalho do Office e do Dynamics.

Pré-requisitos

Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação com credenciais de Aplicação+Utilizador.

Pedido REST

Sintaxe do pedido

Método	URI do pedido
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Cabeçalhos do pedido

Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.

Parâmetros URI

Parâmetro	Tipo	Descrição	Obrigatório
top	string	O número de linhas de dados a devolver no pedido. O valor máximo e o valor predefinido se não for especificado são 10000. Se existirem mais linhas na consulta, o corpo da resposta inclui uma ligação seguinte que pode utilizar para pedir a página seguinte de dados.	Não
ignorar	int	O número de linhas a ignorar na consulta. Utilize este parâmetro para página através de conjuntos de dados grandes. Por exemplo, top=10000 e skip=0 obtém as primeiras 10000 linhas de dados, top=10000 e skip=10000 obtém as próximas 10000 linhas de dados, etc.	Não
filter	string	O parâmetro de filtro do pedido contém uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um campo e um valor que estão associados aos `eq` operadores ou `ne` e as instruções podem ser combinadas com `and` ou `or`. Seguem-se alguns parâmetros de filtro de exemplo: filter=workloadCode eq "SFB" filter=workloadCode eq "SFB" ou (channel eq "Reseller") Pode especificar os seguintes campos: 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. Pode especificar os seguintes campos: workloadCode workloadName serviceCode serviceName channelcustomerTenantId customerName productId productName As linhas de dados devolvidas conterão os campos especificados no parâmetro groupby e o seguinte: licensesActive licenças Qualificadas	Não
processedDateTime	DateTime	Pode-se especificar a data a partir da qual os dados de utilização foram processados. Predefinição para a data mais recente quando os dados foram processados	Não

Exemplo de pedido

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 do REST

Se for bem-sucedido, o corpo da resposta contém os seguintes campos que contêm dados sobre a utilização de licenças.

Campo	Tipo	Description
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
canal	string	Nome do canal, revendedor
customerTenantId	string	Identificador exclusivo do cliente
customerName	string	Nome do cliente
productId	string	Identificador exclusivo do produto
productName	string	Nome do produto
licensesActive	long	Número de licenças ativas por carga de trabalho
licenças Qualificadas	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 erro e êxito da resposta

Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, tipo de erro e parâmetros adicionais. Para obter a lista completa, veja Códigos de erro REST do Centro de Parceiros.

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
    }
}

Partilhar via