-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
apimanagement.json
791 lines (791 loc) · 24.7 KB
/
apimanagement.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
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
{
"swagger": "2.0",
"info": {
"title": "ApiManagementClient",
"description": "Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.",
"version": "2020-06-01-preview"
},
"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": {},
"definitions": {
"ErrorFieldContract": {
"properties": {
"code": {
"type": "string",
"description": "Property level error code."
},
"message": {
"type": "string",
"description": "Human-readable representation of property-level error."
},
"target": {
"type": "string",
"description": "Property name."
}
},
"description": "Error Field contract."
},
"ErrorResponse": {
"properties": {
"error": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ErrorResponseBody",
"description": "Properties of the Error Response."
}
},
"description": "Error Response."
},
"ErrorResponseBody": {
"properties": {
"code": {
"type": "string",
"description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response."
},
"message": {
"type": "string",
"description": "Human-readable representation of the error."
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/ErrorFieldContract"
},
"description": "The list of invalid fields send in request, in case of validation error."
}
},
"description": "Error Body contract."
},
"RegionContract": {
"properties": {
"name": {
"type": "string",
"description": "Region name.",
"readOnly": true
},
"isMasterRegion": {
"description": "whether Region is the master region.",
"type": "boolean"
},
"isDeleted": {
"description": "whether Region is deleted.",
"type": "boolean"
}
},
"description": "Region profile."
},
"RegionListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/RegionContract"
},
"description": "Lists of Regions."
},
"count": {
"type": "integer",
"format": "int64",
"description": "Total record count number across all pages."
},
"nextLink": {
"type": "string",
"description": "Next page link if any."
}
},
"description": "Lists Regions operation response details."
},
"Resource": {
"description": "The Resource definition.",
"x-ms-azure-resource": true,
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "Resource ID."
},
"name": {
"type": "string",
"description": "Resource name.",
"readOnly": true
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type for API Management resource."
}
}
}
},
"parameters": {
"AccessParameter": {
"name": "accessName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"access",
"getAccess"
],
"x-ms-enum": {
"modelAsString": true,
"name": "AccessIdName"
},
"description": "The identifier of the Access configuration.",
"x-ms-parameter-location": "method"
},
"SettingsParameter": {
"name": "settingsType",
"in": "path",
"required": true,
"type": "string",
"enum": [
"public"
],
"x-ms-enum": {
"modelAsString": true,
"name": "settingsTypeName"
},
"description": "The identifier of the settings.",
"x-ms-parameter-location": "method"
},
"ApiIdParameter": {
"name": "apiId",
"in": "path",
"required": true,
"type": "string",
"description": "API identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"ApiIdRevParameter": {
"name": "apiId",
"in": "path",
"required": true,
"type": "string",
"description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "Version of the API to be used with the client request."
},
"ApiVersionSetIdParameter": {
"name": "versionSetId",
"in": "path",
"required": true,
"type": "string",
"description": "Api Version Set identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"AppTypeParameter": {
"name": "appType",
"in": "query",
"required": false,
"type": "string",
"description": "Determines the type of application which send the create user request. Default is legacy publisher portal.",
"enum": [
"portal",
"developerPortal"
],
"x-ms-enum": {
"name": "AppType",
"modelAsString": true,
"values": [
{
"value": "portal",
"description": "User create request was sent by legacy developer portal."
},
{
"value": "developerPortal",
"description": "User create request was sent by new developer portal."
}
]
},
"default": "portal",
"x-ms-parameter-location": "method"
},
"AttachmentIdParameter": {
"name": "attachmentId",
"in": "path",
"required": true,
"type": "string",
"description": "Attachment identifier within an Issue. Must be unique in the current Issue.",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"AuthenticationServerIdParameter": {
"name": "authsid",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the authorization server.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"BackendIdParameter": {
"name": "backendId",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"CacheIdParameter": {
"name": "cacheId",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"CertificateIdParameter": {
"name": "certificateId",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"CommentIdParameter": {
"name": "commentId",
"in": "path",
"required": true,
"type": "string",
"description": "Comment identifier within an Issue. Must be unique in the current Issue.",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"ConfigurationParameter": {
"name": "configurationName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"configuration"
],
"x-ms-enum": {
"modelAsString": true,
"name": "configurationIdName"
},
"description": "The identifier of the Git Configuration Operation.",
"x-ms-parameter-location": "method"
},
"DiagnosticIdParameter": {
"name": "diagnosticId",
"in": "path",
"required": true,
"type": "string",
"description": "Diagnostic identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"EmailParameter": {
"name": "email",
"in": "path",
"required": true,
"type": "string",
"description": "Email identifier.",
"x-ms-parameter-location": "method"
},
"GroupIdParameter": {
"name": "groupId",
"in": "path",
"required": true,
"type": "string",
"description": "Group identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 256,
"x-ms-parameter-location": "method"
},
"IdentityProviderNameParameter": {
"name": "identityProviderName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"facebook",
"google",
"microsoft",
"twitter",
"aad",
"aadB2C"
],
"x-ms-enum": {
"name": "IdentityProviderType",
"modelAsString": true,
"values": [
{
"value": "facebook",
"description": "Facebook as Identity provider."
},
{
"value": "google",
"description": "Google as Identity provider."
},
{
"value": "microsoft",
"description": "Microsoft Live as Identity provider."
},
{
"value": "twitter",
"description": "Twitter as Identity provider."
},
{
"value": "aad",
"description": "Azure Active Directory as Identity provider."
},
{
"value": "aadB2C",
"description": "Azure Active Directory B2C as Identity provider."
}
]
},
"description": "Identity Provider Type identifier.",
"x-ms-parameter-location": "method"
},
"IfMatchOptionalParameter": {
"name": "If-Match",
"in": "header",
"required": false,
"description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.",
"type": "string",
"x-ms-parameter-location": "method"
},
"IfMatchRequiredParameter": {
"name": "If-Match",
"in": "header",
"required": true,
"description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.",
"type": "string",
"x-ms-parameter-location": "method"
},
"IssueIdParameter": {
"name": "issueId",
"in": "path",
"required": true,
"type": "string",
"description": "Issue identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"LocationNameParameter": {
"name": "locationName",
"in": "path",
"required": true,
"type": "string",
"description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.",
"minLength": 1,
"x-ms-parameter-location": "method"
},
"LoggerIdParameter": {
"name": "loggerId",
"in": "path",
"required": true,
"type": "string",
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"description": "Logger identifier. Must be unique in the API Management service instance.",
"x-ms-parameter-location": "method"
},
"NotificationNameParameter": {
"name": "notificationName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"RequestPublisherNotificationMessage",
"PurchasePublisherNotificationMessage",
"NewApplicationNotificationMessage",
"BCC",
"NewIssuePublisherNotificationMessage",
"AccountClosedPublisher",
"QuotaLimitApproachingPublisherNotificationMessage"
],
"x-ms-enum": {
"name": "NotificationName",
"modelAsString": true,
"values": [
{
"value": "RequestPublisherNotificationMessage",
"description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval."
},
{
"value": "PurchasePublisherNotificationMessage",
"description": "The following email recipients and users will receive email notifications about new API product subscriptions."
},
{
"value": "NewApplicationNotificationMessage",
"description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery."
},
{
"value": "BCC",
"description": "The following recipients will receive blind carbon copies of all emails sent to developers."
},
{
"value": "NewIssuePublisherNotificationMessage",
"description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal."
},
{
"value": "AccountClosedPublisher",
"description": "The following email recipients and users will receive email notifications when developer closes his account."
},
{
"value": "QuotaLimitApproachingPublisherNotificationMessage",
"description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota."
}
]
},
"description": "Notification Name Identifier.",
"x-ms-parameter-location": "method"
},
"NotifySubscriptionStateChangeParameter": {
"name": "notify",
"in": "query",
"required": false,
"type": "boolean",
"description": "Notify change in Subscription State. \n - If false, do not send any email notification for change of state of subscription \n - If true, send email notification of change of state of subscription ",
"x-ms-parameter-location": "method"
},
"OpenIdConnectIdParameter": {
"name": "opid",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the OpenID Connect Provider.",
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"OperationIdParameter": {
"name": "operationId",
"in": "path",
"required": true,
"type": "string",
"description": "Operation identifier within an API. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"PolicyExportFormat": {
"name": "format",
"in": "query",
"required": false,
"type": "string",
"description": "Policy Export Format.",
"enum": [
"xml",
"rawxml"
],
"x-ms-enum": {
"name": "PolicyExportFormat",
"modelAsString": true,
"values": [
{
"value": "xml",
"description": "The contents are inline and Content type is an XML document."
},
{
"value": "rawxml",
"description": "The contents are inline and Content type is a non XML encoded policy document."
}
]
},
"default": "xml",
"x-ms-parameter-location": "method"
},
"PolicyIdParameter": {
"name": "policyId",
"in": "path",
"required": true,
"type": "string",
"enum": [
"policy"
],
"description": "The identifier of the Policy.",
"x-ms-enum": {
"modelAsString": true,
"name": "PolicyIdName"
},
"x-ms-parameter-location": "method"
},
"PortalRevisionIdParameter": {
"name": "portalRevisionId",
"in": "path",
"required": true,
"type": "string",
"description": "Portal revision identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 256,
"x-ms-parameter-location": "method"
},
"ProductIdParameter": {
"name": "productId",
"in": "path",
"required": true,
"type": "string",
"description": "Product identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 256,
"x-ms-parameter-location": "method"
},
"NamedValueIdParameter": {
"name": "namedValueId",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the NamedValue.",
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"QuotaCounterKeyParameter": {
"name": "quotaCounterKey",
"in": "path",
"required": true,
"type": "string",
"description": "Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key",
"x-ms-parameter-location": "method"
},
"QuotaPeriodKeyParameter": {
"name": "quotaPeriodKey",
"in": "path",
"required": true,
"type": "string",
"description": "Quota period key identifier.",
"x-ms-parameter-location": "method"
},
"ReleaseIdParameter": {
"name": "releaseId",
"in": "path",
"required": true,
"type": "string",
"description": "Release identifier within an API. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"ResourceGroupNameParameter": {
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group.",
"x-ms-parameter-location": "method"
},
"SchemaIdParameter": {
"name": "schemaId",
"in": "path",
"required": true,
"type": "string",
"description": "Schema identifier within an API. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"ServiceNameParameter": {
"name": "serviceName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the API Management service.",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"x-ms-parameter-location": "method"
},
"SkipQueryParameter": {
"name": "$skip",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "Number of records to skip.",
"minimum": 0,
"x-ms-parameter-location": "method"
},
"SubscriptionEntityIdParameter": {
"name": "sid",
"in": "path",
"required": true,
"type": "string",
"description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.",
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
},
"TagIdParameter": {
"name": "tagId",
"in": "path",
"required": true,
"type": "string",
"description": "Tag identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"TagDescriptionIdParameter": {
"name": "tagDescriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.",
"minLength": 1,
"maxLength": 80,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
},
"TemplateNameParameter": {
"name": "templateName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"applicationApprovedNotificationMessage",
"accountClosedDeveloper",
"quotaLimitApproachingDeveloperNotificationMessage",
"newDeveloperNotificationMessage",
"emailChangeIdentityDefault",
"inviteUserNotificationMessage",
"newCommentNotificationMessage",
"confirmSignUpIdentityDefault",
"newIssueNotificationMessage",
"purchaseDeveloperNotificationMessage",
"passwordResetIdentityDefault",
"passwordResetByAdminNotificationMessage",
"rejectDeveloperNotificationMessage",
"requestDeveloperNotificationMessage"
],
"x-ms-enum": {
"name": "TemplateName",
"modelAsString": true
},
"description": "Email Template Name Identifier.",
"x-ms-parameter-location": "method"
},
"TopQueryParameter": {
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "Number of records to return.",
"minimum": 1,
"x-ms-parameter-location": "method"
},
"UserIdParameter": {
"name": "userId",
"in": "path",
"required": true,
"type": "string",
"description": "User identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"GatewayIdParameter": {
"name": "gatewayId",
"in": "path",
"required": true,
"type": "string",
"description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"GatewayHostnameConfigurationIdParameter": {
"name": "hcId",
"in": "path",
"required": true,
"type": "string",
"description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"ContentTypeIdParameter": {
"name": "contentTypeId",
"in": "path",
"required": true,
"type": "string",
"description": "Content type identifier.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"ContentItemIdParameter": {
"name": "contentItemId",
"in": "path",
"required": true,
"type": "string",
"description": "Content item identifier.",
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
}
}
}