-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
subscriptions.json
716 lines (716 loc) · 20.9 KB
/
subscriptions.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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
{
"swagger": "2.0",
"info": {
"title": "SubscriptionClient",
"version": "2021-01-01",
"description": "All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/locations": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_ListLocations",
"summary": "Gets all available geo-locations.",
"description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "includeExtendedLocations",
"in": "query",
"required": false,
"type": "boolean",
"description": "Whether to include extended locations.",
"x-ms-parameter-location": "method"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of locations.",
"schema": {
"$ref": "#/definitions/LocationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
},
"x-ms-examples": {
"GetLocationsWithASubscriptionId": {
"$ref": "./examples/GetLocations.json"
},
"GetLocationsWithExtendedLocations": {
"$ref": "./examples/GetLocationsWithExtendedLocations.json"
}
}
}
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_Get",
"description": "Gets details about a specified subscription.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns information about the subscription.",
"schema": {
"$ref": "#/definitions/Subscription"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"GetASingleSubscription": {
"$ref": "./examples/GetSubscription.json"
}
}
}
},
"/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_List",
"description": "Gets all subscriptions for a tenant.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of subscriptions.",
"schema": {
"$ref": "#/definitions/SubscriptionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"GetAllSubscriptions": {
"$ref": "./examples/GetSubscriptions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/tenants": {
"get": {
"tags": [
"Tenants"
],
"operationId": "Tenants_List",
"description": "Gets the tenants for your account.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of tenants.",
"schema": {
"$ref": "#/definitions/TenantListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"GetAllTenants": {
"$ref": "./examples/GetTenants.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Resources/checkResourceName": {
"post": {
"tags": [
"Tenants"
],
"operationId": "checkResourceName",
"description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word",
"summary": "Checks resource name validity",
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/CheckResourceNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns status as allowed or not.",
"schema": {
"$ref": "#/definitions/CheckResourceNameResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"CheckValidityForAResourceName": {
"$ref": "./examples/CheckResourceName.json"
}
}
}
}
},
"definitions": {
"PairedRegion": {
"description": "Information regarding paired region.",
"properties": {
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the paired region."
},
"id": {
"readOnly": true,
"type": "string",
"description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
},
"subscriptionId": {
"readOnly": true,
"type": "string",
"description": "The subscription ID."
}
}
},
"LocationMetadata": {
"description": "Location metadata information",
"properties": {
"regionType": {
"readOnly": true,
"type": "string",
"description": "The type of the region.",
"enum": [
"Physical",
"Logical"
],
"x-ms-enum": {
"name": "RegionType",
"modelAsString": true
}
},
"regionCategory": {
"readOnly": true,
"type": "string",
"description": "The category of the region.",
"enum": [
"Recommended",
"Extended",
"Other"
],
"x-ms-enum": {
"name": "RegionCategory",
"modelAsString": true
}
},
"geographyGroup": {
"readOnly": true,
"type": "string",
"description": "The geography group of the location."
},
"longitude": {
"readOnly": true,
"type": "string",
"description": "The longitude of the location."
},
"latitude": {
"readOnly": true,
"type": "string",
"description": "The latitude of the location."
},
"physicalLocation": {
"readOnly": true,
"type": "string",
"description": "The physical location of the Azure location."
},
"pairedRegion": {
"type": "array",
"description": "The regions paired to this region.",
"items": {
"$ref": "#/definitions/PairedRegion"
}
},
"homeLocation": {
"readOnly": true,
"type": "string",
"description": "The home location of an edge zone."
}
}
},
"Location": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
},
"subscriptionId": {
"readOnly": true,
"type": "string",
"description": "The subscription ID."
},
"name": {
"readOnly": true,
"type": "string",
"description": "The location name."
},
"type": {
"readOnly": true,
"type": "string",
"description": "The location type.",
"enum": [
"Region",
"EdgeZone"
],
"x-ms-enum": {
"name": "LocationType",
"modelAsString": false
}
},
"displayName": {
"readOnly": true,
"type": "string",
"description": "The display name of the location."
},
"regionalDisplayName": {
"readOnly": true,
"type": "string",
"description": "The display name of the location and its region."
},
"metadata": {
"description": "Metadata of the location, such as lat/long, paired region, and others.",
"$ref": "#/definitions/LocationMetadata"
}
},
"description": "Location information."
},
"LocationListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Location"
},
"description": "An array of locations."
}
},
"description": "Location list operation response."
},
"Subscription": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000."
},
"subscriptionId": {
"readOnly": true,
"type": "string",
"description": "The subscription ID."
},
"displayName": {
"readOnly": true,
"type": "string",
"description": "The subscription display name."
},
"tenantId": {
"readOnly": true,
"type": "string",
"description": "The subscription tenant ID."
},
"state": {
"readOnly": true,
"type": "string",
"description": "The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.",
"enum": [
"Enabled",
"Warned",
"PastDue",
"Disabled",
"Deleted"
],
"x-ms-enum": {
"name": "SubscriptionState",
"modelAsString": false
}
},
"subscriptionPolicies": {
"$ref": "#/definitions/SubscriptionPolicies",
"description": "The subscription policies."
},
"authorizationSource": {
"type": "string",
"description": "The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'."
},
"managedByTenants": {
"type": "array",
"items": {
"$ref": "#/definitions/ManagedByTenant"
},
"description": "An array containing the tenants managing the subscription."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The additional properties. "
},
"description": "The tags attached to the subscription."
}
},
"description": "Subscription information."
},
"SubscriptionPolicies": {
"properties": {
"locationPlacementId": {
"readOnly": true,
"type": "string",
"description": "The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions."
},
"quotaId": {
"readOnly": true,
"type": "string",
"description": "The subscription quota ID."
},
"spendingLimit": {
"readOnly": true,
"type": "string",
"description": "The subscription spending limit.",
"enum": [
"On",
"Off",
"CurrentPeriodOff"
],
"x-ms-enum": {
"name": "spendingLimit",
"modelAsString": false
}
}
},
"description": "Subscription policies."
},
"ManagedByTenant": {
"properties": {
"tenantId": {
"readOnly": true,
"type": "string",
"description": "The tenant ID of the managing tenant. This is a GUID."
}
},
"description": "Information about a tenant managing the subscription."
},
"SubscriptionListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Subscription"
},
"description": "An array of subscriptions."
},
"nextLink": {
"type": "string",
"description": "The URL to get the next set of results."
}
},
"required": [
"nextLink"
],
"description": "Subscription list operation response."
},
"TenantIdDescription": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000."
},
"tenantId": {
"readOnly": true,
"type": "string",
"description": "The tenant ID. For example, 00000000-0000-0000-0000-000000000000."
},
"tenantCategory": {
"readOnly": true,
"type": "string",
"description": "Category of the tenant.",
"enum": [
"Home",
"ProjectedBy",
"ManagedBy"
],
"x-ms-enum": {
"name": "TenantCategory",
"modelAsString": false
}
},
"country": {
"readOnly": true,
"type": "string",
"description": "Country/region name of the address for the tenant."
},
"countryCode": {
"readOnly": true,
"type": "string",
"description": "Country/region abbreviation for the tenant."
},
"displayName": {
"readOnly": true,
"type": "string",
"description": "The display name of the tenant."
},
"domains": {
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"description": "The domain name for a tenant."
},
"description": "The list of domains for the tenant."
},
"defaultDomain": {
"readOnly": true,
"type": "string",
"description": "The default domain for the tenant."
},
"tenantType": {
"readOnly": true,
"type": "string",
"description": "The tenant type. Only available for 'Home' tenant category."
},
"tenantBrandingLogoUrl": {
"readOnly": true,
"type": "string",
"description": "The tenant's branding logo URL. Only available for 'Home' tenant category."
}
},
"description": "Tenant Id information."
},
"TenantListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/TenantIdDescription"
},
"description": "An array of tenants."
},
"nextLink": {
"type": "string",
"description": "The URL to use for getting the next set of results."
}
},
"required": [
"nextLink"
],
"description": "Tenant Ids information."
},
"ResourceName": {
"description": "Name and Type of the Resource",
"required": [
"name",
"type"
],
"properties": {
"name": {
"description": "Name of the resource",
"type": "string"
},
"type": {
"type": "string",
"description": "The type of the resource"
}
}
},
"CheckResourceNameResult": {
"properties": {
"name": {
"description": "Name of Resource",
"type": "string"
},
"type": {
"description": "Type of Resource",
"type": "string"
},
"status": {
"description": "Is the resource name Allowed or Reserved",
"type": "string",
"enum": [
"Allowed",
"Reserved"
],
"x-ms-enum": {
"name": "ResourceNameStatus",
"modelAsString": true
}
}
},
"description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word"
},
"CloudError": {
"x-ms-external": true,
"properties": {
"error": {
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
}
},
"description": "An error response for a resource management request."
},
"Operation": {
"description": "Microsoft.Resources operation",
"type": "object",
"properties": {
"name": {
"description": "Operation name: {provider}/{resource}/{operation}",
"type": "string"
},
"display": {
"description": "The object that represents the operation.",
"properties": {
"provider": {
"description": "Service provider: Microsoft.Resources",
"type": "string"
},
"resource": {
"description": "Resource on which the operation is performed: Profile, endpoint, etc.",
"type": "string"
},
"operation": {
"description": "Operation type: Read, write, delete, etc.",
"type": "string"
},
"description": {
"description": "Description of the operation.",
"type": "string"
}
}
}
}
},
"OperationListResult": {
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Operation"
},
"description": "List of Microsoft.Resources operations."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of operation list results if there are any."
}
}
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "The ID of the target subscription.",
"x-ms-parameter-location": "method"
},
"CheckResourceNameParameter": {
"description": "Resource object with values for resource name and resource type",
"in": "body",
"name": "Resource Name Definition",
"schema": {
"$ref": "#/definitions/ResourceName"
},
"x-ms-parameter-location": "method"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The API version to use for the operation.",
"x-ms-parameter-location": "client"
}
}
}