Delen via

Gegevens van abonnementsanalyse ophalen die zijn gefilterd op een zoekquery

van toepassing op: Partnercentrum | Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid

Informatie over abonnementsanalyse voor uw klanten opvragen, gefilterd met een zoekquery.

Voorwaarden

REST-aanvraag

Aanvraagsyntaxis

Methode Aanvraag-URI
TOEVOEGEN {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.

Naam Typologie Vereist Beschrijving
filtertekenreeks koord 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 waarde: ?filter=Field operator Value
  • Bevat ?filter=contains(field,'value')

Filtervelden

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 operatoren eq of ne. Sommige velden ondersteunen ook de operators contains, gt, lt, geen le. Uitspraken 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. Stringwaarden moeten tussen enkele aanhalingstekens staan.

Kenmerk Ondersteunde operators Beschrijving
automatisch verlengen ingeschakeld eq, ne Een waarde die aangeeft of het abonnement automatisch wordt verlengd.
einddatum van de verbintenis eq, , negt, lt, , , gele De datum waarop het abonnement eindigt.
aanmaakdatum eq, , negt, lt, , , gele De datum waarop het abonnement is gemaakt.
einddatumHuidigeStatus eq, , negt, lt, , , gele De datum waarop de huidige status van het abonnement wordt gewijzigd.
klantenmarkt eq, ne Het land/de regio waarin de klant zaken doet.
klantNaam contains De naam van de klant.
klantTenantId eq, ne Een GUID-geformatteerde tekenreeks die de klanttentant identificeert.
deprovisionedDate ongedaan maken eq, , negt, lt, , , gele De datum waarop het abonnement is beëindigd. De standaardwaarde is null.
ingangsdatum eq, , negt, lt, , , gele De datum waarop het abonnement begint.
vriendelijkeNaam contains De naam van het abonnement.
identiteit eq, ne Een tekenreeks met GUID-indeling die het abonnement identificeert.
laatsteVerlengingsdatum eq, , negt, lt, , , gele De datum waarop het abonnement voor het laatst is verlengd. De standaardwaarde is null.
laatsteGebruikDatum eq, , negt, lt, , , gele De datum waarop het abonnement voor het laatst is gebruikt. De standaardwaarde is null.
partner-ID 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 koord Naam van de partner voor wie het abonnement is gekocht
productNaam contains, , eqne De naam van het product.
providerNaam koord Wanneer de abonnementstransactie voor de indirecte reseller is, is providernaam de indirecte provider die het abonnement heeft gekocht.
toestand eq, ne De abonnementsstatus. Ondersteunde waarden zijn: ACTIVE, SUSPENDEDof DEPROVISIONED.
abonnementstype eq, ne Het abonnementstype. Opmerking: dit veld is hoofdlettergevoelig. Ondersteunde waarden zijn: Office, Azure, Microsoft365, Dynamics, EMS.
startdatumProefversie eq, , negt, lt, , , gele De datum waarop de proefperiode voor het abonnement is gestart. De standaardwaarde is null.
proefnaarbetaaldConversieDatum eq, , negt, lt, , , gele De datum waarop het abonnement wordt omgezet van een proefversie naar een betaald abonnement. De standaardwaarde is null.

Aanvraagheaders

Zie Partnercentrum REST-headersvoor meer informatie.

Aanvraaginhoud

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 inhoud van de reactie een verzameling Abonnement bronnen die voldoen aan de filtercriteria.

Geslaagde antwoorden en foutcodes

Elk antwoord komt met een HTTP-statuscode die aangeeft of het succesvol of mislukt is, samen met foutopsporingsinformatie. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie Foutcodesvoor de volledige lijst.

Voorbeeld van antwoord

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
}

Zie ook

  • Last updated on