Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Van toepassing op: Partnercentrum | Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud for US Government
Informatie over abonnementsanalyse voor uw klanten, gegroepeerd op datums of voorwaarden.
Vereisten
- Referenties zoals beschreven in Partnercentrum-verificatie. Dit scenario ondersteunt verificatie met alleen gebruikersreferenties.
REST-aanvraag
Aanvraagsyntaxis
| Methode | Aanvraag-URI |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries} |
URI-parameters
Gebruik de volgende vereiste padparameters om uw organisatie te identificeren en de resultaten te groeperen.
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| groupby_queries | paren van tekenreeksen en datum/tijd | Yes | De termen en datums om het resultaat te filteren. |
GroupBy-syntaxis
De groepeer op parameter moet zijn samengesteld als een reeks door komma's gescheiden veldwaarden.
Een niet-gecodeerd voorbeeld ziet er als volgt uit:
?groupby=termField1,dateField1,termField2
In de volgende tabel ziet u een lijst met de ondersteunde velden voor groeperen op.
| Veld | Type | Beschrijving |
|---|---|---|
| customerTenantId | tekenreeks | Een tekenreeks in GUID-indeling die de tenant van de klant identificeert. |
| customerName | tekenreeks | De naam van de klant. |
| customerMarket | tekenreeks | Het land/de regio waarin de klant zaken doet. |
| id | tekenreeks | Een tekenreeks in GUID-indeling die het abonnement identificeert. |
| status | tekenreeks | De abonnementsstatus. Ondersteunde waarden zijn: 'ACTIVE', 'SUSPENDED' of 'DEPROVISIONED'. |
| Productnaam | tekenreeks | De naam van het product. |
| subscriptionType | tekenreeks | Het abonnementstype. Opmerking: dit veld is hoofdlettergevoelig. Ondersteunde waarden zijn: 'Office', 'Azure', 'Microsoft365', 'Dynamics', 'EMS'. |
| autoRenewEnabled | Booleaans | Een waarde die aangeeft of het abonnement automatisch wordt verlengd. |
| partnerId | tekenreeks | De PartnerID. Voor een directe reseller is deze parameter de PartnerID van de partner. Voor een indirecte reseller is deze parameter de PartnerID van de indirecte reseller. |
| Friendlyname | tekenreeks | De naam van het abonnement. |
| partnerName | tekenreeks | Naam van de partner voor wie het abonnement is gekocht |
| providerName | tekenreeks | Wanneer de abonnementstransactie voor de indirecte reseller is, is de naam van de provider de indirecte provider die het abonnement heeft gekocht. |
| creationDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop het abonnement is gemaakt. |
| effectiveStartDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop het abonnement ingaat. |
| commitmentEndDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop het abonnement afloopt. |
| currentStateEndDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop de huidige status van het abonnement wordt gewijzigd. |
| trialToPaidConversionDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop het abonnement wordt omgezet van een proefversie naar een betaald abonnement. De standaardwaarde is null. |
| trialStartDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop de proefperiode voor het abonnement is gestart. De standaardwaarde is null. |
| lastUsageDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop het abonnement voor het laatst is gebruikt. De standaardwaarde is null. |
| deprovisionedDate ongedaan maken | tekenreeks in UTC-datum/tijdnotatie | De datum waarop de inrichting van het abonnement is ongedaan gemaakt. De standaardwaarde is null. |
| lastRenewalDate | tekenreeks in UTC-datum/tijdnotatie | De datum waarop het abonnement voor het laatst is verlengd. De standaardwaarde is null. |
Filtervelden
De volgende tabel bevat optionele filtervelden en de bijbehorende beschrijvingen:
| Veld | Type | Beschrijving |
|---|---|---|
| top | int | Het aantal rijen met gegevens dat in de aanvraag moet worden geretourneerd. Als de waarde niet is opgegeven, zijn de maximumwaarde en de standaardwaarde 10000. Als de query meer rijen bevat, bevat de antwoordtekst een volgende koppeling die u kunt gebruiken om de volgende pagina met gegevens op te vragen. |
| skip | int | Het aantal rijen dat in de query moet worden overgeslagen. Gebruik deze parameter om grote gegevenssets te doorlopen. Met top=10000 en skip=0 worden bijvoorbeeld de eerste 10000 rijen met gegevens opgehaald, met top=10000 en met skip=10000 worden de volgende 10000 rijen met gegevens opgehaald. |
| filter | tekenreeks | Een of meer instructies waarmee de rijen in het antwoord worden gefilterd. Elke filterinstructie bevat een veldnaam uit de hoofdtekst van het antwoord en een waarde die is gekoppeld aan de eqoperator , neof voor bepaalde velden contains . -instructies kunnen worden gecombineerd met of andor. Tekenreekswaarden moeten worden omgeven door enkele aanhalingstekens in de filterparameter. Zie de volgende sectie voor een lijst met velden die kunnen worden gefilterd en de operators die worden ondersteund met deze velden. |
| aggregationLevel | tekenreeks | Hiermee geeft u het tijdsbereik op waarvoor geaggregeerde gegevens moeten worden opgehaald. Kan een van de volgende tekenreeksen zijn: dag, week of maand. Als de waarde niet is opgegeven, is de standaardwaarde dateRange. Opmerking: deze parameter is alleen van toepassing wanneer een datumveld wordt doorgegeven als onderdeel van de parameter groupBy. |
| groupBy | tekenreeks | Een instructie waarmee gegevensaggregatie alleen wordt toegepast op de opgegeven velden. |
Aanvraagheaders
Zie Rest-headers van partnercentrum voor meer informatie.
Aanvraagbody
Geen.
Voorbeeld van aanvraag
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
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 hoofdtekst van het antwoord een verzameling abonnementsresources die zijn gegroepeerd op de opgegeven termen en datums.
Geslaagde en foutcodes voor antwoorden
Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat het is gelukt of mislukt en aanvullende informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en aanvullende parameters te lezen. Zie Foutcodes voor 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
{
"Value": [
{
"subscriptionType": "Azure",
"subscriptionCount": "63",
"licenseCount": "0"
},
{
"subscriptionType": "Dynamics",
"subscriptionCount": "62",
"licenseCount": "405"
},
{
"subscriptionType": "EMS",
"subscriptionCount": "39",
"licenseCount": "193"
},
{
"subscriptionType": "M365",
"subscriptionCount": "2",
"licenseCount": "5"
},
{
"subscriptionType": "Office",
"subscriptionCount": "906",
"licenseCount": "7485"
},
{
"subscriptionType": "UNKNOWN",
"subscriptionCount": "104",
"licenseCount": "439"
},
{
"subscriptionType": "Windows",
"subscriptionCount": "2",
"licenseCount": "2"
}
],
"@nextLink": null,
"TotalCount": 7
}