REST-API:er för Azure Enterprise
I den här artikeln beskrivs de REST-API:er du använder med din Azure Enterprise-registrering. Dessutom går vi igenom hur du löser vanliga problem med REST-API:erna.
API:er för förbrukning och användning
Microsoft Enterprise Azure-kunder kan få information om användning och fakturering via REST-API:er. Rollägaren (företagsadministratör, avdelningsadministratör, kontoägare) måste aktivera åtkomst till API:et genom att generera en nyckel från Azure-portalen. Sedan kan alla som har registreringsnumret och nyckeln komma åt data via API:et.
Tillgängliga API:er
Saldon och sammanfattningar – API:et för saldon och sammanfattningar returnerar en månatlig sammanfattning av information om saldon, nya inköp, kostnader för Azure Marketplace-tjänster, justeringar och kostnader för överförbrukning. Mer information finns i Rapport-API:er för Enterprise-kunder – saldon och sammanfattningar.
Användningsinformation – API:et för användningsinformation returnerar en daglig uppdelning av förbrukade kvantiteter och beräknade avgifter per registrering. Resultatet innehåller också information om instanser, mätare och avdelningar. Du kan köra frågor mot API:et per faktureringsperiod eller per start- och slutdatum. Du kan läsa mer i Rapport-API:er för Enterprise-kunder – användningsinformation.
Kostnader för Marketplace Store – API:et för kostnader för Marketplace Store returnerar en uppdelning av de användningsbaserade kostnaderna för Marketplace per dag under den angivna faktureringsperioden eller per start- och slutdatum. Du kan läsa mer i Rapport-API:er för Enterprise-kunder – kostnader för Marketplace Store.
Prisdokument – API:et för prisdokument returnerar relevant pris för respektive mätare för en registrering och faktureringsperiod. Du kan läsa mer i Rapport-API:er för Enterprise-kunder – prisdokument.
Faktureringsperioder – API:et för faktureringsperioder returnerar en lista med faktureringsperioder som har förbrukningsdata för en registrering i omvänd kronologisk ordning. Varje period innehåller en egenskap som pekar på API-vägen för de fyra datauppsättningarna BalanceSummary, UsageDetails, MarketplaceCharges och PriceSheet. Du kan läsa mer i Rapport-API:er för Enterprise-kunder – faktureringsperioder.
Generering av API-nyckel
Rollägare kan utföra följande steg i Azure-portalen för att aktivera API-dataåtkomst.
- Logga in på Azure-portalen.
- Sök efter Cost Management + Fakturering och välj den sedan.
- Välj Faktureringsomfång i navigeringsmenyn och välj sedan det faktureringskonto som du vill arbeta med.
- I den vänstra navigeringsmenyn väljer du Användning + avgifter.
- Välj Hantera API-åtkomstnycklar för att öppna fönstret Hantera API-åtkomstnycklar.
I fönstret Hantera API-åtkomstnycklar kan du utföra följande uppgifter:
- Generera och visa primära och sekundära åtkomstnycklar
- Visa start- och slutdatum för åtkomstnycklar
- Inaktivera åtkomstnycklar
Kommentar
- Om du är registreringsadministratör kan du generera nycklarna från endast bladet Användning och avgifter på registreringsnivå, men inte på konto- och avdelningsnivå.
- Om du bara är avdelningsägare kan du generera nycklarna på avdelningsnivå och på den kontonivå som du är kontoägare för.
- Om du bara är kontoägare kan du endast generera nycklarna på kontonivå.
Generera den primära eller sekundära API-nyckeln
- Logga in på Azure-portalen som företagsadministratör.
- Välj Kostnadshantering och fakturering.
- Välj Faktureringsomfång i navigeringsmenyn och välj sedan det faktureringskonto som du vill arbeta med.
- I navigeringsmenyn väljer du Användning + avgifter.
- Välj Hantera API-åtkomstnycklar.
- Välj Generera för att generera nyckeln.
- Välj expandera-symbolen eller välj Kopiera för att hämta API-åtkomstnyckeln för omedelbar användning.
Återskapa den primära eller sekundära API-nyckeln
- Logga in på Azure-portalen som företagsadministratör.
- Välj Kostnadshantering och fakturering.
- Välj Faktureringsomfång i navigeringsmenyn och välj sedan det faktureringskonto som du vill arbeta med.
- I navigeringsmenyn väljer du Användning + avgifter.
- Välj Hantera API-åtkomstnycklar.
- Välj Återskapa för att återskapa nyckeln.
Återkalla den primära eller sekundära API-nyckeln
- Logga in på Azure-portalen som företagsadministratör.
- Leta upp och välj Kostnadshantering + fakturering.
- Välj Faktureringsomfång i navigeringsmenyn och välj sedan det faktureringskonto som du vill arbeta med.
- I navigeringsmenyn väljer du Användning + avgifter.
- Välj Hantera API-åtkomstnycklar.
- Välj Återkalla för att återkalla nyckeln.
Tillåt API-åtkomst till icke-administratörer
Utför följande steg om du vill ge API-åtkomstnycklarna till personer som inte är företagsadministratörer i din registrering.
Stegen ger API-åtkomst till nyckelinnehavare så att de kan visa information om kostnader och priser i användningsrapporter.
- I det vänstra navigeringsfönstret väljer du Principer.
- Välj På under avsnittet AVDELNINGSADMINISTRATÖRER KAN VISA AVGIFTER och välj sedan Spara.
- Välj På under avsnittet KONTOÄGARE KAN VISA AVGIFTER och välj sedan Spara.
Skicka nycklar i API:et
Skicka API-nyckeln i varje anrop för autentisering och auktorisering. Skicka följande egenskap till HTTP-huvuden:
| Nyckel för begärandehuvud | Värde |
|---|---|
| Auktorisering | Ange värdet i det här formatet: bearer {API_KEY} |
| Exempel: bearer <APIKey> |
Swagger
Det finns en Swagger-slutpunkt vid Enterprise Reporting v3-API:ernaför följande API:er. Swagger hjälper dig att inspektera API:et. Använd Swagger till att generera klient-SDK:er med AutoRest eller Swagger CodeGen. Du kommer åt data som är tillgängliga efter den 1 maj 2014 via API:et.
API-svarskoder
När du använder ett API returneras statuskoder. Följande tabell beskriver dem.
| Statuskod för svar | Meddelande | beskrivning |
|---|---|---|
| 200 | OK | Inget fel |
| 401 | Behörighet saknas | Det gick inte att hitta API-nyckeln – ogiltig, har gått ut eller liknande |
| 404 | Inte tillgänglig | Det gick inte att hitta rapportslutpunkten |
| 400 | Felaktig förfrågan | Ogiltiga parametrar – datumintervall, EA-nummer eller liknande |
| 500 | Serverfel | Ett oväntat fel inträffade när förfrågan bearbetades |
Uppdateringsfrekvens för användnings- och faktureringsdata
Filerna med användnings- och faktureringsdata uppdateras var 24:e timme under den aktuella faktureringsmånaden. Det kan dock uppstå fördröjningar på upp till tre dagar. Om användningen till exempel sker på en måndag kanske inte data visas i filen förrän på torsdag.
Katalogen med Azure-tjänster
Du kan ladda ned alla Azure-tjänster i Azure-portalen som en del av nedladdningen av prisdokumentet. Mer information om hur du laddar ned prisdokumentet finns i Ladda ned priser för en företagsavtal.
Informationen i CSV-datafilen
Följande information beskriver egenskaperna för API-rapporter.
Användningssammanfattning
JSON-formatet genereras från CSV-rapporten. Formatet är därför detsamma som formatet i CSV-sammanfattningen. Kolumnnamnet är sammansatt, så du bör deserialisera till en datatabell när du använder JSON-sammanfattningsdata.
| CSV-kolumnnamn | JSON-kolumnnamn | Ny JSON-kolumn | Kommentar |
|---|---|---|---|
| AccountOwnerId | AccountOwnerLiveId | AccountOwnerLiveId | |
| Kontonamn | AccountName | AccountName | |
| ServiceAdministratorId | ServiceAdministratorLiveId | ServiceAdministratorLiveId | |
| SubscriptionId | SubscriptionId | SubscriptionId | |
| SubscriptionGuid | MOSPSubscriptionGuid | SubscriptionGuid | |
| Subscription Name | SubscriptionName | SubscriptionName | |
| Datum | Datum | Datum | Visar datumet när tjänstkatalogsrapporten kördes. Formatet är en datumsträng utan tidstämpel. |
| Månad | Månad | Månad | |
| Dag | Dag | Dag | |
| Year | Year | Year | |
| Produkt | BillableItemName | Produkt | |
| Mätar-ID | ResourceGUID | MeterId | |
| Mätarkategori | Tjänst | MeterCategory | Användbar när du ska hitta tjänster. Relevant för tjänster som har flera tjänsttyper. Ett exempel är virtuella datorer. |
| Mätarens underkategori | ServiceType | MeterSubCategory | Ger en andra detaljnivå för en tjänst. Till exempel A1 VM (inte Windows). |
| Mätarregion | ServiceRegion | MeterRegion | Den tredje detaljnivån som krävs för en tjänst. Användbart när du ska hitta regionkontexten för ett ResourceGUID. |
| Mätarnamn | ServiceResource | MeterName | Namnet på tjänsten. |
| Förbrukad kvantitet | ResourceQtyConsumed | ConsumedQuantity | |
| ResourceRate | ResourceRate | ResourceRate | |
| ExtendedCost | ExtendedCost | ExtendedCost | |
| Resursplats | ServiceSubRegion | ResourceLocation | |
| Förbrukad tjänst | ServiceInfo | ConsumedService | |
| Instance ID | Komponent | InstanceId | |
| ServiceInfo1 | ServiceInfo1 | ServiceInfo1 | |
| ServiceInfo2 | ServiceInfo2 | ServiceInfo2 | |
| AdditionalInfo | AdditionalInfo | AdditionalInfo | |
| Taggar | Taggar | Taggar | |
| Id för Store-tjänst | OrderNumber | StoreServiceIdentifier | |
| Avdelningsnamn | DepartmentName | DepartmentName | |
| Kostnadsställe | CostCenter | CostCenter | |
| Måttenhet | UnitOfMeasure | UnitOfMeasure | Exempelvärden: Timmar, GB, händelser, push-meddelanden, enhet, enhetstimmar, MB, dagliga enheter |
| ResourceGroup | ResourceGroup | ResourceGroup |
Azure Marketplace-rapport
| CSV-kolumnnamn | JSON-kolumnnamn | Ny JSON-kolumn |
|---|---|---|
| AccountOwnerId | AccountOwnerId | AccountOwnerId |
| Kontonamn | AccountName | AccountName |
| SubscriptionId | SubscriptionId | SubscriptionId |
| SubscriptionGuid | SubscriptionGuid | SubscriptionGuid |
| Subscription Name | SubscriptionName | SubscriptionName |
| Datum | BillingCycle | Datum (endast datumsträng. Ingen tidsstämpel) |
| Månad | Månad | Månad |
| Dag | Dag | Dag |
| Year | Year | Year |
| Mätar-ID | MeterResourceId | MeterId |
| Utgivarens namn | PublisherFriendlyName | PublisherName |
| Erbjudandets namn | OfferFriendlyName | OfferName |
| Plannamn | PlanFriendlyName | PlanName |
| Förbrukad kvantitet | BilledQty | ConsumedQuantity |
| ResourceRate | ResourceRate | ResourceRate |
| ExtendedCost | ExtendedCost | ExtendedCost |
| Måttenhet | UnitOfMeasure | UnitOfMeasure |
| Instance ID | InstanceId | InstanceId |
| Extra information | AdditionalInfo | AdditionalInfo |
| Taggar | Taggar | Taggar |
| Ordernummer | OrderNumber | OrderNumber |
| Avdelningsnamn | DepartmentNames | DepartmentName |
| Kostnadsställe | CostCenters | CostCenter |
| Resursgrupp | ResourceGroup | ResourceGroup |
Prisdokument
| CSV-kolumnnamn | JSON-kolumnnamn | Kommentar |
|---|---|---|
| Tjänst | Tjänst | Ingen ändring av priset |
| Måttenhet | UnitOfMeasure | |
| Överförbrukningens delnummer | ConsumptionPartNumber | |
| Överförbrukningens enhetspris | ConsumptionPrice | |
| Valutakod | CurrencyCode |
Vanliga API-problem
När du använder REST-API:er för Azure Enterprise kan du stöta på något av följande vanliga problem.
Du kanske försöker använda en API-nyckel som inte har rätt typ av behörighet. API-nycklar genereras av:
- Företagsadministratör
- Avdelningsadministratörer (DA)
- Kontoägare (AO)
En nyckel som genereras av EA-administratören ger åtkomst till all information om registreringen. En EA-administratör med skrivskyddad åtkomst kan inte skapa API-nycklar.
En nyckel som genereras av en DA eller AO ger inte åtkomst till saldon, avgifter eller prisdokument.
En API-nyckel upphör att gälla efter sex månader. Om den upphör att gälla måste du generera en ny.
Om du får ett tidsgränsfel kan du lösa det genom att öka tröskelvärdet för tidsgränsen.
Du kan få ett 401-fel (behörighet saknas). Det här felet orsakas normalt av att nyckeln har upphört att gälla. Om nyckeln har upphört att gälla kan du generera en ny.
Du kan få 400- och 404-fel (inte tillgänglig) från ett API-anrop om inga data är tillgängliga för det valda datumintervallet. Det här felet kan till exempel inträffa på grund av att en registreringsöverföring har initierats nyligen. Data från ett visst datum och framåt ligger nu i en ny registrering. I annat fall kan felet inträffa om du använder ett nytt registreringsnummer till att hämta information som ligger i en gammal registrering.
Nästa steg
- Azure EA-administratörer bör läsa EA-faktureringsadministration på Azure-portalen.