Analysegegevens van abonnementen die is gefilterd met een zoekquery ophalen
Van toepassing op: Partnercentrum | Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid
Informatie over abonnementsanalyse ophalen voor uw klanten die zijn gefilterd op een zoekquery.
Vereisten
- Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario ondersteunt alleen verificatie met gebruikersreferenties.
REST-aanvraag
Aanvraagsyntaxis
| Wijze | Aanvraag-URI |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string} |
URI-parameters
Gebruik de volgende vereiste padparameter om uw organisatie te identificeren en de zoekopdracht te filteren.
| Name | Type | Vereist | Beschrijving |
|---|---|---|---|
| filter_string | tekenreeks | Ja | Het filter dat moet worden toegepast op de abonnementsanalyse. Zie de secties Filtersyntaxis en Filtervelden voor de syntaxis, velden en operators die u in deze parameter kunt gebruiken. |
Filtersyntaxis
De filterparameter moet worden samengesteld als een reeks combinaties van velden, waarden en operatoren. Meerdere combinaties kunnen worden gecombineerd met behulp van and of or operators.
Een niet-gecodeerd voorbeeld ziet er als volgt uit:
- Tekenreeks:
?filter=Field operator 'Value' - Booleaanse:
?filter=Field operator Value - Bevat
?filter=contains(field,'value')
Velden Filteren
De filterparameter van de aanvraag bevat een of meer instructies waarmee de rijen in het antwoord worden gefilterd. Elke instructie bevat een veld en waarde die zijn gekoppeld aan de eq of ne operators. Sommige velden ondersteunen ook de containsoperators , gt, lten gele operators. Instructies kunnen worden gecombineerd met behulp van and of or operators.
Hieronder ziet u voorbeelden van filtertekenreeksen:
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
In de volgende tabel ziet u een lijst met de ondersteunde velden en ondersteuningsoperators voor de filterparameter. Tekenreekswaarden moeten tussen enkele aanhalingstekens staan.
| Parameter | Niet-ondersteunde operators | Beschrijving |
|---|---|---|
| autoRenewEnabled | eq, ne |
Een waarde die aangeeft of het abonnement automatisch wordt verlengd. |
| commitmentEndDate | eq, , negt, lt, , , gele |
De datum waarop het abonnement eindigt. |
| creationDate | eq, , negt, lt, , , gele |
De datum waarop het abonnement is gemaakt. |
| currentStateEndDate | eq, , negt, lt, , , gele |
De datum waarop de huidige status van het abonnement wordt gewijzigd. |
| customerMarket | eq, ne |
Het land/de regio waarin de klant zaken doet. |
| customerName | contains |
De naam van de klant. |
| customerTenantId | eq, ne |
Een tekenreeks met GUID-indeling die de tenant van de klant identificeert. |
| deprovisionedDate ongedaan maken | eq, , negt, lt, , , gele |
De datum waarop het abonnement ongedaan is gemaakt. De standaardwaarde is null. |
| effectiveStartDate | eq, , negt, lt, , , gele |
De datum waarop het abonnement begint. |
| Friendlyname | contains |
De naam van het abonnement. |
| id | eq, ne |
Een tekenreeks met GUID-indeling die het abonnement identificeert. |
| lastRenewalDate | eq, , negt, lt, , , gele |
De datum waarop het abonnement voor het laatst is verlengd. De standaardwaarde is null. |
| lastUsageDate | eq, , negt, lt, , , gele |
De datum waarop het abonnement voor het laatst is gebruikt. De standaardwaarde is null. |
| partnerId | eq, ne |
De PartnerID. Voor een directe reseller is deze waarde de Partner-id van de partner. Voor een indirecte reseller is deze waarde de PartnerID van de indirecte reseller. |
| partnernaam | tekenreeks | Naam van de partner voor wie het abonnement is gekocht |
| productName | contains, , eqne |
De naam van het product. |
| providerName | tekenreeks | Wanneer de abonnementstransactie voor de indirecte reseller is, is providernaam de indirecte provider die het abonnement heeft gekocht. |
| status | eq, ne |
De abonnementsstatus. Ondersteunde waarden zijn: ACTIEF, ONDERBROKEN of DEPROVISIONED. |
| subscriptionType | eq, ne |
Het abonnementstype. Opmerking: dit veld is hoofdlettergevoelig. Ondersteunde waarden zijn: Office, Azure, Microsoft365, Dynamics, EMS. |
| trialStartDate | eq, , negt, lt, , , gele |
De datum waarop de proefperiode voor het abonnement is gestart. De standaardwaarde is null. |
| trialToPaidConversionDate | eq, , negt, lt, , , gele |
De datum waarop het abonnement wordt omgezet van een proefversie naar een betaald abonnement. De standaardwaarde is null. |
Aanvraagheaders
Zie Rest-headers in Partnercentrum voor meer informatie.
Aanvraagtekst
Geen.
Aanvraagvoorbeeld
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-antwoord
Als dit lukt, bevat de antwoordtekst een verzameling abonnementsbronnen die voldoen aan de filtercriteria.
Geslaagde antwoorden en foutcodes
Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de informatie over geslaagde of mislukte fouten en foutopsporing wordt aangegeven. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie Foutcodes voor de volledige lijst.
Responsvoorbeeld
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
}