Előfizetés keresési lekérdezés szerint szűrt elemzési adatainak lekérése
A következőre vonatkozik: Partnerközpont | A 21Vianet által üzemeltetett Partnerközpont | Partnerközpont a Microsoft Cloud for US Government számára
Előfizetés-elemzési információk lekérése az ügyfelek számára keresési lekérdezéssel szűrve.
Előfeltételek
- Hitelesítő adatok a Partnerközpont hitelesítésében leírtak szerint. Ez a forgatókönyv csak felhasználói hitelesítő adatokkal támogatja a hitelesítést.
REST-kérés
Kérés szintaxisa
| Metódus | Kérés URI-ja |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string} |
URI-paraméterek
A szervezet azonosításához és a keresés szűréséhez használja a következő kötelező elérésiút-paramétert.
| Name | Type | Kötelező | Leírás |
|---|---|---|---|
| filter_string | sztring | Igen | Az előfizetés-elemzésre alkalmazandó szűrő. Tekintse meg az ebben a paraméterben használni kívánt szintaxis, mezők és operátorok Szűrés szintaxisa és Szűrés mezői szakaszát. |
Szűrőszintaxis
A szűrőparamétert mező-, érték- és operátorkombinációk sorozataként kell összeállítani. Több kombináció is kombinálható operátorokkal vagy or operátorokkaland.
Egy kódolatlan példa a következőképpen néz ki:
- Karakterlánc:
?filter=Field operator 'Value' - Logikai:
?filter=Field operator Value - Tartalmaz
?filter=contains(field,'value')
Mezők szűrése
A kérelem szűrőparamétere egy vagy több utasítást tartalmaz, amelyek a válasz sorait szűrik. Minden utasítás tartalmaz egy mezőt és egy értéket, amely az eq vagy ne operátorokhoz van társítva. Egyes mezők támogatják a contains, gt, lt, geés le operátorokat is. Az utasítások kombinálhatók operátorokkal vagy or operátorokkaland.
Az alábbiakban példákat láthat a szűrősztringekre:
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
Az alábbi táblázat a szűrőparaméter támogatott mezőinek és támogatási operátorainak listáját mutatja be. A sztringértékeket egyetlen idézőjelnek kell körülvennie.
| Paraméter | Támogatott operátorok | Leírás |
|---|---|---|
| autoRenewEnabled | eq, ne |
Érték, amely jelzi, hogy az előfizetés automatikusan megújul-e. |
| commitmentEndDate | eq, ne, gt, ltgele |
Az előfizetés megszűnésének dátuma. |
| creationDate | eq, ne, gt, ltgele |
Az előfizetés létrehozásának dátuma. |
| currentStateEndDate | eq, ne, gt, ltgele |
Az előfizetés aktuális állapotának változásának dátuma. |
| customerMarket | eq, ne |
Az az ország/régió, amelyben az ügyfél üzletel. |
| customerName | contains |
Az ügyfél neve. |
| customerTenantId | eq, ne |
Egy GUID formátumú sztring, amely azonosítja az ügyfél-bérlőt. |
| deprovisionedDate | eq, ne, gt, ltgele |
Az előfizetés megszüntetésének dátuma. Az alapértelmezett érték null. |
| effectiveStartDate | eq, ne, gt, ltgele |
Az előfizetés kezdő dátuma. |
| friendlyName | contains |
Az előfizetés neve. |
| id | eq, ne |
Az előfizetést azonosító GUID formátumú sztring. |
| lastRenewalDate | eq, ne, gt, ltgele |
Az előfizetés legutóbbi megújításának dátuma. Az alapértelmezett érték null. |
| lastUsageDate | eq, ne, gt, ltgele |
Az előfizetés utolsó használatának dátuma. Az alapértelmezett érték null. |
| partnerazonosító | eq, ne |
A partnerazonosító. Közvetlen viszonteladó esetén ez az érték a partner partnerazonosítója. Közvetett viszonteladó esetén ez az érték a közvetett viszonteladó partnerazonosítója. |
| partnerNév | sztring | Annak a partnernek a neve, akinek az előfizetést megvásárolták |
| Productname | contains, , eqne |
A termék neve. |
| 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ó. |
| status | eq, ne |
Az előfizetés állapota. A támogatott értékek a következők: AKTÍV, FELFÜGGESZTVE vagy DEPROVISIONED. |
| subscriptionType | eq, ne |
Az előfizetés típusa. Megjegyzés: Ez a mező megkülönbözteti a kis- és nagybetűk értékét. A támogatott értékek a következők: Office, Azure, Microsoft365, Dynamics, EMS. |
| trialStartDate | eq, ne, gt, ltgele |
Az előfizetés próbaidőszakának kezdő dátuma. Az alapértelmezett érték null. |
| trialToPaidConversionDate | eq, ne, gt, ltgele |
Az a dátum, amikor az előfizetés a próbaverzióból fizetőssé alakul. Az alapértelmezett érték null. |
Kérésfejlécek
További információ: Partnerközpont – REST fejlécek.
Kérés törzse
Nincs.
Példa kérése
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-válasz
Ha sikeres, a válasz törzse olyan előfizetési erőforrások gyűjteményét tartalmazza, amelyek megfelelnek a szűrési feltételeknek.
Válasz sikeresség és hibakódok
Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát és a hibakeresési információkat. A kód, hibatípus és egyéb paraméterek olvasásához használjon hálózati nyomkövetési eszközt. A teljes listát a Hibakódok című témakörben találja.
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
{
"customerTenantId": "735920EB-A564-4C72-9FE5-52632562712C",
"customerName": "SURFACE TEST2",
"customerMarket": "US",
"id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
"status": "ACTIVE",
"productName": "UNKNOWN",
"subscriptionType": "Azure",
"autoRenewEnabled": true,
"partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
"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
}