Skip to content

Commit 20e9229

Browse files
MattEberhart-MSFTEalprosms
MattEberhart-MSFTE
and
alprosms
authored
[Hub Generated] Review request for Microsoft.CostManagement to add version stable/2023-03-01 (#23892)
* Adds base for updating Microsoft.CostManagement from version stable/2022-10-01 to version 2023-03-01 * Updates readme * Updates API version in new specs and examples * Matteberhart/merging main for readme (#23886) * Adds base for updating Microsoft.CostManagement from version stable/2022-10-01 to version 2023-03-01 * Updates readme * Updates API version in new specs and examples * Benefit Summaries Async (#22497) * Added benefit utilizaiton summaries APIs to costmanagement.benefits.json and appropriate examples. * Added report schema and secondary url * Prettier check and spelling error fix * Addressed BenefitKind / Kind in the csv schema and changed parameter name to benefitAsyncOperationIdParameter * Replacing included quantity * Alphabetized the parameters * Changing request body BenefitKind property to Kind * Adding 200 repsonse to generate api and fixing linter warnings * Adding examples to generate api * Making status optional for running scenario * Changing to completed to have all properties in generate examples and adding long running operation tag to error response * LRO Error response * LRO lint diff error still present. * Found all diffs in 2022-10-01 version added since branching (#23590) * Found all diffs in 2022-10-01 version added since branching * Fixing examples ruined by updating. Pulled straight from 2022-10-01 * Changed enum name (#23605) * Changing code of ErrorDetails object back to a string (#23734) * cost details report operation results example needs string error code (#23742) * Cherry picked commit causing conflict in readme (#23817) Co-authored-by: alprosms <[email protected]> --------- Co-authored-by: alprosms <[email protected]> * Adding x-ms-secret to the report urls (#23934) * Remove operation results (#23938) * Remove operation results * Removing examples * Using commony type error response (#23955) --------- Co-authored-by: alprosms <[email protected]>
1 parent 288939a commit 20e9229

File tree

171 files changed

+18328
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

171 files changed

+18328
-2
lines changed

‎specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-03-01/common-types.json‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2023-03-01",
5+
"title": "CostManagementClient"
6+
},
7+
"host": "management.azure.com",
8+
"schemes": [
9+
"https"
10+
],
11+
"consumes": [
12+
"application/json"
13+
],
14+
"produces": [
15+
"application/json"
16+
],
17+
"security": [
18+
{
19+
"azure_auth": [
20+
"user_impersonation"
21+
]
22+
}
23+
],
24+
"securityDefinitions": {
25+
"azure_auth": {
26+
"type": "oauth2",
27+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
28+
"flow": "implicit",
29+
"description": "Azure Active Directory OAuth2 Flow.",
30+
"scopes": {
31+
"user_impersonation": "impersonate your user account"
32+
}
33+
}
34+
},
35+
"paths": {
36+
"/providers/Microsoft.CostManagement/operations": {
37+
"get": {
38+
"tags": [
39+
"Operations"
40+
],
41+
"operationId": "Operations_List",
42+
"description": "Lists all of the available cost management REST API operations.",
43+
"x-ms-examples": {
44+
"OperationList": {
45+
"$ref": "./examples/OperationList.json"
46+
}
47+
},
48+
"parameters": [
49+
{
50+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
51+
}
52+
],
53+
"responses": {
54+
"200": {
55+
"description": "OK. The request has succeeded.",
56+
"schema": {
57+
"$ref": "#/definitions/OperationListResult"
58+
}
59+
},
60+
"default": {
61+
"description": "Error response describing why the operation failed.",
62+
"schema": {
63+
"$ref": "#/definitions/ErrorResponse"
64+
}
65+
}
66+
},
67+
"x-ms-pageable": {
68+
"nextLinkName": "nextLink"
69+
}
70+
}
71+
}
72+
},
73+
"definitions": {
74+
"ErrorResponse": {
75+
"description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.",
76+
"type": "object",
77+
"properties": {
78+
"error": {
79+
"description": "The details of the error.",
80+
"$ref": "#/definitions/ErrorDetails"
81+
}
82+
}
83+
},
84+
"ErrorDetails": {
85+
"description": "The details of the error.",
86+
"type": "object",
87+
"properties": {
88+
"code": {
89+
"description": "Error code.",
90+
"type": "string",
91+
"readOnly": true
92+
},
93+
"message": {
94+
"description": "Error message indicating why the operation failed.",
95+
"type": "string",
96+
"readOnly": true
97+
}
98+
}
99+
},
100+
"ErrorDetailsWithNestedDetails": {
101+
"description": "The details of the error.",
102+
"type": "object",
103+
"allOf": [
104+
{
105+
"$ref": "#/definitions/ErrorDetails"
106+
}
107+
],
108+
"properties": {
109+
"details": {
110+
"type": "array",
111+
"readOnly": true,
112+
"description": "The additional details of the error.",
113+
"items": {
114+
"$ref": "#/definitions/ErrorDetailsWithNestedDetails"
115+
},
116+
"x-ms-identifiers": []
117+
}
118+
}
119+
},
120+
"ErrorResponseWithNestedDetails": {
121+
"description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.",
122+
"type": "object",
123+
"properties": {
124+
"error": {
125+
"description": "The details of the error.",
126+
"$ref": "#/definitions/ErrorDetailsWithNestedDetails"
127+
}
128+
}
129+
},
130+
"CostManagementOperation": {
131+
"description": "A Cost management REST API operation.",
132+
"type": "object",
133+
"properties": {
134+
"id": {
135+
"description": "Operation id: {provider}/{resource}/{operation}.",
136+
"type": "string",
137+
"readOnly": true
138+
}
139+
},
140+
"allOf": [
141+
{
142+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Operation"
143+
}
144+
]
145+
},
146+
"OperationListResult": {
147+
"description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.",
148+
"type": "object",
149+
"properties": {
150+
"value": {
151+
"description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.",
152+
"type": "array",
153+
"readOnly": true,
154+
"items": {
155+
"$ref": "#/definitions/CostManagementOperation"
156+
}
157+
},
158+
"nextLink": {
159+
"description": "URL to get the next set of operation list results if there are any.",
160+
"type": "string",
161+
"readOnly": true
162+
}
163+
}
164+
},
165+
"CostManagementProxyResource": {
166+
"description": "The Resource model definition.",
167+
"type": "object",
168+
"properties": {
169+
"id": {
170+
"readOnly": true,
171+
"type": "string",
172+
"description": "Resource Id."
173+
},
174+
"name": {
175+
"readOnly": true,
176+
"type": "string",
177+
"description": "Resource name."
178+
},
179+
"type": {
180+
"readOnly": true,
181+
"type": "string",
182+
"description": "Resource type."
183+
},
184+
"eTag": {
185+
"type": "string",
186+
"description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
187+
}
188+
},
189+
"x-ms-azure-resource": true
190+
},
191+
"DownloadURL": {
192+
"description": "The URL to download the generated report.",
193+
"type": "object",
194+
"properties": {
195+
"expiryTime": {
196+
"description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.",
197+
"type": "string",
198+
"format": "date-time",
199+
"readOnly": true
200+
},
201+
"validTill": {
202+
"description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.",
203+
"type": "string",
204+
"format": "date-time"
205+
},
206+
"downloadUrl": {
207+
"description": "The URL to download the generated report.",
208+
"type": "string"
209+
}
210+
}
211+
}
212+
},
213+
"parameters": {
214+
"billingAccountIdParameter": {
215+
"description": "Billing account ID",
216+
"in": "path",
217+
"name": "billingAccountId",
218+
"required": true,
219+
"type": "string",
220+
"x-ms-parameter-location": "method"
221+
},
222+
"billingProfileIdParameter": {
223+
"description": "Billing profile ID.",
224+
"in": "path",
225+
"name": "billingProfileId",
226+
"required": true,
227+
"type": "string",
228+
"x-ms-parameter-location": "method"
229+
}
230+
}
231+
}

0 commit comments

Comments
 (0)