ライセンスの使用情報を取得する

[アーティクル]
05/31/2024

Office と Dynamics のワークロードレベルでライセンスの使用状況情報を取得する方法。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、アプリとユーザーの資格情報を使用した認証がサポートされます。

REST 要求

要求の構文

認証方法	要求 URI
GET	{baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1

要求ヘッダー

詳細については、「パートナーセンター REST ヘッダー」を参照してください。

URI パラメーター

パラメーター	Type	説明	必須
top	string	要求で返すデータの行数です。最大値および指定しない場合の既定値は 10000 です。クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。	いいえ
skip	int	クエリでスキップする行数です。大きなデータセットを操作するには、このパラメーターを使用します。たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。	いいえ
filter	string	要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。各ステートメントには、または `ne` 演算子に関連付`eq`けられているフィールドと値が含まれており、ステートメントはまたは `or`を使用して`and`組み合わせることができます。 filter パラメーターの例を次に示します。 filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' または (channel eq 'Reseller') 次のフィールドを指定できます。 workloadCode workloadName serviceCode Servicename チャネル customerTenantId customerName productId productName	No
groupby	string	指定したフィールドのみにデータ集計を適用するステートメントです。次のフィールドを指定できます。 workloadCode workloadName serviceCode Servicename channelcustomerTenantId customerName productId productName 返されるデータ行には、 groupby パラメーターで指定されたフィールドと次のものが含まれます。 licensesActive licensesQualified	いいえ
processedDateTime	DateTime	使用状況データの処理元の日付を指定できます。既定値は、データが処理された最新の日付です	いいえ

要求の例

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

REST 応答

成功した場合、応答本文には、ライセンスの使用状況に関するデータを含む次のフィールドが含まれます。

フィールド	Type	説明
workloadCode	string	ワークロードコード
workloadName	string	ワークロード名
serviceCode	string	サービスコード
serviceName	string	[サービス名]
channel	string	チャネル名、リセラー
customerTenantId	string	顧客の一意識別子
customerName	string	顧客名
productId	string	製品の一意識別子
productName	string	製品名
licensesActive	long	ワークロードあたりのアクティブなライセンスの数
licensesQualified	long	ワークロードの認定ライセンスの数
processedDateTime	DateTime	データが最後に処理された日付

応答の成功とエラーのコード

各応答には、成功または失敗を示す HTTP ステータスコードと、追加のデバッグ情報が付属しています。このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワークトレースツールを使用します。完全な一覧については、パートナーセンターの REST エラーコードに関する記事を参照してください。

応答の例

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

次の方法で共有