Előfizetés-elemzések lekérése dátumok vagy kifejezések szerint csoportosítva

Cikk
03/08/2023

A következőre vonatkozik: Partnerközpont | A 21Vianet által üzemeltetett Partnerközpont | Partnerközpont Microsoft Cloud for US Government

Előfizetés-elemzési információk lekérése az ügyfelek számára dátumok vagy kifejezések szerint csoportosítva.

Előfeltételek

Hitelesítő adatok a Partnerközpont hitelesítésében leírtak szerint. Ez a forgatókönyv csak a felhasználói hitelesítő adatokkal való hitelesítést támogatja.

REST-kérelem

Kérés szintaxisa

Metódus	Kérés URI-ja
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

URI-paraméterek

Az alábbi kötelező elérésiút-paraméterekkel azonosíthatja a szervezetet, és csoportosíthatja az eredményeket.

Név	Típus	Kötelező	Leírás
groupby_queries	sztringpárok és dateTime	Yes	Az eredmény szűrésére vonatkozó kifejezések és dátumok.

GroupBy szintaxis

A csoportosítást paraméter szerint vesszővel tagolt mezőértékek sorozataként kell összeállítani.

Egy kódolatlan példa így néz ki:

?groupby=termField1,dateField1,termField2

Az alábbi táblázat a csoportosítási szempont támogatott mezőinek listáját tartalmazza.

Mező	Típus	Leírás
customerTenantId	sztring	Egy GUID formátumú sztring, amely azonosítja az ügyfélbérlőt.
customerName	sztring	Az ügyfél neve.
customerMarket	sztring	Az az ország/régió, amelyben az ügyfél üzletel.
id	sztring	Az előfizetést azonosító GUID formátumú sztring.
status	sztring	Az előfizetés állapota. A támogatott értékek a következők: "ACTIVE", "SUSPENDED" vagy "DEPROVISIONED".
Productname	sztring	A termék neve.
subscriptionType	sztring	Az előfizetés típusa. Megjegyzés: Ez a mező megkülönbözteti a kis- és nagybetűktől. Támogatott értékek: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Logikai	Egy érték, amely azt jelzi, hogy az előfizetés automatikusan megújul-e.
partnerazonosító	sztring	A partnerazonosító. Közvetlen viszonteladó esetén ez a paraméter a partner partnerazonosítója lesz. Közvetett viszonteladó esetén ez a paraméter a közvetett viszonteladó PartnerID azonosítója lesz.
friendlyName	sztring	Az előfizetés neve.
partnerNév	sztring	Annak a partnernek a neve, akinek az előfizetést megvásárolták
providerName	sztring	Ha az előfizetési tranzakció a közvetett viszonteladóhoz tartozik, a szolgáltató neve az előfizetést megvásárolt közvetett szolgáltató neve.
creationDate	sztring UTC dátum-idő formátumban	Az előfizetés létrehozásának dátuma.
effectiveStartDate	sztring UTC dátum-idő formátumban	Az előfizetés kezdő dátuma.
commitmentEndDate	sztring UTC dátum-idő formátumban	Az előfizetés megszűnésének dátuma.
currentStateEndDate	sztring UTC dátum-idő formátumban	Az előfizetés aktuális állapotának módosításának dátuma.
trialToPaidConversionDate	sztring UTC dátum-idő formátumban	Az a dátum, amikor az előfizetés próbaverzióról fizetősre vált. Az alapértelmezett érték null.
trialStartDate	sztring UTC dátum-idő formátumban	Az előfizetés próbaidőszakának kezdő dátuma. Az alapértelmezett érték null.
lastUsageDate	sztring UTC dátum-idő formátumban	Az előfizetés utolsó felhasználásának dátuma. Az alapértelmezett érték null.
deprovisionedDate	sztring UTC dátum-idő formátumban	Az előfizetés megszüntetésének dátuma. Az alapértelmezett érték null.
lastRenewalDate	sztring UTC dátum-idő formátumban	Az előfizetés legutóbbi megújításának dátuma. Az alapértelmezett érték null.

Mezők szűrése

Az alábbi táblázat a választható szűrőmezőket és azok leírását sorolja fel:

Mező	Típus	Leírás
top	int	A kérelemben visszaadandó adatsorok száma. Ha az érték nincs megadva, a maximális érték és az alapértelmezett érték 10000. Ha a lekérdezés több sort tartalmaz, a válasz törzse tartalmaz egy következő hivatkozást, amellyel lekérheti a következő adatoldalt.
Ugrál	int	A lekérdezésben kihagyandó sorok száma. Ezzel a paramétersel nagy adatkészleteken haladhat végig. A top=10000 és a skip=0 például lekéri az első 10000 adatsort, a top=10000 és a skip=10000 a következő 10000 adatsort.
filter (szűrő)	sztring	Egy vagy több utasítás, amely a válasz sorait szűri. Minden szűrőutasítás tartalmaz egy mezőnevet a válasz törzséből, és egy értéket, amely a `eq`, `ne`vagy bizonyos mezőkhöz, az `contains` operátorhoz van társítva. Az utasítások kombinálhatók a vagy `or`a használatával`and`. A sztringértékeket a szűrőparaméterben szimpla idézőjelekkel kell körülvenni. A szűrhető mezők és az ezekkel a mezőkkel támogatott operátorok listáját a következő szakaszban találja.
aggregationLevel	sztring	Meghatározza az összesített adatok lekérésének időtartományát. A következő sztringek egyike lehet: nap, hét vagy hónap. Ha az érték nincs megadva, az alapértelmezett érték a dateRange. Megjegyzés: Ez a paraméter csak akkor érvényes, ha a groupBy paraméter részeként dátummezőt ad át.
groupBy	sztring	Egy utasítás, amely csak a megadott mezőkre alkalmazza az adatösszesítést.

Kérésfejlécek

További információ: Partnerközpont REST-fejlécei.

A kérés törzse

Nincsenek.

Példa kérésre

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-válasz

Ha sikerült, a válasz törzse a megadott feltételek és dátumok szerint csoportosított előfizetési erőforrások gyűjteményét tartalmazza.

Sikeres válasz és hibakódok

Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát, valamint további hibakeresési információkat. Használja a hálózati nyomkövetési eszközt a kód, a hibatípus és a további paraméterek olvasásához. A teljes listát lásd: Hibakódok.

Példa válaszra

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
}

Lásd még

Partnerközpont-elemzések – forrásanyagok

Megosztás a következőn keresztül: