Azure Enterprise REST API-k
Ez a cikk az Azure nagyvállalati regisztrációhoz használható REST API-kat ismerteti. Ezenkívül azt is bemutatja, hogyan háríthatja el a REST API-k leggyakoribb hibáit.
Fogyasztási és használati API-k
A Microsoft Nagyvállalati Szerződéssel rendelkező Azure-ügyfelek a REST API-kon keresztül kérhetik le a használati és számlázási információkat. A szerepkör-tulajdonosnak (Enterprise Rendszergazda istrator, Department Rendszergazda istrator, account owner) engedélyeznie kell az API elérését egy kulcs Azure Portalról történő generálásával. Ezután a regisztrációs szám és kulcs tulajdonában bárki hozzáférhet az adatokhoz az API-n keresztül.
Elérhető API-k
Egyenleg és összefoglalás – A Balance és Summary API havi összefoglaló információkat nyújt az egyenlegekről, az új vásárlásokról, az Azure Marketplace szolgáltatási díjairól, a kiigazításokról és a többletköltségekről. További információt a Nagyvállalati ügyfeleknek elérhető jelentéskészítési API-k – Egyenleg és összefoglalás rész tartalmaz.
Használati adatok – A Usage Details API a felhasznált mennyiségek napi részletezését és az adott regisztrációhoz kapcsolódó becsült költségeket jeleníti meg. Az eredmény a példányokkal, mérőszámokkal és részlegekkel kapcsolatos információkat is tartalmazza. Az API lekérdezhető számlázási időszak vagy egy megadott kezdő és záró dátum alapján. További információt a Nagyvállalati ügyfeleknek elérhető jelentéskészítési API-k – Használati adatok rész tartalmaz.
Marketplace-díjak – A Marketplace Store Charge API a megadott számlázási időszakra, illetve a kezdési és befejezési dátumokra vonatkozóan napi bontásban adja vissza a használaton alapuló Marketplace-díjakat. További információt a Nagyvállalati ügyfeleknek elérhető jelentéskészítési API-k – Marketplace-díjak rész tartalmaz.
Árlista – A Price Sheet API a regisztrációs és számlázási időszakokra vonatkozóan az egyes mérők esetében érvényes díjszabást biztosítja. További információt a Nagyvállalati ügyfeleknek elérhető jelentéskészítési API-k – Árlista rész tartalmaz.
Számlázási időszakok – A Billing Periods API olyan számlázási időszakok listáját adja vissza, amelyekben egy regisztráció használati adatai szerepelnek fordított időrendi sorrendben. Minden időszak tartalmazza a négy következő adathalmaz API-útvonalára mutató egyik tulajdonságot: BalanceSummary, UsageDetails, Marketplace Charges és Price Sheet. További információt a Nagyvállalati ügyfeleknek elérhető jelentéskészítési API-k – Számlázási időszakok rész tartalmaz.
API-kulcsok létrehozása
A szerepkör-tulajdonosok az alábbi lépéseket hajthatják végre az Azure Portalon az API-adathozzáférés engedélyezéséhez.
- Jelentkezzen be az Azure Portalra.
- Keresse meg a Cost Management + Számlázás lehetőséget, majd válassza ki.
- Válassza ki a navigációs menüből a Számlázási hatókörök lehetőséget, majd válassza ki a használni kívánt számlázási fiókot.
- A bal oldali navigációs menüben válassza a Használat + Díjak lehetőséget.
- Az API-hozzáférési kulcsok kezelése ablak megnyitásához válassza a Manage API Access Keys (API-hozzáférési kulcsok kezelése) lehetőséget.
Az API hozzáférési kulcsainak kezelése ablakban a következő feladatokat hajthatja végre:
- Elsődleges és másodlagos hozzáférési kulcsok létrehozása és megtekintése
- Hozzáférési kulcsok kezdő és záró dátumainak megtekintése
- Hozzáférési kulcsok letiltása
Feljegyzés
- Ha a Regisztráció Rendszergazda, akkor a kulcsokat csak a Használat és díjak panelről hozhatja létre a regisztráció szintjén, a Fiókok > részleg szintjén azonban nem.
- Ha Csak részlegtulajdonos, akkor a kulcsokat részlegszinten és azon fiókszinten hozhatja létre, amelyhez ön a fiók tulajdonosa.
- Ha csak fióktulajdonos, akkor csak fiókszinten hozhatja létre a kulcsokat.
Az elsődleges vagy másodlagos API-kulcs létrehozása
- Jelentkezzen be az Azure Portalra vállalati rendszergazdaként.
- Válassza ki a Költségkezelés + számlázás lehetőséget.
- Válassza ki a navigációs menüből a Számlázási hatókörök lehetőséget, majd válassza ki a használni kívánt számlázási fiókot.
- A navigációs menüben válassza a Használat + Díjak lehetőséget.
- Válassza az API-hozzáférési kulcsok kezelése lehetőséget.
- Válassza a Generálás lehetőséget a kulcs létrehozásához.
- Válassza a kibontás szimbólumot, vagy válassza a Másolás lehetőséget az API hozzáférési kulcs azonnali használatához.
Az elsődleges vagy másodlagos API-kulcs újragenerálása
- Jelentkezzen be az Azure Portalra vállalati rendszergazdaként.
- Válassza ki a Költségkezelés + számlázás lehetőséget.
- Válassza ki a navigációs menüből a Számlázási hatókörök lehetőséget, majd válassza ki a használni kívánt számlázási fiókot.
- A navigációs menüben válassza a Használat + Díjak lehetőséget.
- Válassza az API-hozzáférési kulcsok kezelése lehetőséget.
- Válassza az Újragenerálás lehetőséget a kulcs újragenerálásához.
Az elsődleges vagy másodlagos API-kulcs visszavonása
- Jelentkezzen be az Azure Portalra vállalati rendszergazdaként.
- Keresse meg és válassza ki a Költségkezelés + számlázás lehetőséget.
- Válassza ki a navigációs menüből a Számlázási hatókörök lehetőséget, majd válassza ki a használni kívánt számlázási fiókot.
- A navigációs menüben válassza a Használat + Díjak lehetőséget.
- Válassza az API-hozzáférési kulcsok kezelése lehetőséget.
- Válassza a Visszavonás lehetőséget a kulcs visszavonásához.
API-hozzáférés engedélyezése nem rendszergazdáknak
Ha olyan személyeknek szeretné megadni az API hozzáférési kulcsait, akik nem vállalati rendszergazdák a regisztrációban, hajtsa végre az alábbi lépéseket.
A lépések hozzáférést biztosítanak az API-nak a kulcstulajdonosok számára, így megtekinthetik a használati jelentések költség- és díjszabási adatait.
- A bal oldali navigációs ablakban válassza a Szabályzatok lehetőséget.
- Válassza a Be lehetőséget a RÉSZLEGGAZDÁK MEGTEKINTHETIK a DÍJAK szakaszt, majd válassza a Mentés lehetőséget.
- Válassza a Be lehetőséget a FIÓKTULAJDONOSOK MEGTEKINTHETIk a DÍJAK szakaszt, majd válassza a Mentés lehetőséget.
API-kulcsok átadása
Adja át az API-kulcsokat minden hitelesítési és engedélyezési híváshoz. Adja meg a következő tulajdonságot a HTTP-fejlécekben:
| Kérelemfejléc kulcsa | Value |
|---|---|
| Engedélyezés | Adja meg az értéket ebben a formátumban: bearer {API-KULCS} |
| Példa: tulajdonos APIKey <> |
Swagger
Swagger-végpont érhető el az Enterprise Reporting v3 API-kban a következő API-khoz. A Swagger segít az API vizsgálatában. A Swagger segítségével ügyféloldali SDK-kat hozhat létre az AutoRest vagy a Swagger CodeGen használatával. A 2014. május 1. után elérhető adatok az API-n keresztül érhetők el.
API-válaszkódok
API használatakor megjelennek a válasz állapotkódjai. Az alábbi táblázat ismerteti ezeket.
| Válasz állapotkódja | Üzenet | Leírás |
|---|---|---|
| 200 | OK | Nincs hiba |
| 401 | Nem engedélyezett | Az API-kulcs nem található, érvénytelen, lejárt stb. |
| 404 | Nem érhető el | A jelentésvégpont nem található |
| 400 | Hibás kérés | Érvénytelen paraméterek – Dátumtartományok, EA-számok stb. |
| 500 | Kiszolgálóhiba | Váratlan hiba a kérelem feldolgozása során |
Használati és számlázási adatok frissítési gyakorisága
A használati és számlázási adatfájlok 24 óránként frissülnek az aktuális számlázási hónapban. Adatkésés azonban akár három napig is előfordulhat. Ha például a használat hétfőn történt, akkor előfordulhat, hogy az adatok csütörtökig nem jelennek meg az adatfájlban.
Azure szolgáltatáskatalógus
Az Árlista letöltése részeként az Összes Azure-szolgáltatást letöltheti az Azure Portalon. Az árlista letöltéséről további információt az Nagyvállalati Szerződés díjszabásának letöltése című témakörben talál.
CSV-adatfájl részletei
Az alábbi információk az API-jelentések tulajdonságait ismertetik.
Használati adatok összegzése
A JSON formátum a CSV-jelentésből jön létre. Ennek következtében a formátum azonos az összegző CSV-fájl formátumával. Az oszlopneveket érdemes deszerializálni egy adattáblába a JSON-formátumú összefoglaló adatok felhasználásakor.
| Oszlopnév a CSV-fájlban | Oszlopnév a JSON-fájlban | Új oszlop a JSON-fájlban | Megjegyzés |
|---|---|---|---|
| AccountOwnerId | AccountOwnerLiveId | AccountOwnerLiveId | |
| Fiók neve | AccountName | AccountName | |
| ServiceAdministratorId | ServiceAdministratorLiveId | ServiceAdministratorLiveId | |
| SubscriptionId | SubscriptionId | SubscriptionId | |
| SubscriptionGuid | MOSPSubscriptionGuid | SubscriptionGuid | |
| Subscription Name | SubscriptionName | SubscriptionName | |
| Date | Date | Date | Azt a dátumot jeleníti meg, amikor a szolgáltatáskatalógus jelentése futott. A formátum egy időbélyeg nélküli dátumsztring. |
| Hónap | Hónap | Hónap | |
| Nap | Nap | Nap | |
| Year | Year | Year | |
| Termék | BillableItemName | Termék | |
| Meter ID (Mérési azonosító) | ResourceGUID | MeterId | |
| Meter Category (Mérési kategória) | Service | MeterCategory | A szolgáltatások keresésében segít. Olyan szolgáltatásokhoz használható, amelyeknek több szolgáltatástípusa van. Például Virtual Machines. |
| Meter Sub-Category (Mérési alkategória) | ServiceType | MeterSubCategory | Második szintű információkat nyújt a szolgáltatásokról. Például A1 méretű VM (nem Windows). |
| Meter Region (Mérési régió) | ServiceRegion | MeterRegion | Harmadik szintű információ a szolgáltatásokhoz. Segít megtalálni a ResourceGUID régiókörnyezetét. |
| Meter Name (Mérés neve) | ServiceResource | MeterName | A szolgáltatás neve. |
| Consumed Quantity (Felhasznált mennyiség) | ResourceQtyConsumed | ConsumedQuantity | |
| ResourceRate | ResourceRate | ResourceRate | |
| ExtendedCost | ExtendedCost | ExtendedCost | |
| Resource Location (Erőforrás helye) | ServiceSubRegion | ResourceLocation | |
| Consumed Service (Használt szolgáltatás) | ServiceInfo | ConsumedService | |
| Instance ID (Példányazonosító) | Összetevő | InstanceId | |
| ServiceInfo1 | ServiceInfo1 | ServiceInfo1 | |
| ServiceInfo2 | ServiceInfo2 | ServiceInfo2 | |
| További információk (Info) | További információk (Info) | További információk (Info) | |
| Címkék | Címkék | Címkék | |
| Store Service Identifier | OrderNumber | StoreServiceIdentifier | |
| Department Name | DepartmentName | DepartmentName | |
| Cost Center | CostCenter | CostCenter | |
| Mértékegység | UnitOfMeasure | UnitOfMeasure | Példaértékek: Óra, GB, Események, Leküldések, Egység, Egységórák, MB, Napi egységek |
| ResourceGroup | ResourceGroup | ResourceGroup |
Azure Marketplace-jelentés
| Oszlopnév a CSV-fájlban | Oszlopnév a JSON-fájlban | Új oszlop a JSON-fájlban |
|---|---|---|
| AccountOwnerId | AccountOwnerId | AccountOwnerId |
| Fiók neve | AccountName | AccountName |
| SubscriptionId | SubscriptionId | SubscriptionId |
| SubscriptionGuid | SubscriptionGuid | SubscriptionGuid |
| Subscription Name | SubscriptionName | SubscriptionName |
| Date | BillingCycle | Dátum (csak dátumsztring. Nincs időbélyeg) |
| Hónap | Hónap | Hónap |
| Nap | Nap | Nap |
| Year | Year | Year |
| Meter ID (Mérési azonosító) | MeterResourceId | MeterId |
| Publisher Name | PublisherFriendlyName | Közzétevő neve |
| Ajánlat neve | OfferFriendlyName | OfferName |
| Plan Name | PlanFriendlyName | PlanName |
| Consumed Quantity (Felhasznált mennyiség) | BilledQty | ConsumedQuantity |
| ResourceRate | ResourceRate | ResourceRate |
| ExtendedCost | ExtendedCost | ExtendedCost |
| Mértékegység | UnitOfMeasure | UnitOfMeasure |
| Instance ID (Példányazonosító) | InstanceId | InstanceId |
| Additional Info (További információ) | További információk (Info) | További információk (Info) |
| Címkék | Címkék | Címkék |
| Order Number | OrderNumber | OrderNumber |
| Department Name | DepartmentNames | DepartmentName |
| Cost Center | CostCenters | CostCenter |
| Erőforráscsoport | ResourceGroup | ResourceGroup |
Árlista
| Oszlopnév a CSV-fájlban | Oszlopnév a JSON-fájlban | Megjegyzés |
|---|---|---|
| Service | Service | Nincs árbeli változás |
| Mértékegység | UnitOfMeasure | |
| Overage Part Number | ConsumptionPartNumber | |
| Overage Unit Price | ConsumptionPrice | |
| Pénznem kódja | CurrencyCode |
Gyakori API-problémák
Az Azure Enterprise REST API-k használatakor a következő gyakori problémák bármelyikét tapasztalhatja.
Elképzelhető, hogy olyan API-kulcsot használ, amely nem a megfelelő engedélyezési típussal rendelkezik. Az API-kulcsokat az alábbiak hozzák létre:
- Vállalati rendszergazda
- Részlegszintű rendszergazda (DA)
- Fióktulajdonos (AO)
A vállalati rendszergazda által előállított kulcs hozzáférést biztosít az adott regisztrációhoz tartozó összes információhoz. Egy csak olvasási engedéllyel rendelkező vállalati rendszergazda nem tud létrehozni API-kulcsot.
Egy részlegszintű rendszergazda vagy fióktulajdonos által létrehozott kulcs nem biztosít hozzáférést az egyenleghez, a díjakhoz és az árlistához.
Az API-kulcsok hathavonta járnak le. Ha lejártak, újra létre kell hoznia őket.
Ha időtúllépési hibát tapasztal, megoldhatja azt az időtúllépési küszöbértékkorlát megnövelésével.
401-es (nem engedélyezett) lejárati hibaüzenetet kaphat. A hibát általában egy lejárt kulcs okozza. Ha a kulcs lejárt, újból létrehozhatja.
Az API-hívásokból 400-as és 404-es (nem érhető el) hibaüzenetek jelenhetnek meg, ha a kiválasztott dátumtartományhoz nem érhető el aktuális adat. Ez a hiba például akkor fordulhat elő, ha nemrég fiókátvitelt kezdeményeztek. Az adatok egy adott dátumtól kezdve egy új regisztrációban találhatók. A hiba akkor is előfordulhat, ha új regisztrációs számot használ a régi regisztrációban található információk lekéréséhez.
Következő lépések
- Az Azure EA-rendszergazdáknak az Azure Portalon kell olvasniuk az EA Számlázási felügyeletét.