適用於：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府Microsoft雲端合作夥伴中心
如何取得透過搜尋查詢過濾的客戶訂閱分析資訊。
先決條件
- 認證如 合作夥伴中心驗證中所述。 此案例僅支援使用使用者認證進行驗證。
REST 要求
請求語法
| 方法 | 要求 URI |
|---|---|
| 取得 | {baseURL}/partner/v1/analytics/subscriptions？filter={filter_string} |
URI 參數
使用下列必要路徑參數來識別您的組織並篩選搜尋。
| 名字 | 類型 | 必填 | 描述 |
|---|---|---|---|
| 篩選字串 | 字串 | 是的 | 要套用到訂閱分析的篩選器。 如需要用於此參數的語法、欄位和運算符，請參閱篩選語法和篩選欄位區段。 |
篩選語法
篩選參數必須組成一系列欄位、值和運算子組合。 您可以使用 and 或 or 運算子來結合多個組合。
未編碼的範例如下所示：
- 字串：
?filter=Field operator 'Value' - 布爾值：
?filter=Field operator Value - 包含
?filter=contains(field,'value')
篩選欄位
要求的 filter 參數包含一或多個語句，可篩選響應中的數據列。 每個語句都包含與 eq 或 ne 運算符相關聯的欄位和值。 某些欄位也支援 contains、gt、lt、ge和 le 運算符。 語句可以使用 and 或 or 運算符來合併。
以下是篩選字串的範例：
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
下表顯示篩選參數支援的欄位和支援運算符清單。 字串值必須以單引號括住。
| 參數 | 支援的運算子 | 描述 |
|---|---|---|
| 自動續訂啟用 |
eq、ne |
值，指出訂閱是否自動更新。 |
| 承諾截止日期 |
eq、ne、gt、lt、ge、le |
訂閱結束的日期。 |
| 建立日期 |
eq、ne、gt、lt、ge、le |
建立訂閱的日期。 |
| 當前狀態結束日期 |
eq、ne、gt、lt、ge、le |
訂閱目前狀態將會變更的日期。 |
| 客戶市場 |
eq、ne |
客戶執行業務的國家/地區。 |
| 客戶名稱 | contains |
客戶的名稱。 |
| 客戶租戶ID |
eq、ne |
識別客戶租戶的 GUID 格式字串。 |
| 解除配置日期 (deprovisionedDate) |
eq、ne、gt、lt、ge、le |
訂閱取消配置的日期。 預設值為 null。 |
| 生效開始日期 |
eq、ne、gt、lt、ge、le |
訂閱開始的日期。 |
| 顯示名稱 | contains |
訂用帳戶的名稱。 |
| 識別碼 |
eq、ne |
識別訂用帳戶的 GUID 格式字串。 |
| 上次續約日期 |
eq、ne、gt、lt、ge、le |
上次更新訂閱的日期。 預設值為 null。 |
| 最後使用日期 |
eq、ne、gt、lt、ge、le |
上次使用訂閱的日期。 預設值為 null。 |
| 合作夥伴ID |
eq、ne |
PartnerID。 對於直接轉銷商，此值為合作夥伴的 PartnerID。 對於間接轉銷商，此值為間接轉銷商的 PartnerID。 |
| 合作夥伴名稱 | 字串 | 購買訂用帳戶的合作夥伴名稱 |
| 產品名稱 |
contains、eq、ne |
產品名稱。 |
| 提供者名稱 | 字串 | 當訂閱交易涉及間接轉銷商時，提供者名稱指的是購買訂閱的間接提供者。 |
| 地位 |
eq、ne |
訂用帳戶狀態。 支援的值為：ACTIVE、SUSPENDED或 DEPROVISIONED。 |
| 訂閱類型 |
eq、ne |
訂用帳戶類型。 附註：此欄位區分大小寫。 支援的值包括：Office、Azure、Microsoft365、DynamicsEMS。 |
| 試用開始日期 |
eq、ne、gt、lt、ge、le |
訂閱試用期開始的日期。 預設值為 null。 |
| 試用轉付費日期 |
eq、ne、gt、lt、ge、le |
訂閱從試用版轉換為付費的日期。 預設值為 null。 |
請求頭信息
請求內容
沒有。
要求範例
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
}