検索クエリでフィルター処理されたサブスクリプションの分析情報を取得する

適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター

検索クエリでフィルター処理された顧客のサブスクリプション分析情報を取得する方法。

前提条件

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

REST 要求

要求の構文

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

URI パラメーター

次の必須パス パラメーターを使用して、組織を特定し、検索をフィルター処理します。

名前	タイプ	Required	説明
filter_string	string	はい	サブスクリプション分析に適用するフィルター。 このパラメーターで使用する構文、フィールド、および演算子については、「フィルター構文」および「フィールドのフィルター」セクションを参照してください。

フィルターの構文

フィルター パラメーターは、一連のフィールド、値、および演算子の組み合わせとして構成する必要があります。 複数の組み合わせを使用またはor演算子を組andみ合わせることができます。

エンコードされていない例は次のようになります。

• String: ?filter=Field operator 'Value'
• ブール値: ?filter=Field operator Value
• 含む ?filter=contains(field,'value')

フィルター フィールド

要求のフィルター パラメーターには、応答内の行をフィルター処理する 1 つ以上のステートメントが含まれています。 各ステートメントには、or ne 演算子に関連付けられているフィールドと値がeq含まれています。 一部の containsフィールドでは、、 gt、、 lt、 ge、演算子 le もサポートされています。 ステートメントは、演算子をor使用してand組み合わせることができます。

フィルター文字列の例を次に示します。

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

次の表に、フィルター パラメーターでサポートされているフィールドとサポート演算子の一覧を示します。 文字列値は、単一引用符で囲む必要があります。

パラメーター	サポートされている演算子	説明
autoRenewEnabled	eq, ne	サブスクリプションが自動的に更新されるかどうかを示す値。
commitmentEndDate	eq、 ne, gt, lt, gele	サブスクリプションが終了する日付。
creationDate	eq、 ne, gt, lt, gele	サブスクリプションが作成された日付。
currentStateEndDate	eq、 ne, gt, lt, gele	サブスクリプションの現在の状態が変更される日付。
customerMarket	eq, ne	顧客がビジネスを行う国/地域。
customerName	contains	顧客の名前。
customerTenantId	eq, ne	顧客テナントを識別する GUID 形式の文字列。
deprovisionedDate	eq、 ne, gt, lt, gele	サブスクリプションがプロビジョニング解除された日付。 既定値は null です。
effectiveStartDate	eq、 ne, gt, lt, gele	サブスクリプションが開始される日付。
friendlyName	contains	サブスクリプションの名前です。
ID	eq, ne	サブスクリプションを識別する GUID 形式の文字列。
lastRenewalDate	eq、 ne, gt, lt, gele	サブスクリプションが最後に更新された日付。 既定値は null です。
lastUsageDate	eq、 ne, gt, lt, gele	サブスクリプションが最後に使用された日付。 既定値は 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、 ne, gt, lt, gele	サブスクリプションの試用期間が開始された日付。 既定値は null です。
trialToPaidConversionDate	eq、 ne, gt, lt, gele	サブスクリプションが試用版から有料版に変換する日付。 既定値は null です。

要求ヘッダー

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

要求本文

なし。

要求の例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
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: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123

{
    "customerTenantId": "735920EB-A564-4C72-9FE5-52632562712C",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
    "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
}

関連項目

• パートナー センターの分析 - リソース