Overview of reporting APIs for Enterprise Agreement customers
This article applies only to Enterprise Agreement customers.Learn how to become an Enterprise Agreement customer.
As an Azure Enterprise Agreement customer, you can use REST or JSON APIs to access usage data and billing details.To enable access permissions for the API, Enterprise administrators must generate a secret key in the Enterprise Portal.Anyone in possession of the contract number and access key can access the API.
Enable data access via APIs
Azure Enterprise Agreement customers can now use APIs to access usage and billing details. Enterprise administrators can control API access permissions using access keys.Enterprise administrators can perform the following functions in the “Reporting API access key” section of the Enterprise Portal:
- Generate a primary access key and a secondary access key.
- Disable access keys.
- View the start date and finish date for access keys.
Obtain reports by using APIs
By using APIs, Azure Enterprise Agreement customers can obtain two reports:
- Contract Summary CSV file: Contains information on the contract summary for the current month.The formats and information in this report are the same as those the “Balance and charges” report that you can obtain from the “Download usage data” section of the Enterprise Portal.
- Usage and Billing Details CSV file: Contains information about service usage and charges.The formats and information in this report are the same as those in the “Usage details” report that you can obtain from the “Download usage data” section of the Enterprise Portal.
To obtain the CSV files, you can use either of two APIs:You can use two different APIs:
- GetUsageList API: Gives you usage summaries and detailed reports for the months that are listed in the provided JSON strings.The information that's returned includes the URI for calling the GetUsageByMonth API.
- GetUsageByMonth API: Lets you download a “Contract Summary CSV” binary array and a “Usage and Billing Details CSV” binary array.
For technical specifications and sample code, log on to the Enterprise Portal and view the help files.
Frequency of usage and billing data updates
- The files are updated once every 24 hours.
- Information might be up to three days behind.For example, information about usage that occurred on Monday might not appear in the files until Thursday.
Call APIs for PoC development
If you are a partner or developer and want to access the API, but have not signed an Azure Enterprise Agreement, you can use the test contract (EnrollmentNumber 100) and the test contract access key to call the API and view sample data.
Azure service catalog
We have published a catalog of all Azure services in CSV format on the Blob.This catalog can be useful if you need to build a special catalog of all Azure services for your system.The file is updated twice monthly, by the 5th and 20th days of each month.Catalog URL: https://azurepricing.blob.core.windows.net/supplemental/Friendly_Service_Names.xlsx
Catalog field descriptions
|Product||The name of the service(for example, A1 VM [non-Windows] - North China)|
|ResourceGUID||A unique key that identifies the service.The detailed usage CSV file also includes ResourceGUID, a field that should be used for cross-referencing between the catalog and the detailed usage.|
|Premium service category||Helps to reduce the scope of services,which is particularly important for services that have multiple service types, such as virtual machines.|
|Service type||Provides second-level details about services(for example, A1 VM [non-Windows]).|
|Service region||The third-level information that’s required by the service. This field helps to reduce the scope to the RegionContext for ResourceGUID.|
|Service resource||This is the fourth and final level of detailed information. This field helps to reduce the scope to the service resources that are being used.This field can be used along with service, service type and service region to provide the complete service context.Examples are Azure storage space - geographic redundancy - all regions - standard IO - Blob (GB) and Azure storage space - geographic redundancy - all regions - standard IO - file (GB).The highlighted portions of these two examples are the “service resources.” Note that the other service details remain unchanged.|
|Measurement units||Sample values are hour, GB, events, pushes, unit, unit-hours, MB, and units per day.|
|Package product code||If a customer has made a financial commitment in the Enterprise Agreement contract, it should be cross-referenced with the product code for pricing purposes.|
|Usage per package unit||Provides the number of services in 1 unit of the SKU.For example, if each SKU indicates usage of 100 hours, this value will be 100 for a VM SKU.|
|Product codes used||If a customer has not made a financial commitment in the Enterprise Agreement contract, it should be cross-referenced with the product code for pricing purposes.|
|Usage per unit||Provides the number of services in 1 unit of the SKU.For example, if each SKU indicates usage of 100 hours, this value will be 100 for a VM SKU.|
|Report month||Indicates the month for which the service catalog report was produced.|