Teilen über


Abrufen von Informationen zur Nutzung von Lizenzen

Abrufen von Informationen zur Nutzung von Lizenzen auf Workloadebene für Office und Dynamics.

Voraussetzungen

Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. In diesem Szenario wird die Authentifizierung mit App- und Benutzeranmeldeinformationen unterstützt.

REST-Anforderung

Anforderungssyntax

Methode Anforderungs-URI
GET {baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Anforderungsheader

Weitere Informationen finden Sie unter Partner Center-REST-Header.

URI-Parameter

Parameter Typ BESCHREIBUNG Erforderlich
top Zeichenfolge Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Maximal- und Standardwert ist 10.000, wenn nicht anders angegeben. Sind in der Abfrage keine weiteren Zeilen, enthält der Antworttext den Link „Weiter“, über den Sie die nächste Seite mit Daten anfordern können. Nein
skip INT Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern. Beispielsweise rufen „top=10000“ und „skip=0“ die ersten 10.000 Datenzeilen ab, „top=10000“ und „skip=10000“ die nächsten 10.000 Datenzeilen usw. Nein
filter Zeichenfolge Der Parameter filter der Anforderung enthält mindestens eine Anweisung, die die Zeilen in der Antwort filtert. Jede Anweisung enthält ein Feld und einen Wert, die den eq Operatoren oder ne zugeordnet sind, und Anweisungen können mit and oder orkombiniert werden. Im Folgenden finden Sie einige Beispiele für filter-Parameter:

filter=workloadCode eq 'SFB'

filter=workloadCode eq 'SFB' or (channel eq 'Reseller')

Sie können die folgenden Felder angeben:

workloadCode
workloadName
serviceCode
Servicename
Kanal
customerTenantId
Customername
productId
Productname
Nein
groupby Zeichenfolge Eine Anweisung, die nur auf die angegebenen Felder Datenaggregationen anwendet. Sie können die folgenden Felder angeben:

workloadCode
workloadName
serviceCode
Servicename
channelcustomerTenantId
Customername
productId
Productname

Die zurückgegebenen Datenzeilen enthalten die im groupby-Parameter angegebenen Felder und Folgendes:

licensesActive
licensesQualified
Nein
processedDateTime Datetime Sie können das Datum angeben, ab dem Nutzungsdaten verarbeitet wurden. Standardmäßig wird das letzte Datum verwendet, an dem die Daten verarbeitet wurden. Nein

Anforderungsbeispiel

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: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
X-Locale: en-US
Host: api.partnercenter.microsoft.com

REST-Antwort

Bei erfolgreicher Ausführung enthält der Antworttext die folgenden Felder, die Daten zur Nutzung von Lizenzen enthalten.

Feld Typ BESCHREIBUNG
workloadCode Zeichenfolge Workloadcode
workloadName Zeichenfolge Workloadname
serviceCode Zeichenfolge Dienstcode
serviceName Zeichenfolge Dienstname
Kanal Zeichenfolge Kanalname, Vertriebspartner
customerTenantId Zeichenfolge Eindeutiger Bezeichner für den Kunden
customerName Zeichenfolge Kundenname
productId Zeichenfolge Eindeutiger Bezeichner für das Produkt
ProductName Zeichenfolge Produktname
licensesActive long Anzahl der aktiven Lizenzen pro Workload
licensesQualified long Anzahl der qualifizierten Lizenzen für die Workload
processedDateTime Datetime Datum der letzten Verarbeitung der Daten

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Aufschluss darüber gibt, ob der Vorgang erfolgreich war, sowie ggf. zusätzliche Debuginformationen. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen. Die vollständige Liste finden Sie unter Partner Center-REST-Fehlercodes.

Antwortbeispiel

HTTP/1.1 200 OK
Content-Length: 487
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
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
    }
}