-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
associatedTenant.json
375 lines (375 loc) · 11.1 KB
/
associatedTenant.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
{
"swagger": "2.0",
"info": {
"title": "BillingManagementClient",
"description": "Documentation for Microsoft.Billing.",
"contact": {
"name": "Microsoft.Billing",
"url": "https://learn.microsoft.com/en-us/rest/api/billing/",
"email": "pacebpexphot@microsoft.com"
},
"version": "2023-04-01"
},
"paths": {
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}": {
"delete": {
"tags": [
"AssociatedTenant"
],
"description": "Deletes an associated tenant for a billing account.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_Delete",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"$ref": "./types.json#/parameters/associatedTenantName"
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"202": {
"description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.",
"headers": {
"Location": {
"type": "string"
},
"Retry-After": {
"type": "integer",
"format": "int32"
}
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"AssociatedTenantsDelete": {
"$ref": "./examples/associatedTenantsDelete.json"
}
}
},
"get": {
"tags": [
"AssociatedTenant"
],
"description": "Gets an associated tenant by ID.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_Get",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"$ref": "./types.json#/parameters/associatedTenantName"
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-examples": {
"AssociatedTenantsGet": {
"$ref": "./examples/associatedTenantsGet.json"
}
}
},
"put": {
"tags": [
"AssociatedTenant"
],
"description": "Create or update an associated tenant for the billing account.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_CreateOrUpdate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"$ref": "./types.json#/parameters/associatedTenantName"
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
}
}
],
"responses": {
"200": {
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
}
},
"201": {
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
},
"headers": {
"Location": {
"type": "string"
},
"Retry-After": {
"type": "integer",
"format": "int32"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"AssociatedTenantsCreateOrUpdate": {
"$ref": "./examples/associatedTenantsCreateOrUpdate.json"
}
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants": {
"get": {
"tags": [
"AssociatedTenant"
],
"description": "Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_ListByBillingAccount",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"in": "query",
"name": "includeRevoked",
"description": "Can be used to get revoked associated tenants.",
"type": "boolean",
"default": false
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
},
{
"$ref": "./types.json#/parameters/filter"
},
{
"$ref": "./types.json#/parameters/orderBy"
},
{
"$ref": "./types.json#/parameters/top"
},
{
"$ref": "./types.json#/parameters/skip"
},
{
"$ref": "./types.json#/parameters/count"
},
{
"$ref": "./types.json#/parameters/search"
}
],
"responses": {
"200": {
"description": "A list of associated tenants.",
"schema": {
"$ref": "#/definitions/AssociatedTenantListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-examples": {
"AssociatedTenantsListByBillingAccount": {
"$ref": "./examples/associatedTenantsListByBillingAccount.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"AssociatedTenant": {
"description": "An associated tenant.",
"type": "object",
"allOf": [
{
"$ref": "./types.json#/definitions/ArmResource"
}
],
"properties": {
"properties": {
"description": "The properties of a(n) AssociatedTenant",
"allOf": [
{
"$ref": "#/definitions/AssociatedTenantProperties"
}
],
"x-ms-client-flatten": true
}
},
"x-ms-azure-resource": true
},
"AssociatedTenantListResult": {
"description": "A container for a list of resources",
"type": "object",
"properties": {
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
},
"value": {
"description": "The list of resources.",
"type": "array",
"items": {
"$ref": "#/definitions/AssociatedTenant"
},
"readOnly": true,
"x-ms-identifiers": [
"id"
]
}
}
},
"AssociatedTenantProperties": {
"description": "An associated tenant.",
"type": "object",
"properties": {
"displayName": {
"description": "The name of the associated tenant.",
"type": "string"
},
"tenantId": {
"description": "The ID that uniquely identifies a tenant.",
"type": "string"
},
"billingManagementState": {
"description": "The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.",
"enum": [
"Other",
"NotAllowed",
"Active",
"Revoked"
],
"type": "string",
"x-ms-enum": {
"name": "BillingManagementTenantState",
"modelAsString": true
}
},
"provisioningManagementState": {
"description": "The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.",
"enum": [
"Other",
"NotRequested",
"Active",
"Pending",
"BillingRequestExpired",
"BillingRequestDeclined",
"Revoked"
],
"type": "string",
"x-ms-enum": {
"name": "ProvisioningTenantState",
"modelAsString": true
}
},
"provisioningBillingRequestId": {
"description": "The unique identifier for the billing request that is created when enabling provisioning for an associated tenant.",
"type": "string",
"readOnly": true
}
}
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"description": "Azure Active Directory OAuth2 Flow."
}
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
]
}