取得根據搜尋查詢所篩選的訂用帳戶分析資訊

發行項
12/21/2023

適用於：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府適用的 Microsoft Cloud 合作夥伴中心

如何取得客戶依搜尋查詢篩選的訂用帳戶分析資訊。

必要條件

認證，如合作夥伴中心驗證所述。此案例僅支援使用使用者認證進行驗證。

REST 要求

要求語法

方法	要求 URI
GET	{baseURL}/partner/v1/analytics/subscriptions？filter={filter_string}

URI 參數

使用下列必要路徑參數來識別您的組織並篩選搜尋。

名稱	類型	必要	描述
filter_string	string	Yes	要套用至訂用帳戶分析的篩選條件。如需要用於此參數的語法、欄位和運算符，請參閱篩選語法和篩選欄位區段。

篩選語法

篩選參數必須組成一系列欄位、值和運算子組合。您可以使用或 or 運算符來and結合多個組合。

未編碼的範例如下所示：

字串： ?filter=Field operator 'Value'
布林值：?filter=Field operator Value
包含 ?filter=contains(field,'value')

篩選欄位

要求的 filter 參數包含一或多個語句，可篩選響應中的數據列。每個語句都包含與或 ne 運算符相關聯的eq欄位和值。某些欄位也支援 contains、 gt、 lt、 ge和 le 運算元。語句可以使用或 or 運算符來and結合。

以下是篩選字串的範例：

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

下表顯示篩選參數支援的欄位和支援運算符清單。字串值必須以單引號括住。

參數	支援的運算子	描述
autoRenewEnabled	`eq`, `ne`	值，指出訂閱是否自動更新。
commitmentEndDate	`eq`、、`negt`、`lt`、、`ge`、`le`	訂閱結束的日期。
creationDate	`eq`、、`negt`、`lt`、、`ge`、`le`	建立訂閱的日期。
currentStateEndDate	`eq`、、`negt`、`lt`、、`ge`、`le`	訂閱目前狀態將會變更的日期。
customerMarket	`eq`, `ne`	客戶執行業務的國家/地區。
customerName	`contains`	客戶的名稱。
customerTenantId	`eq`, `ne`	識別客戶租使用者的 GUID 格式字串。
deprovisionedDate	`eq`、、`negt`、`lt`、、`ge`、`le`	取消布建訂閱的日期。預設值為 null。
effectiveStartDate	`eq`、、`negt`、`lt`、、`ge`、`le`	訂閱開始的日期。
friendlyName	`contains`	訂用帳戶的名稱。
id	`eq`, `ne`	識別訂用帳戶的 GUID 格式字串。
lastRenewalDate	`eq`、、`negt`、`lt`、、`ge`、`le`	上次更新訂閱的日期。預設值為 null。
lastUsageDate	`eq`、、`negt`、`lt`、、`ge`、`le`	上次使用訂閱的日期。預設值為 null。
partnerId	`eq`, `ne`	PartnerID。對於直接轉銷商，此值為合作夥伴的 PartnerID。對於間接轉銷商，此值為間接轉銷商的 PartnerID。
partnerName	string	購買訂用帳戶的合作夥伴名稱
productName	`contains`、、 `eqne`	產品的名稱。
providerName	string	當訂閱交易是間接轉銷商時，提供者名稱是購買訂閱的間接提供者。
status	`eq`, `ne`	訂用帳戶狀態。支援的值為： ACTIVE、 SUSPENDED 或 DEPROVISIONED。
subscriptionType	`eq`, `ne`	訂用帳戶類型。注意：此欄位會區分大小寫。支援的值為： Office、 Azure、 Microsoft365、 Dynamics、 EMS。
trialStartDate	`eq`、、`negt`、`lt`、、`ge`、`le`	訂閱試用期開始的日期。預設值為 null。
trialToPaidConversionDate	`eq`、、`negt`、`lt`、、`ge`、`le`	訂閱從試用版轉換為付費的日期。預設值為 null。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

無。

要求範例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

REST 回應

如果成功，響應主體會包含符合篩選準則的訂用帳戶資源集合。

回應成功和錯誤碼

每個回應都有一個 HTTP 狀態代碼，指出成功或失敗和偵錯資訊。使用網路追蹤工具來讀取此程式代碼、錯誤類型和其他參數。如需完整清單，請參閱錯誤碼。

回應範例

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd

{
    "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "friendlyName": "MICROSOFT AZURE",
    "creationDate": "2017-06-02T23:11:58.747",
    "effectiveStartDate": "2017-06-02T00:00:00",
    "commitmentEndDate": null,
    "currentStateEndDate": null,
    "trialToPaidConversionDate": null,
    "trialStartDate": null,
    "trialEndDate": null,
    "lastUsageDate": null,
    "deprovisionedDate": null,
    "lastRenewalDate": null,
    "licenseCount": 0
}

另請參閱

合作夥伴中心分析 - 資源

共用方式為