Rozhraní Azure Enterprise REST API
Tento článek popisuje rozhraní REST API, která se používají v souvislosti s registrací do Azure Enterprise. Vysvětluje také, jak řešit běžné problémy s rozhraními REST API.
Rozhraní API pro spotřebu a využití
Zákazníci Microsoft Enterprise Azure mohou prostřednictvím rozhraní REST API získávat informace o využití a fakturaci. Vlastník role (Enterprise Správa istrator, Department Správa istrator, Account Owner) musí povolit přístup k rozhraní API vygenerováním klíče z webu Azure Portal. Pak může přístup k datům prostřednictvím rozhraní API získat kdokoli, komu bude poskytnuto číslo registrace a tento klíč.
Dostupná rozhraní API
Zůstatek a souhrn: Toto rozhraní API poskytuje měsíční přehled informací o zůstatcích, nových nákupech, poplatcích ve službě Azure Marketplace, úpravách a poplatcích za nadlimitní využití. Další informace najdete v tématu Rozhraní API pro vytváření sestav pro podnikové zákazníky – Zůstatek a souhrn.
Podrobnosti o využití: Toto rozhraní API poskytuje denní rozpis spotřebovaných prostředků a odhadované poplatky podle registrace. Výsledek obsahuje také informace o instancích, měřičích a odděleních. Na rozhraní API můžete zadávat dotazy podle fakturačního období nebo podle konkrétního počátečního a koncového data. Další informace najdete v tématu Rozhraní API pro vytváření sestav pro podnikové zákazníky – Podrobnosti o využití.
Poplatek obchodu Marketplace Store: Toto rozhraní API vrací poplatky vzniklé v obchodě na základě využití, v rozpisu po dnech, a to pro zadané fakturační období nebo konkrétní počáteční a koncové datum. Další informace najdete v tématu Rozhraní API pro vytváření sestav pro podnikové zákazníky – Poplatek obchodu Marketplace Store.
Ceník: Toto rozhraní API poskytuje platnou sazbu každého měřiče pro danou registraci a fakturační období. Další informace najdete v tématu Rozhraní API pro vytváření sestav pro podnikové zákazníky – Ceník.
Fakturační období: Toto rozhraní API vrací seznam fakturačních období, která obsahují data o spotřebě u dané registrace, a to v obráceném chronologickém pořadí. Každé období obsahuje vlastnost ukazující na trasu rozhraní API pro čtyři sady dat: BalanceSummary, UsageDetails, MarketplaceCharges a PriceSheet. Další informace najdete v tématu Rozhraní API pro vytváření sestav pro podnikové zákazníky – Fakturační období.
Generování klíčů rozhraní API
Vlastníci rolí můžou na webu Azure Portal provést následující kroky pro povolení přístupu k datům rozhraní API.
- Přihlaste se k portálu Azure.
- Vyhledejte Cost Management a fakturaci a vyberte ho.
- V navigační nabídce vyberte Rozsahy fakturace a pak vyberte fakturační účet, který chcete použít.
- V levé navigační nabídce vyberte Využití a poplatky.
- Výběrem možnosti Spravovat přístupové klíče rozhraní API otevřete okno Spravovat přístupové klíče rozhraní API.
V okně Spravovat přístupové klíče rozhraní API můžete provádět následující úlohy:
- Generování a zobrazení primárních a sekundárních přístupových klíčů
- Zobrazení počátečního a koncového data pro přístupové klíče
- Zakázání přístupových klíčů
Poznámka:
- Pokud jste na Správa registrace, můžete klíče vygenerovat pouze z okna Využití a poplatky na úrovni registrace, ale ne na úrovni účtů a oddělení.
- Pokud jste pouze vlastníkem oddělení, můžete vygenerovat klíče na úrovni oddělení a na úrovni účtu, pro kterou jste vlastníkem účtu.
- Pokud jste pouze vlastníkem účtu, můžete klíče vygenerovat pouze na úrovni účtu.
Generování primárního nebo sekundárního klíče rozhraní API
- Přihlaste se k webu Azure Portal jako podnikový správce.
- Vyberte Správa nákladů a fakturace.
- V navigační nabídce vyberte Rozsahy fakturace a pak vyberte fakturační účet, který chcete použít.
- V navigační nabídce vyberte Využití a poplatky.
- Vyberte Spravovat přístupové klíče rozhraní API.
- Vyberte Generovat a vygenerujte klíč.
- Vyberte symbol rozbalení nebo vyberte Kopírovat a získejte přístupový klíč rozhraní API pro okamžité použití.
Opětovné vygenerování primárního nebo sekundárního klíče rozhraní API
- Přihlaste se k webu Azure Portal jako podnikový správce.
- Vyberte Správa nákladů a fakturace.
- V navigační nabídce vyberte Rozsahy fakturace a pak vyberte fakturační účet, který chcete použít.
- V navigační nabídce vyberte Využití a poplatky.
- Vyberte Spravovat přístupové klíče rozhraní API.
- Vyberte Znovu vygenerovat klíč znovu.
Odvolání primárního nebo sekundárního klíče rozhraní API
- Přihlaste se k webu Azure Portal jako podnikový správce.
- Vyhledejte a vyberte možnost Správa nákladů a fakturace.
- V navigační nabídce vyberte Rozsahy fakturace a pak vyberte fakturační účet, který chcete použít.
- V navigační nabídce vyberte Využití a poplatky.
- Vyberte Spravovat přístupové klíče rozhraní API.
- Chcete-li odvolat klíč, vyberte možnost Odvolat .
Povolit přístup k rozhraní API nesprávci
Pokud chcete přístupovým klíčům rozhraní API udělit uživatelům, kteří nejsou podnikovými správci ve vaší registraci, proveďte následující kroky.
Kroky poskytují rozhraní API přístup k držitelům klíčů, aby mohli zobrazit informace o nákladech a cenách v sestavách využití.
- V levém navigačním okně vyberte Zásady.
- V části SPRÁVCI ODDĚLENÍ MŮŽOU ZOBRAZIT POPLATKY a pak vyberte Uložit.
- V části VLASTNÍCI ÚČTU MŮŽOU ZOBRAZIT POPLATKY a pak vyberte Uložit.
Předávání klíčů v rozhraní API
Klíč rozhraní API je potřeba předat při každém volání kvůli ověření a autorizaci. Do hlaviček protokolu HTTP je třeba vložit následující vlastnost:
| Klíč v hlavičce požadavku | Hodnota |
|---|---|
| Autorizace | Zadejte hodnotu v tomto formátu: bearer {KLÍČ_API}. |
| Příklad: bearer <APIKey> |
Swagger
Koncový bod Swagger je k dispozici v následujících rozhraních API pro vytváření sestav v podnicích verze 3. Swagger usnadňuje kontrolu rozhraní API. Pomocí Swaggeru můžete vygenerovat klientské sady SDK AutoRest nebo Swagger CodeGen. Prostřednictvím rozhraní API jsou k dispozici data od 1. května 2014.
Kódy odpovědí rozhraní API
Pokud používáte rozhraní API, budou se zobrazovat kódy stavu odpovědí. Následující tabulka je popisuje.
| Stavový kód odpovědi | Message | Popis |
|---|---|---|
| 200 | OK | Bez chyby |
| 401 | Neautorizováno | Klíč rozhraní API se nedá najít, je neplatný, vypršela jeho platnost atd. |
| 404 | Neaktivní | Nenašel se koncový bod sestavy. |
| 400 | Nesprávná žádost | Neplatné parametry – rozsahy dat, čísla smluv EA atd. |
| 500 | Chyba serveru | Neočekávaná chyba při zpracování žádosti |
Frekvence aktualizace dat o využití a fakturačních dat
Data o využití a fakturační data se pro aktuální fakturační měsíc aktualizují každých 24 hodin. Může ale docházet ke zpožďování dat v rozsahu až 3 dnů. Pokud například k využití dojde v pondělí, data se v datovém souboru nemusí zobrazit až do čtvrtka.
Katalog služeb Azure
Všechny služby Azure si můžete stáhnout na webu Azure Portal jako součást stažení ceníku. Další informace o stažení ceníku najdete v tématu Stažení cen pro smlouva Enterprise.
Podrobnosti o datovém souboru CSV
V následující části jsou popsány vlastnosti sestav rozhraní API.
Souhrn využití
Ze sestavy CSV se vygenerují data ve formátu JSON. Výsledný formát proto stejný jako souhrnný formát CSV. Název sloupce je spojený, takže byste ho při spotřebě souhrnných dat JSON měli provést deserializovat do datové tabulky.
| Název sloupce CSV | Název sloupce JSON | Nový sloupec JSON | Komentář |
|---|---|---|---|
| AccountOwnerId | AccountOwnerLiveId | AccountOwnerLiveId | |
| Název účtu | AccountName | AccountName | |
| ServiceAdministratorId | ServiceAdministratorLiveId | ServiceAdministratorLiveId | |
| SubscriptionId | SubscriptionId | SubscriptionId | |
| SubscriptionGuid | MOSPSubscriptionGuid | SubscriptionGuid | |
| Název předplatného | SubscriptionName | SubscriptionName | |
| Datum | Datum | Datum | Zobrazuje datum, kdy byla spuštěna sestava katalogu služeb. Formátem je řetězec data bez časového razítka. |
| Měsíc | Měsíc | Měsíc | |
| Den | Den | Den | |
| Year | Year | Year | |
| Produkt | BillableItemName | Produkt | |
| ID měření | ResourceGUID | ID měřiče | |
| Kategorie měření | Service | MeterCategory | Užitečné při hledání služeb. Relevantní pro služby, které mají více položek ServiceType. Například Virtual Machines. |
| Podkategorie měření | ServiceType | MeterSubCategory | Poskytuje druhou úroveň podrobností pro službu. Například Virtuální počítač A1 (ne Windows). |
| Oblast měření | ServiceRegion | MeterRegion | Třetí úroveň podrobností požadovaných pro službu. Užitečné při hledání kontextu oblasti pro ResourceGUID. |
| Název měřiče | ServiceResource | MeterName | Název služby |
| Spotřebované množství | ResourceQtyConsumed | ConsumedQuantity | |
| ResourceRate | ResourceRate | ResourceRate | |
| ExtendedCost | ExtendedCost | ExtendedCost | |
| Umístění prostředku | ServiceSubRegion | ResourceLocation | |
| Spotřebovaná služba | ServiceInfo | ConsumedService | |
| ID instance | Komponenta | InstanceId | |
| ServiceInfo1 | ServiceInfo1 | ServiceInfo1 | |
| ServiceInfo2 | ServiceInfo2 | ServiceInfo2 | |
| AdditionalInfo | AdditionalInfo | AdditionalInfo | |
| Značky | Značky | Značky | |
| Identifikátor služby úložiště | OrderNumber | StoreServiceIdentifier | |
| Název oddělení | DepartmentName | DepartmentName | |
| Nákladové středisko | CostCenter | CostCenter | |
| Měrná jednotka | UnitOfMeasure | UnitOfMeasure | Ukázkové hodnoty: Hodiny, GB, Události, Vložení, Jednotka, Hodiny jednotek, MB, Denní jednotky |
| ResourceGroup | ResourceGroup | ResourceGroup |
Sestava pro Azure Marketplace
| Název sloupce CSV | Název sloupce JSON | Nový sloupec JSON |
|---|---|---|
| AccountOwnerId | AccountOwnerId | AccountOwnerId |
| Název účtu | AccountName | AccountName |
| SubscriptionId | SubscriptionId | SubscriptionId |
| SubscriptionGuid | SubscriptionGuid | SubscriptionGuid |
| Název předplatného | SubscriptionName | SubscriptionName |
| Datum | BillingCycle | Date (pouze řetězec kalendářního data. Bez časového razítka) |
| Měsíc | Měsíc | Měsíc |
| Den | Den | Den |
| Year | Year | Year |
| ID měření | MeterResourceId | ID měřiče |
| Název vydavatele | PublisherFriendlyName | Název vydavatele |
| Název nabídky | OfferFriendlyName | OfferName |
| Název plánu | PlanFriendlyName | PlanName |
| Spotřebované množství | BilledQty | ConsumedQuantity |
| ResourceRate | ResourceRate | ResourceRate |
| ExtendedCost | ExtendedCost | ExtendedCost |
| Měrná jednotka | UnitOfMeasure | UnitOfMeasure |
| ID instance | InstanceId | InstanceId |
| Další informace | AdditionalInfo | AdditionalInfo |
| Značky | Značky | Značky |
| Číslo objednávky | OrderNumber | OrderNumber |
| Název oddělení | DepartmentNames | DepartmentName |
| Nákladové středisko | CostCenters | CostCenter |
| Skupina prostředků | ResourceGroup | ResourceGroup |
Ceník
| Název sloupce CSV | Název sloupce JSON | Komentář |
|---|---|---|
| Service | Service | Žádná změna ceny |
| Měrná jednotka | UnitOfMeasure | |
| Číslo nadlimitní položky | ConsumptionPartNumber | |
| Cena nadlimitní položky | ConsumptionPrice | |
| Kód měny | CurrencyCode |
Běžné problémy s rozhraními API
Když používáte rozhraní Azure Enterprise REST API, můžete se setkat s následujícími běžnými problémy.
Možná jste se pokusili použít klíč rozhraní API, který nemá správný typ autorizace. Klíč rozhraní API může vygenerovat:
- Podnikový správce
- Správce oddělení (DA)
- Vlastník účtu (AO)
Klíč vygenerovaný podnikovým správcem (EA) poskytuje přístup ke všem informacím pro danou registraci. Klíč rozhraní API nemůže vygenerovat správce EA s oprávněním jen pro čtení.
Klíč vygenerovaný správcem DA nebo AO neposkytuje přístup k informacím o zůstatcích, poplatcích a ceníku.
Platnost klíče rozhraní API vyprší každých šest měsíců. Pokud platnost vypršela, budete ho muset vygenerovat znovu.
Pokud se zobrazí chyba kvůli časovému limitu, můžete ji vyřešit zvýšením tohoto limitu.
Může se zobrazit chyba 401 (Neautorizováno). K této chybě obvykle dochází, když vyprší platnost klíče. Pokud vypršela platnost klíče, můžete ho znovu vygenerovat.
Pokud pro vybraný rozsah dat nejsou k dispozici žádná aktuální data, může volání rozhraní API vrátit chyby 400 a 404 (Není k dispozici). K této chybě může dojít například proto, že byl v nedávné době zahájen přenos registrace. Data od určitého data se teď nacházejí v nové registraci. K chybě může dojít také v případě, že použijete nové číslo registrace k načtení informací, které se nacházejí ve staré registraci.
Další kroky
- Správci Azure EA by měli číst správu fakturace EA na webu Azure Portal.