Partager via


Obtenir des informations sur l’utilisation des licences

Comment obtenir des informations sur l’utilisation des licences au niveau de la charge de travail pour Office et Dynamics.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application et de l’utilisateur.

Demande REST

Syntaxe de la requête

Méthode URI de requête
GET {baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Paramètres URI

Paramètre Type Description Obligatoire
top chaîne Le nombre de lignes de données à renvoyer dans la requête. La valeur maximale et la valeur par défaut en l’absence de définition est 10000. Si la requête comporte davantage de lignes, le corps de la réponse inclut un lien sur lequel vous cliquez pour solliciter la page suivante de données. Non
skip int Le nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir de grands ensembles de données. Par exemple, indiquez top=10000 et skip=0 pour obtenir les 10000 premières lignes de données, top=10000 et skip=10000 pour obtenir les 10000 lignes suivantes, et ainsi de suite. Non
filter chaîne Le paramètre filter de la requête contient une ou plusieurs instructions qui filtrent les lignes de la réponse. Chaque instruction contient un champ et une valeur associés aux opérateurs ou , et les instructions peuvent être combinées à l’aide eqand de ou or.ne Voici quelques exemples de paramètres filter :

filter=workloadCode eq 'SFB'

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

Vous pouvez spécifier les champs suivants :

workloadCode
workloadName
serviceCode
Servicename
canal
customerTenantId
customerName
productId
Productname
Non
groupby chaîne Une instruction qui applique l’agrégation des données uniquement sur les champs spécifiés. Vous pouvez spécifier les champs suivants :

workloadCode
workloadName
serviceCode
Servicename
channelcustomerTenantId
customerName
productId
Productname

Les lignes de données retournées contiennent les champs spécifiés dans le paramètre groupby et les éléments suivants :

licensesActive
licensesQualified
Non
processedDateTime DateTime Vous pouvez spécifier la date à partir de laquelle les données d’utilisation ont été traitées. La valeur par défaut est la date la plus récente à laquelle les données ont été traitées Non

Exemple de requête

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

Réponse REST

En cas de réussite, le corps de la réponse contient les champs suivants contenant des données sur l’utilisation des licences.

Champ Type Description
workloadCode string Code de charge de travail
workloadName chaîne Nom de la charge de travail
serviceCode chaîne Code de service
serviceName chaîne Nom du service
channel chaîne Nom du canal, revendeur
customerTenantId chaîne Identificateur unique du client
customerName chaîne Nom de client
productId string Identificateur unique pour le produit
ProductName chaîne Nom du produit
licensesActive long Nombre de licences actives par charge de travail
licensesQualified long Nombre de licences qualifiées pour la charge de travail
processedDateTime DateTime Date à laquelle les données ont été traitées pour la dernière fois

Codes d’erreur et de réussite de la réponse

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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