Hämta information om licensanvändning

Artikel
07/17/2024

Så här hämtar du information om licensanvändning på arbetsbelastningsnivå för Office och Dynamics.

Förutsättningar

Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med app+användarautentiseringsuppgifter.

REST-begäran

Begärandesyntax

Metod	URI för förfrågan
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

URI-parametrar

Parameter	Typ	Beskrivning	Krävs
top	sträng	Antalet rader med data som ska returneras i begäran. Maxvärdet och standardvärdet om det inte anges är 10000. Om det finns fler rader i frågan innehåller svarstexten en nästa länk som du kan använda för att begära nästa sida med data.	No
hoppa över	int	Antalet rader som ska hoppas över i frågan. Använd den här parametern för att bläddra igenom stora datamängder. Till exempel hämtar top=10000 och skip=0 de första 1 0000 raderna med data, top=10000 och skip=10000 hämtar de kommande 1 0000 raderna med data och så vidare.	No
filter	sträng	Filterparametern för begäran innehåller en eller flera instruktioner som filtrerar raderna i svaret. Varje instruktion innehåller ett fält och ett värde som är associerade med operatorerna `eq` eller och -instruktioner kan kombineras med eller `and``or``ne` . Här följer några exempel på filterparametrar: filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' or (channel eq 'Reseller') Du kan ange följande fält: workloadCode workloadName serviceCode Tjänstnamn Kanal customerTenantId customerName Produktionen Productname	No
groupby	sträng	En instruktion som endast tillämpar dataaggregering på de angivna fälten. Du kan ange följande fält: workloadCode workloadName serviceCode Tjänstnamn channelcustomerTenantId customerName Produktionen Productname De returnerade dataraderna innehåller de fält som anges i parametern groupby och följande: licensesActive licensesQualified	No
processedDateTime	DateTime	Man kan ange det datum då användningsdata bearbetades. Standardvärdet är det senaste datumet då data bearbetades	No

Exempel på begäran

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

REST-svar

Om åtgärden lyckas innehåller svarstexten följande fält som innehåller data om licensanvändning.

Fält	Typ	Description
workloadCode	sträng	Arbetsbelastningskod
workloadName	sträng	Namn på arbetsbelastning
serviceCode	sträng	Tjänstkod
Tjänstnamn	sträng	Tjänstnamn
Kanal	sträng	Kanalnamn, återförsäljare
customerTenantId	sträng	Unik identifierare för kunden
customerName	sträng	Kundnamn
productId	sträng	Unik identifierare för produkten
Productname	sträng	Produktnamn
licensesActive	long	Antal aktiva licenser per arbetsbelastning
licensesQualified	long	Antal kvalificerade licenser för arbetsbelastningen
processedDateTime	DateTime	Datum då data senast bearbetades

Lyckade svar och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckat eller misslyckat och ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och ytterligare parametrar. Den fullständiga listan finns i Partnercenter REST-felkoder.

Exempel på svar

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

Dela via