Udostępnij za pośrednictwem


Pobieranie informacji dotyczących użycia licencji

Jak uzyskać informacje o użyciu licencji na poziomie obciążenia dla pakietu Office i usługi Dynamics.

Wymagania wstępne

Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie przy użyciu poświadczeń użytkownika i aplikacji.

Żądanie REST

Składnia żądania

Metoda Identyfikator URI żądania
GET {baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Parametry identyfikatora URI

Parametr Typ Opis Wymagane
top (pierwsze) ciąg Liczba wierszy danych do zwrócenia w żądaniu. Wartość maksymalna i wartość domyślna, jeśli nie zostanie określona, to 10000. Jeśli w zapytaniu znajduje się więcej wierszy, treść odpowiedzi zawiera następny link, którego można użyć do żądania następnej strony danych. Nie
Pomiń int Liczba wierszy do pominięcia w zapytaniu. Użyj tego parametru, aby stronicować za pośrednictwem dużych zestawów danych. Na przykład top=10000 i skip=0 pobiera pierwsze 10000 wierszy danych, top=10000 i skip=10000 pobiera kolejne 10000 wierszy danych itd. Nie
filter ciąg Parametr filtru żądania zawiera jedną lub więcej instrukcji filtrujących wiersze w odpowiedzi. Każda instrukcja zawiera pole i wartość, które są skojarzone z operatorami eq lub ne , a instrukcje można łączyć przy użyciu instrukcji and lub or. Oto kilka przykładowych parametrów filtru :

filter=workloadCode eq 'SFB'

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

Możesz określić następujące pola:

workloadCode
nazwa_obciążenia
serviceCode
Servicename
Kanał
customerTenantId
Customername
Productid
Productname
Nie
Groupby ciąg Instrukcja, która stosuje agregację danych tylko do określonych pól. Możesz określić następujące pola:

workloadCode
nazwa_obciążenia
serviceCode
Servicename
channelcustomerTenantId
Customername
Productid
Productname

Zwrócone wiersze danych będą zawierać pola określone w parametrze groupby i następujące:

licensesActive
licensesQualified
Nie
processedDateTime DateTime Można określić datę przetworzenia danych użycia. Domyślnie jest określana najpóźniejsza data przetworzenia danych Nie

Przykład żądania

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

Odpowiedź REST

W przypadku powodzenia treść odpowiedzi zawiera następujące pola zawierające dane dotyczące użycia licencji.

Pole Typ Opis
workloadCode ciąg Kod obciążenia
nazwa_obciążenia ciąg Nazwa obciążenia
serviceCode ciąg Kod usługi
Servicename ciąg Nazwa usługi
Kanał ciąg Nazwa kanału, odsprzedawca
customerTenantId ciąg Unikatowy identyfikator klienta
Customername ciąg Nazwa klienta
productId ciąg Unikatowy identyfikator produktu
Productname ciąg Nazwa produktu
licenseActive długi Liczba aktywnych licencji na obciążenie
licenseQualified (licencjekwalifikowane) długi Liczba kwalifikowanych licencji dla obciążenia
processedDateTime DateTime Data ostatniego przetworzenia danych

Kody powodzenia odpowiedzi i błędów

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykład odpowiedzi

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