@@ -3,11 +3,11 @@ title: Azure Enterprise REST APIs
3
3
description : This article describes the REST APIs for use with your Azure enterprise enrollment.
4
4
author : bandersmsft
5
5
ms.author : banders
6
- ms.date : 12/10/2021
6
+ ms.date : 11/16/2022
7
7
ms.topic : conceptual
8
8
ms.service : cost-management-billing
9
9
ms.subservice : enterprise
10
- ms.reviewer : boalcsva
10
+ ms.reviewer : racheg
11
11
---
12
12
13
13
# Azure Enterprise REST APIs
@@ -34,20 +34,20 @@ Microsoft Enterprise Azure customers can get usage and billing information throu
34
34
35
35
Role owners can perform the following steps in the Azure EA portal. Navigate to ** Reports** > ** Download Usage** > ** API Access Key** . Then they can:
36
36
37
- - Generate primary and secondary access keys.
38
- - Disable access keys.
37
+ - Generate and regenerate primary and secondary access keys.
38
+ - Revoke access keys.
39
39
- View start and end dates of access keys.
40
40
41
41
### Generate or retrieve the API Key
42
42
43
43
1 . Sign in as an enterprise administrator.
44
44
2 . Select ** Reports** on the left navigation window and then select the ** Download Usage** tab.
45
45
3 . Select ** API Access Key** .
46
- 4 . Under ** Enrollment Access Keys** , select the generate key symbol to generate either a primary or secondary key.
46
+ 4 . Under ** Enrollment Access Keys** , select ** regenerate ** to generate either a primary or secondary key.
47
47
5 . Select ** Expand Key** to view the entire generated API access key.
48
48
6 . Select ** Copy** to get the API access key for immediate use.
49
49
50
- ![ Example showing API Access Key page] ( . /media/ea-portal-rest-apis/ea-create-generate-or-retrieve-the-api-key.png)
50
+ :::image type="content" source="./media/ea-portal-rest-apis/ea-create-generate-or-retrieve-the-api-key.png" alt-text="Screenshot showing the API Access Key page." lightbox=". /media/ea-portal-rest-apis/ea-create-generate-or-retrieve-the-api-key.png" :::
51
51
52
52
If you want to give the API access keys to people who aren't enterprise administrators in your enrollment, perform the following steps:
53
53
@@ -57,7 +57,8 @@ If you want to give the API access keys to people who aren't enterprise administ
57
57
4 . Select the pencil symbol next to ** AO view charges** (Account Owner view charges).
58
58
5 . Select ** Enable** and then select ** Save** .
59
59
60
- ![ Example showing DA and AO view charges enabled] ( ./media/ea-portal-rest-apis/create-ea-generate-or-retrieve-api-key-enable-ao-do-view.png )
60
+ ![ Screenshot showing DA and AO view charges enabled.] ( ./media/ea-portal-rest-apis/create-ea-generate-or-retrieve-api-key-enable-ao-do-view.png )
61
+
61
62
The preceding steps give API access key holders with access to cost and pricing information in usage reports.
62
63
63
64
### Pass keys in the API
@@ -67,7 +68,7 @@ Pass the API key for each call for authentication and authorization. Pass the fo
67
68
| Request header key | Value |
68
69
| --- | --- |
69
70
| Authorization | Specify the value in this format: ** bearer {API\_ KEY}**
70
- Example: bearer \& lt; APIKey\& gt; |
71
+ Example: bearer \< APIKey\> |
71
72
72
73
### Swagger
73
74
@@ -107,7 +108,7 @@ JSON format is generated from the CSV report. As a result, the format is same as
107
108
| Account Name | AccountName | AccountName | |
108
109
| ServiceAdministratorId | ServiceAdministratorLiveId | ServiceAdministratorLiveId | |
109
110
| SubscriptionId | SubscriptionId | SubscriptionId | |
110
- | SubscriptionGuid | MOCPSubscriptionGuid | SubscriptionGuid | |
111
+ | SubscriptionGuid | MOSPSubscriptionGuid | SubscriptionGuid | |
111
112
| Subscription Name | SubscriptionName | SubscriptionName | |
112
113
| Date | Date | Date | Shows the date that the service catalog report ran. The format is a date string without a time stamp. |
113
114
| Month | Month | Month | |
0 commit comments