Hämta information om prenumerationsanalys filtrerad efter en sökfråga
Gäller för: Partnercenter | Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government
Så här hämtar du information om prenumerationsanalys för dina kunder som filtrerats efter en sökfråga.
Förutsättningar
- Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder endast autentisering med användarautentiseringsuppgifter.
REST-begäran
Syntax för begäran
| Metod | URI för förfrågan |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string} |
URI-parametrar
Använd följande sökvägsparameter för att identifiera din organisation och filtrera sökningen.
| Namn | Typ | Obligatoriskt | Beskrivning |
|---|---|---|---|
| filter_string | sträng | Ja | Filtret som ska tillämpas på prenumerationsanalysen. Se avsnitten Filtersyntax och Filterfält för den syntax, de fält och operatorer som ska användas i den här parametern. |
Filtersyntax
Filterparametern måste bestå av en serie kombinationer av fält, värde och operatorer. Flera kombinationer kan kombineras med hjälp av and eller or operatorer.
Ett okodat exempel ser ut så här:
- Sträng:
?filter=Field operator 'Value' - Boolean:
?filter=Field operator Value - Innehåller
?filter=contains(field,'value')
Filtrera fält
Filterparametern för begäran innehåller en eller flera instruktioner som filtrerar raderna i svaret. Varje instruktion innehåller ett fält och ett värde som är associerat med operatorerna eq eller ne . Vissa fält stöder även operatorerna contains, gt, lt, geoch le . Instruktioner kan kombineras med hjälp av and eller or operatorer.
Följande är exempel på filtersträngar:
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
I följande tabell visas en lista över fält som stöds och stödoperatorer för filterparametern. Strängvärden måste omges av enkla citattecken.
| Parameter | Operatorer som stöds | beskrivning |
|---|---|---|
| autoRenewEnabled | eq, ne |
Ett värde som anger om prenumerationen förnyas automatiskt. |
| commitmentEndDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationen upphör. |
| creationDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationen skapades. |
| currentStateEndDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationens aktuella status ändras. |
| customerMarket | eq, ne |
Det land/den region som kunden gör affärer i. |
| customerName | contains |
Kundens namn. |
| customerTenantId | eq, ne |
En GUID-formaterad sträng som identifierar kundens klientorganisation. |
| deprovisionedDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationen avetablerades. Standardvärdet är null. |
| effectiveStartDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationen startar. |
| friendlyName | contains |
Namnet på prenumerationen. |
| id | eq, ne |
En GUID-formaterad sträng som identifierar prenumerationen. |
| lastRenewalDate | eq, ne, gt, lt, , , gele |
Datumet då prenumerationen senast förnyades. Standardvärdet är null. |
| lastUsageDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationen senast användes. Standardvärdet är null. |
| partnerId | eq, ne |
The PartnerID. För en direkt återförsäljare är det här värdet partner-ID för partnern. För en indirekt återförsäljare är det här värdet partner-ID för den indirekta återförsäljaren. |
| partnerName | sträng | Namnet på partnern som prenumerationen köptes för |
| productName | contains, , eqne |
Namnet på produkten. |
| providerName | sträng | När prenumerationstransaktionen är för den indirekta återförsäljaren är providernamnet den indirekta provider som köpte prenumerationen. |
| status | eq, ne |
Prenumerationsstatus. Värden som stöds är: ACTIVE, SUSPENDED eller DEPROVISIONED. |
| subscriptionType | eq, ne |
Prenumerationstypen. Obs! Det här fältet är skiftlägeskänsligt. Värden som stöds är: Office, Azure, Microsoft365, Dynamics, EMS. |
| trialStartDate | eq, ne, gt, lt, , , gele |
Det datum då utvärderingsperioden för prenumerationen startade. Standardvärdet är null. |
| trialToPaidConversionDate | eq, ne, gt, lt, , , gele |
Det datum då prenumerationen konverteras från utvärderingsversion till betald. Standardvärdet är null. |
Begärandehuvuden
Mer information finns i REST-huvuden för Partnercenter.
Begärandetext
Inga.
Exempel på begäran
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-svar
Om det lyckas innehåller svarstexten en samling prenumerationsresurser som uppfyller filtervillkoren.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Felkoder.
Svarsexempel
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
}