Ottenere informazioni sull'utilizzo delle licenze

Articolo
07/17/2024

Come ottenere informazioni sull'utilizzo delle licenze a livello di carico di lavoro per Office e Dynamics.

Prerequisiti

Credenziali descritte in Autenticazione del Centro per i partner. Questo scenario supporta l'autenticazione con le credenziali dell'app e dell'utente.

Richiesta REST

Sintassi della richiesta

Metodo	URI richiesta
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Intestazioni della richiesta

Per altre informazioni, vedi Intestazioni REST del Centro per i partner.

Parametri URI

Parametro	Tipo	Descrizione	Obbligatoria
top	string	Numero di righe di dati da restituire nella richiesta. Il valore massimo e il valore predefinito se non specificato è 10000. Se nella query sono presenti più righe, il corpo della risposta include un link successivo che puoi usare per richiedere la pagina successiva dei dati.	No
skip	INT	Numero di righe da ignorare nella query. Usa questo parametro per scorrere set di dati di grandi dimensioni. Ad esempio, top=10000 e skip=0 recupera le prime 10000 righe di dati, top=10000 e skip=10000 recupera le 10000 righe successive e così via.	No
filter	string	Il parametro filter della richiesta include una o più istruzioni per filtrare le righe nella risposta. Ogni istruzione contiene un campo e un valore associati agli `eq` operatori o `ne` e le istruzioni possono essere combinate usando `and` o `or`. Ecco alcuni esempi di parametri filter: filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' o (channel eq 'Reseller') Puoi specificare i campi seguenti: workloadCode workloadName serviceCode Servicename Canale customerTenantId customerName Productid Productname	No
groupby	string	Istruzione che applica l'aggregazione dei dati solo ai campi specificati. Puoi specificare i campi seguenti: workloadCode workloadName serviceCode Servicename channelcustomerTenantId customerName Productid Productname Le righe di dati restituite conterranno i campi specificati nel parametro groupby e gli elementi seguenti: licensesActive licensesQualified	No
processedDateTime	Datetime	È possibile specificare la data da cui sono stati elaborati i dati di utilizzo. Il valore predefinito è la data più recente in cui i dati sono stati elaborati	No

Esempio di richiesta

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

Risposta REST

In caso di esito positivo, il corpo della risposta contiene i campi seguenti contenenti dati sull'utilizzo delle licenze.

Campo	Tipo	Descrizione
workloadCode	string	Codice del carico di lavoro
workloadName	string	Nome del carico di lavoro
serviceCode	string	Codice di servizio
serviceName	string	Nome del servizio
channel	string	Nome del canale, rivenditore
customerTenantId	string	Identificatore univoco per il cliente
customerName	string	Nome cliente
productId	string	Identificatore univoco per il prodotto
productName	string	Nome prodotto
licensesActive	long	Numero di licenze attive per carico di lavoro
licensesQualified	long	Numero di licenze qualificate per il carico di lavoro
processedDateTime	Datetime	Data dell'ultima elaborazione dei dati

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che ne indica l'esito e con informazioni di debug aggiuntive. Usa uno strumento di traccia di rete per leggere il codice, il tipo di errore e parametri aggiuntivi. Per l'elenco completo, vedi Codici di errore REST del Centro per i partner.

Esempio di risposta

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

Condividi tramite