获取许可证部署信息

如何获取 Office 和 Dynamics 许可证的部署信息。

必备条件

合作伙伴中心身份验证中所述的凭据。 此方案支持使用应用凭据和用户凭据进行身份验证。

REST 请求

请求语法

方法 请求 URI
GET {baseURL}/v1/analytics/commercial/deployment/license/ HTTP/1.1

请求标头

有关详细信息,请参阅合作伙伴中心 REST 标头

URI 参数

参数 类型 说明 必须
top string 要在请求中返回的数据行数。 如果未指定,最大值和默认值为 10000。 当查询中存在多行数据时,响应正文中包含的下一个链接可用于请求下一页数据。
skip int 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如,top=10000 和 skip=0,将检索前 10000 行数据;top=10000 和 skip=10000,将检索之后的 10000 行数据,依此类推。
filter string 请求中的 filter 参数包含一条或多条语句,用于在响应中筛选行。 每个语句都包含一个与 eqne 运算符关联的字段和值,可以使用 或 or组合and语句。 下面是一些示例 filter 参数:

filter=serviceCode eq 'O365'
filter=serviceCode eq 'O365' or (channel eq 'Reseller')

可以指定的字段如下所示:

serviceCode
serviceName
channel
customerTenantId
customerName
productId
productName
groupby string 仅将数据聚合应用于指定字段的语句。 可以指定的字段如下所示:

serviceCode
serviceName
channel
customerTenantId
customerName
productId
productName

返回的数据行将包含 groupby 参数中指定的字段和以下内容:

licensesDeployed
licensesSold
processedDateTime DateTime 可以指定处理使用情况数据的日期。 默认为处理数据的最新日期

请求示例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/deployment/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 响应

如果成功,响应正文将包含以下字段,其中包含有关部署的许可证的数据。

字段 类型 说明
serviceCode 字符串 服务代码
serviceName string Service name
channel 字符串 频道名称、经销商
customerTenantId string 客户的唯一标识符
customerName string 客户名称
productId 字符串 产品的唯一标识符
productName string 产品名称
licensesDeployed long 部署的许可证数
licensesSold long 售出许可证的数量
processedDateTime DateTime 上次处理数据的日期

响应的成功和错误代码

每个响应都带有一个 HTTP 状态代码,用于指示成功或失败以及其他调试信息。 请使用网络跟踪工具来读取此代码、错误类型和其他参数。 如需完整列表,请参阅合作伙伴中心 REST 错误代码

响应示例

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",
      "serviceCode": "crm",
      "serviceName": "Microsoft Dynamics",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "54B84594-9C77-4499-8D65-5E0D5F410E78",
      "productName": "DYNAMICS AX TASK",
      "licensesDeployed": 0,
      "licensesSold": 9
    },
    {
      "processedDateTime": "2018-10-14T00:00:00",
      "serviceCode": "o365",
      "serviceName": "Microsoft Office 365",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "D3B4FE1F-9992-4930-8ACB-CA6EC609365E",
      "productName": "DOMESTIC AND INTERNATIONAL CALLING PLAN",
      "licensesDeployed": 0,
      "licensesSold": 5
    }
],
  "@nextLink": null,
  "TotalCount": 2
}