Számlázott és korlátlan napi névleges használati egyeztetési API v2 (GA)
A következőkre vonatkozik: Partnerközpont (nem érhető el az Azure Governmentben, az Azure Germanyben vagy az Azure China 21Vianetben.)
Az aszinkron API-k gyorsabb és kezelhetőbb módot kínálnak a számlázási és egyeztetési adatok Azure-blobokon keresztüli elérésére. Ezekkel az API-kkal nem kell órákig nyitva tartania a kapcsolatot, és nem kell 2000 sortétel kötegeit végighaladnia.
Az új kereskedelmi napi besorolású használategyeztetési API-kat valet kulcs és aszinkron kérés-válasz minták használatával optimalizáltuk. Ha ezeket az API-kat használja, egy jogkivonatot kap, amellyel hozzáférhet az összes attribútumhoz vagy a napi névleges használat egyeztetési adatainak egy részhalmazához.
Feljegyzés
Az új API-k nem a Partnerközpont API-gazdagépén futnak. Ehelyett megtalálhatja őket az MS Graph-on a Microsoft Graph API használatával a partner számlázási adatainak exportálásához – Microsoft Graph v1.0 | Microsoft Learn. Ezeknek az API-knak a eléréséhez tekintse meg az alábbi részleteket.
Ezeket az API-kat csak most használhatja az MS Graph nyilvános/globális felhőhöz. Ezek még nem érhetők el az Azure Government, az Azure Germany vagy az Azure China 21Vianet esetében.
Feljegyzés
Ha a bétaverziót használta, előfordulhat, hogy nem tapasztal jelentős változásokat az általánosan elérhető (GA) verzióban. Javasoljuk, hogy hasonlítsa össze a két verziót a különbségek és a frissítések megértéséhez.
Fontos
Az új kereskedelmi napi névleges használat nem tartalmazza az alábbi termékek díjait:
- Azure-foglalás
- Azure megtakarítási terv
- Office
- Dynamics
- Microsoft Power Apps
- Állandó szoftver
- Szoftver-előfizetés
- Nem Microsoft SaaS-termék
API – Áttekintés
Ha aszinkron módon szeretné lekérni az új kereskedelmi napi besorolású használati sorelemeket, használjon két API-végpontot. Ennek folyamata a következő:
Használati sorelem végpontja
Ezzel az API-val lekérheti a számlázott vagy a nem számlázott napi névleges használati sorok elemeit. 202 HTTP-állapotot és egy URL-címet kap a hely fejlécében. Ezt az URL-címet rendszeres időközönként lekérdezheti, amíg meg nem kapja a sikeres állapotot egy jegyzék URL-címmel.
Műveleti állapot végpontja
A sikeres állapot eléréséhez rendszeresen hívja meg ezt az API-t. Ha az adatok nem állnak készen, az API-válasz tartalmaz egy Újrapróbálkozási fejlécet, amelyből megtudhatja, hogy mennyi ideig kell várnia, mielőtt újra próbálkozna. Ha a művelet befejeződött, egy jegyzékerőforrást kap egy tármappával, ahol letöltheti a használati adatokat. A válasz kisebb részekre bontja a fájlokat az optimalizált átviteli sebesség és az I/O-párhuzamosság érdekében.
Szekvenciadiagram
Íme egy szekvenciadiagram, amely az egyeztetési adatok letöltésének lépéseit mutatja be.
Felhasználói műveletütemezés
Az új kereskedelmi napi besorolású használat egyeztetési sorelemek lekéréséhez kövesse az alábbi lépéseket:
1. lépés: Kérelem elküldése
POST-kérés elküldése az API-végpontnak.
Korlátlan napi névleges használati sorelemek lekérése
Szerezze be az aktuális vagy az utolsó naptári hónapra vagy számlázási időszakra vonatkozó, korlátlan napi névleges használati sorelemeket.
API-kérés
POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/unbilled/export
Accept: application/json
Content-Type: application/json
{
"currencyCode": "USD",
"billingPeriod": "current",
"attributeSet": "basic"
}
Kérés törzse
| Attribútum | Kötelező | Típus | Leírás |
|---|---|---|---|
| attributeSet | Hamis | Sztring | Az összes attribútumnál válassza a "full" vagy a "basic" (alapszintű) lehetőséget egy korlátozott készlethez. Az alapértelmezett érték a "teljes". (Az attribútumok listáját itt tekintheti meg). Opcionális. |
| billingPeriod | Igaz | Sztring | Az "aktuális" vagy az "utolsó" (ugyanaz, mint az "előző" a V1 API-kban) használatával lekérheti az aktuális vagy az utolsó naptári hónapra vagy számlázási időszakra vonatkozó napi névleges használatot. Szükséges. |
| currencyCode | Igaz | Sztring | Partner számlázási pénznemkódja. Szükséges. |
Kérésfejlécek
Az API fejléceinek lekéréséhez tekintse meg a megbízhatóságot és a támogatást.
API-válasz
HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14
Az API használatakor általában HTTP 202-es állapotot ad vissza. Ha további lehetséges állapotokat szeretne látni a kérései alapján, tekintse meg a Standard API válaszállapotait.
| Kód | Leírás |
|---|---|
| 202 – Elfogadva | A kérést elfogadták. A kérés állapotának ellenőrzéséhez kérje le a hely fejlécében megadott URL-címet. |
Számlázott napi névleges használati sorelemek lekérése
Lekérheti az új kereskedelmi számlázott napi névleges használati sorelemeket a lezárt számlázási időszakra vonatkozó számlához.
API-kérés
POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/billed/export
{
"invoiceId": "G00012345",
"attributeSet": "full"
}
Paraméterek lekérdezése
n/a
Kérés törzse
| Attribútum | Kötelező | Típus | Leírás |
|---|---|---|---|
| invoiceId | Igaz | Sztring | Egyedi azonosító minden számlához. Szükséges. |
| attributeSet | Hamis | Sztring | Az összes attribútumnál válassza a "full" vagy a "basic" (alapszintű) lehetőséget egy korlátozott készlethez. Az alapértelmezett érték a "teljes". (Az attribútumok listáját itt tekintheti meg). Opcionális. |
Kérelem fejléce
Az API fejléceinek kérése. További információkért tekintse meg a megbízhatóságot és a támogatást.
API-válasz
HTTP/1.1 202 Elfogadva
Hely: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14
Az API használatakor általában HTTP 202-es állapotot ad vissza. A kéréseken alapuló egyéb lehetséges állapotokért tekintse meg az Állapotok című témakört.
| Kód | Leírás |
|---|---|
| 202 – Elfogadva | A kérést elfogadták. A kérés állapotának ellenőrzéséhez kérje le a hely fejlécében megadott URL-címet. |
2. lépés: A kérelem állapotának ellenőrzése
A kérés állapotának ellenőrzéséhez várjon egy HTTP 200-válaszra, amely "sikeres" vagy "sikertelen" állapotú. Ha a kérés sikeres, a jegyzék URL-címét a "resourceLocation" attribútum adja meg.
Művelet állapotának lekérése
Lekéri egy kérés állapotát.
API-kérés
Kérelemparaméterek
| Név | Belefoglalás a következőbe: | Kötelező | Típus | Leírás |
|---|---|---|---|---|
| operationId | Kérés URI-ja | Igaz | Sztring | Egyedi azonosító a kérés állapotának ellenőrzéséhez. Szükséges. |
Kérelem fejléce
Az API fejléceinek lekéréséhez tekintse meg a megbízhatóságot és a támogatást.
Kérés törzse
N/A.
Reagálási állapot
A szabványos HTTP-állapotok mellett az API a következő HTTP-állapotot is visszaadhatja:
| Kód | Leírás |
|---|---|
| 410 – Eltűnt | A jegyzékhivatkozás csak a kiszolgáló által megadott időtartamig aktív. Az idő leteltét követően be kell küldenie egy új kérést a jegyzék eléréséhez. |
Válasz hasznos adatai
Az API-válasz hasznos adatai a következő attribútumokat tartalmazzák:
| Attribútum | Kötelező | Leírás |
|---|---|---|
| id | Igaz | Egyedi azonosító minden válaszhoz. Szükséges. |
| status | Igaz | Értékek és műveletek (kötelező): notstarted: Várja meg az "Újrapróbálkozott" fejlécben megadott időt, majd hozzon létre egy újabb hívást az állapot ellenőrzéséhez. futtatás: Várja meg az "Újrapróbálkozás után" fejlécben megadott időt, majd hozzon létre egy újabb hívást az állapot ellenőrzéséhez. sikeres: Az adatok készen állnak. Kérje le a jegyzékbeli hasznos adatokat a resourceLocationban megadott URI használatával. sikertelen: A művelet véglegesen meghiúsult. Indítsa újra. |
| createdDateTime | Igaz | A kérés teljesítésének időpontja. Szükséges. |
| lastActionDateTime | Igaz | Az állapot legutóbbi módosításának időpontja. Szükséges. |
| resourceLocation | Hamis | A jegyzékbeli hasznos adatok URI-ja. Opcionális. |
| error | Hamis | Ha a művelet sikertelen, a hiba részletei JSON formátumban jelennek meg. Opcionális. A következő attribútumok lehetnek a következők: üzenet (Kötelező): A hiba részletes leírása. kód (Kötelező): A hiba típusa. |
Erőforrás-hely objektum
API-kérés
GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>
API-válasz
A válasz azt javasolja, hogy 10 másodpercig vár, mielőtt újra próbálkozna az adatok feldolgozásakor.
HTTP/1.1 200 OK
Retry-After: 10
{
"id": "9ab9cb54-d07f-4f52-9ea6-a09d7de52c14",
"createdDateTime": "2022-06-1T10-01-03.4Z",
"lastActionDateTime": "2022-06-1T10-01-05Z",
"status": "running"
}
API-kérés
(10 másodperccel az előző kérés után...)
GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>
API-válasz
Az API a "sikeres" állapotot és a resourceLocation URI-t adja vissza.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/\$metadata#reports/partners/billing/operations/\$entity",
"@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation",
"id": "f2170b13-6a8e-47d6-b481-6988490dc0cb",
"createdDateTime": "2023-12-05T21:17:29Z",
"lastActionDateTime": "2023-12-05T21:18:00.8897902Z",
"status": "succeeded",
"resourceLocation": {
"id": "44e8500b-ab92-490e-8ac3-90500a1d3427",
"createdDateTime": "2023-11-06T19:58:47.513Z",
"schemaVersion": "2",
"dataFormat": "compressedJSON",
"partitionType": "default",
"eTag": "RwDrn7fbiTXy6UULE",
"partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0",
"rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/path_id",
"sasToken": "{token}",
"blobCount": 1,
"blobs": \[
{
"name": "part-00123-5a93fa5d-749f-48bc-a372-9b021d93c3fa.c000.json.gz",
"partitionValue": "default"
}
\]
}
}
3. lépés: Napi besorolású használati egyeztetési sorelemek letöltése az Azure Blob Storage-ból
Kérje le a közös hozzáférésű jogosultságkód (SAS) jogkivonatot és a blobtároló helyét a "sasToken" és a "rootDirectory" tulajdonságból, amely a jegyzék hasznos api-válaszát tartalmazza. Az Azure Storage SDK/eszköz használatával töltse le és bontsa ki a blobfájlt. JSONLines formátumban van.
Tipp.
Tekintse meg a mintakódot , amely letölti és kibontja az Azure-blobfájlt a helyi adatbázisba.
Standard API-válaszállapotok
Ezeket a HTTP-állapotokat az API-válaszból kaphatja meg:
| Kód | Leírás |
|---|---|
| 400 – Hibás kérés | A kérelem hiányzik, vagy helytelen adatokat tartalmaz. A hiba részleteiért tekintse meg a válasz törzsét. |
| 401 – Jogosulatlan | A hívó nincs hitelesítve, és az első hívás megkezdése előtt hitelesítenie kell magát a partner API szolgáltatással. |
| 403 – Tiltott | Nem rendelkezik a kérés teljesítéséhez szükséges engedéllyel. |
| 404 – Nem található | A kért erőforrások nem érhetők el a megadott bemeneti paraméterekkel. |
| 410 – Eltűnt | A jegyzékhivatkozás időtúllépést vagy lejárt. Küldjön be egy új kérést. |
| 500 – Belső kiszolgálóhiba | Az API vagy annak egyik függősége jelenleg nem tudja teljesíteni a kérést. Próbálkozzon újra később. |
| 5000 – Nincs elérhető adat | A rendszer nem rendelkezik adatokkal a megadott bemeneti paraméterekhez. |
Béta- és GA-verziók összehasonlítása
Az összehasonlító táblázatban megismerheti a bétaverzió és az általánosan elérhető (GA) verziók közötti különbségeket. Ha a bétaverziót használja, a GA-verzióra való váltásnak egyszerűnek kell lennie.
| Fontos információk | Beta | Általánosan elérhető |
|---|---|---|
| API-gazdagép végpontja | https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/ |
https://graph.microsoft.com/v1.0/reports/partners/billing/usage/ |
| HTTP method | POST | POST |
| Korlátlan napi névleges használati API-végpont | https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/unbilledusage |
https://graph.microsoft.com/v1.0/reports/partners/billing/usage/unbilled/export |
| Bemeneti paraméterek a korlátlan napi névleges használati API-hoz | Ha paramétereket szeretne megadni az API-kérésben, adja meg őket a kérelem URL-címének lekérdezési sztringjében. Az időszak és a currencyCode paraméterek megadásához például fűzze hozzá ?period=current¤cyCode=usd a kérelem URL-címét. |
Bemenetek megadásához adjon meg egy JSON-objektumot a kérelem törzsében. A JSON-objektumnak a következő tulajdonságokat kell tartalmaznia: * currencyCode: A számla pénznemkódja. Például USD. * billingPeriod: A számla számlázási időszaka. Például aktuális. Íme egy példa egy JSON-objektumra, amely tartalmazza a currencyCode és billingPeriod tulajdonságokat: <br>{<br> "currencyCode": "USD",<br> "billingPeriod": "current"<br>} |
| Számlázott napi névleges használati API-végpont | https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billedusage/invoices/{InvoiceId} |
https://graph.microsoft.com/v1.0/reports/partners/billing/usage/billed/export |
| Bemeneti paraméterek a számlázott napi névleges használati API-hoz | Az API-kérés paramétereinek megadásához adja meg a invoiceId azonosítót a kérelem URL-címében. Emellett egy választható töredékparamétert is megadhat a lekérdezési sztringben a teljes attribútumkészlet lekéréséhez. Például a teljes attribútumkészlet lekéréséhez fűzze hozzá ?fragment=full a kérelem URL-címét. |
Bemenetek megadásához adjon meg egy JSON-objektumot a kérelem törzsében. A JSON-objektumnak a következő tulajdonságokat kell tartalmaznia: * invoiceId: A számla azonosítója. Például G00012345. * attributeSet: A válaszban szerepeltetni kívánt attribútumok halmaza. Például megtelt. Íme egy példa egy JSON-objektumra, amely tartalmazza a invoiceId és az attributeSet tulajdonságokat: {<br> "invoiceId": "G00012345",<br> "attributeSet": "full"<br>} |
| Jegyzék-erőforrás | A jegyzékerőforrás lekéréséhez használjon egy külön GET /manifests/{id} metódust. | Használja a GET /operations/{Id} metódust, amely a resourceLocation kapcsolódó jegyzékerőforrását adja vissza, így nincs szükség külön hívásra a GET /manifests/{id} metódushoz. |
| A jegyzékséma módosítása | ||
| "id": Nem érhető el | "id": A jegyzék-erőforrás egyedi azonosítója. | |
| "verzió": Elérhető | "verzió": átnevezve a "schemaversion" névre. | |
| "dataFormat": Elérhető | "dataFormat": Elérhető. | |
| "utcCretedDateTime": Elérhető | "utcCretedDateTime": átnevezve a következőre: "createdDateTime". | |
| "eTag": Elérhető | "eTag": Elérhető. | |
| "partnerTenantId": Elérhető | "partnerTenantId": Elérhető | |
| "rootFolder": Elérhető | "rootFolder": átnevezve a "rootDirectory" névre. | |
| "rootFolderSAS": Elérhető | "rootFolderSAS": átnevezve a "sasToken" névre. Most már biztosít egy jogkivonatot, és már nem tartalmazza a gyökérkönyvtár elérési útját. A címtár eléréséhez használja inkább a "rootDirectory" tulajdonságot. | |
| "partitionType": Elérhető | "partitionType": Elérhető. | |
| "blobCount": Elérhető | "blobCount": Elérhető. | |
| "sizeInBytes": Elérhető | "sizeInBytes": Nem érhető el. | |
| "blobok": elérhető | "blobok": Elérhető. | |
| "blobobjektum": Elérhető | "blobobjektum": Elérhető. | |
| "name": Elérhető | "name": Elérhető. | |
| "partitionValue": Elérhető | "partitionValue": Elérhető. |
Napi névleges használat egyeztetési sorelem-attribútumai
A "teljes" vagy az "alapszintű" attribútumkészletek napi névleges használati egyeztetési API-ja által visszaadott attribútumok összehasonlításához tekintse meg az alábbi információkat.
| Attribútum | Teljes | Alap |
|---|---|---|
| Partnerazonosító | igen | igen |
| PartnerName | igen | igen |
| Vevőkód | igen | igen |
| CustomerName | igen | Igen |
| CustomerDomainName | igen | nem |
| CustomerCountry | igen | nem |
| MpnId | igen | nem |
| Tier2MpnId | igen | nem |
| InvoiceNumber | igen | igen |
| ProductId | igen | igen |
| Termékváltozat azonosítója | igen | igen |
| Rendelkezésre állási azonosító | igen | nem |
| SkuName | igen | igen |
| ProductName | igen | nem |
| Közzétevő neve | igen | igen |
| PublisherId | igen | nem |
| SubscriptionDescription | igen | nem |
| SubscriptionId | igen | igen |
| ChargeStartDate | igen | igen |
| ChargeEndDate | igen | igen |
| UsageDate | igen | igen |
| MeterType | igen | nem |
| MeterCategory | igen | nem |
| MeterId | igen | nem |
| MeterSubCategory | igen | nem |
| MeterName | igen | nem |
| MeterRegion | igen | nem |
| Unit (Egység) | igen | igen |
| ResourceLocation | igen | nem |
| ConsumedService | igen | nem |
| ResourceGroup | igen | nem |
| ResourceURI | igen | igen |
| ChargeType | igen | igen |
| Egységár | igen | igen |
| Mennyiség | igen | igen |
| UnitType | igen | nem |
| BillingPreTaxTotal | igen | igen |
| BillingCurrency | igen | igen |
| PricingPreTaxTotal | igen | igen |
| PricingCurrency | igen | igen |
| ServiceInfo1 | igen | nem |
| ServiceInfo2 | igen | nem |
| Címkék | igen | nem |
| További információk (Info) | igen | nem |
| EffectiveUnitPrice | igen | igen |
| PCToBCExchangeRate | igen | igen |
| Jogosultságazonosító | igen | igen |
| EntitlementDescription | igen | nem |
| PartnerEarnedCreditPercentage | igen | nem |
| CreditPercentage | igen | igen |
| CreditType | igen | igen |
| BenefitOrderID | igen | igen |
| BenefitID | igen | nem |
| BenefitType | igen | igen |
Fontos
Jegyezze fel ezeket a módosításokat, amikor az API 2-es verziójára vált az 1- es verzióról.
Minden attribútum neve nagybetűvel kezdődik.
A unitOfMeasure most egység. Az attribútum jelentése és értéke megegyezik.
resellerMpnId most Tier2MpnId. Az attribútum jelentése és értéke megegyezik.
A rateOfPartnerEarnedCredit neve és értéke PartnerEarnedCreditPercentage értékre módosult. Az attribútum új neve és értéke a tört helyett a százalékos értéket tükrözi. Például a 0.15 most 15.
rateOfCredit most CreditPercentage. Az attribútum jelentése és értéke megváltozott. Például az 1.00 most 100.
Mintakód
További információ: Partnerközpont API-minták: Számlázási adatok lekérése.
Visszajelzés
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ: https://aka.ms/ContentUserFeedback.
Visszajelzés küldése és megtekintése a következőhöz: