-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
Copy pathcommitmentPlans.json
1055 lines (1055 loc) · 31.6 KB
/
commitmentPlans.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
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Azure ML Commitment Plans Management Client",
"description": "These APIs allow end users to operate on Azure Machine Learning Commitment Plans resources and their child Commitment Association resources. They support CRUD operations for commitment plans, get and list operations for commitment associations, moving commitment associations between commitment plans, and retrieving commitment plan usage history.",
"version": "2016-05-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/providers/Microsoft.MachineLearning/operations": {
"get": {
"tags": [
"Operation"
],
"description": "Lists all of the available Azure Machine Learning Studio Commitment Plan RP REST API operations.",
"operationId": "Operations_List",
"parameters": [
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/OperationEntityListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/skus": {
"get": {
"tags": [
"Skus"
],
"operationId": "Skus_List",
"description": "Lists the available commitment plan SKUs.",
"x-ms-pageable": {
"nextLinkName": null
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SkuListResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/commitmentAssociations/{commitmentAssociationName}": {
"get": {
"tags": [
"CommitmentAssociations"
],
"operationId": "CommitmentAssociations_Get",
"description": "Get a commitment association.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/CommitmentPlanNameParameter"
},
{
"$ref": "#/parameters/CommitmentAssociationNameParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentAssociation"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/commitmentAssociations": {
"get": {
"tags": [
"CommitmentAssociations"
],
"operationId": "CommitmentAssociations_List",
"description": "Get all commitment associations for a parent commitment plan.",
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/CommitmentPlanNameParameter"
},
{
"$ref": "#/parameters/SkipTokenParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentAssociationListResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/commitmentAssociations/{commitmentAssociationName}/move": {
"post": {
"tags": [
"CommitmentAssociations"
],
"operationId": "CommitmentAssociations_Move",
"description": "Re-parent a commitment association from one commitment plan to another.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/CommitmentPlanNameParameter"
},
{
"$ref": "#/parameters/CommitmentAssociationNameParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
},
{
"name": "movePayload",
"description": "The move request payload.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MoveCommitmentAssociationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentAssociation"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}": {
"get": {
"tags": [
"CommitmentPlans"
],
"operationId": "CommitmentPlans_Get",
"description": "Retrieve an Azure ML commitment plan by its subscription, resource group and name.",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentPlan"
}
}
}
},
"put": {
"tags": [
"CommitmentPlans"
],
"operationId": "CommitmentPlans_CreateOrUpdate",
"description": "Create a new Azure ML commitment plan resource or updates an existing one.",
"parameters": [
{
"name": "createOrUpdatePayload",
"description": "The payload to create or update the Azure ML commitment plan.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CommitmentPlan"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentPlan"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/CommitmentPlan"
}
}
}
},
"delete": {
"tags": [
"CommitmentPlans"
],
"operationId": "CommitmentPlans_Remove",
"description": "Remove an existing Azure ML commitment plan.",
"responses": {
"200": {
"description": "OK"
}
}
},
"patch": {
"tags": [
"CommitmentPlans"
],
"operationId": "CommitmentPlans_Patch",
"description": "Patch an existing Azure ML commitment plan resource.",
"parameters": [
{
"name": "patchPayload",
"description": "The payload to use to patch the Azure ML commitment plan. Only tags and SKU may be modified on an existing commitment plan.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CommitmentPlanPatchPayload"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentPlan"
}
}
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/CommitmentPlanNameParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
]
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/commitmentPlans": {
"get": {
"tags": [
"CommitmentPlans"
],
"operationId": "CommitmentPlans_List",
"description": "Retrieve all Azure ML commitment plans in a subscription.",
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "$skipToken",
"description": "Continuation token for pagination.",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentPlanListResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans": {
"get": {
"tags": [
"CommitmentPlans"
],
"operationId": "CommitmentPlans_ListInResourceGroup",
"description": "Retrieve all Azure ML commitment plans in a resource group.",
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SkipTokenParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommitmentPlanListResult"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/usageHistory": {
"get": {
"tags": [
"CommitmentPlans"
],
"operationId": "UsageHistory_List",
"description": "Retrieve the usage history for an Azure ML commitment plan.",
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/CommitmentPlanNameParameter"
},
{
"$ref": "#/parameters/SkipTokenParameter"
},
{
"$ref": "#/parameters/APIVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PlanUsageHistoryListResult"
}
}
}
}
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"description": "Azure Subscription ID.",
"type": "string",
"in": "path",
"required": true
},
"APIVersionParameter": {
"name": "api-version",
"description": "The version of the Microsoft.MachineLearning resource provider API to use.",
"type": "string",
"in": "query",
"required": true
},
"ResourceGroupNameParameter": {
"x-ms-parameter-location": "method",
"name": "resourceGroupName",
"description": "The resource group name.",
"type": "string",
"in": "path",
"required": true
},
"CommitmentPlanNameParameter": {
"x-ms-parameter-location": "method",
"name": "commitmentPlanName",
"description": "The Azure ML commitment plan name.",
"type": "string",
"in": "path",
"required": true
},
"CommitmentAssociationNameParameter": {
"x-ms-parameter-location": "method",
"name": "commitmentAssociationName",
"description": "The commitment association name.",
"type": "string",
"in": "path",
"required": true
},
"SkipTokenParameter": {
"x-ms-parameter-location": "method",
"name": "$skipToken",
"description": "Continuation token for pagination.",
"type": "string",
"in": "query",
"required": false
}
},
"definitions": {
"SkuListResult": {
"type": "object",
"description": "The list of commitment plan SKUs.",
"properties": {
"value": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/CatalogSku"
},
"x-ms-identifiers": []
}
}
},
"CatalogSku": {
"type": "object",
"description": "Details of a commitment plan SKU.",
"properties": {
"resourceType": {
"readOnly": true,
"type": "string",
"description": "Resource type name"
},
"name": {
"readOnly": true,
"type": "string",
"description": "SKU name"
},
"tier": {
"readOnly": true,
"type": "string",
"description": "SKU tier"
},
"locations": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Regions where the SKU is available."
},
"capacity": {
"readOnly": true,
"description": "SKU scaling information",
"$ref": "#/definitions/SkuCapacity"
},
"capabilities": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/SkuCapability"
},
"x-ms-identifiers": [
"name"
],
"description": "The capability information for the specified SKU."
},
"costs": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/SkuCost"
},
"x-ms-identifiers": [],
"description": "The cost information for the specified SKU."
},
"restrictions": {
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/SkuRestrictions"
},
"x-ms-identifiers": [],
"description": "Restrictions which would prevent a SKU from being used. This is empty if there are no restrictions."
}
}
},
"SkuCapacity": {
"type": "object",
"description": "Describes scaling information of a SKU.",
"properties": {
"minimum": {
"type": "integer",
"readOnly": true,
"format": "int64",
"description": "The minimum capacity."
},
"maximum": {
"type": "integer",
"readOnly": true,
"format": "int64",
"description": "The maximum capacity that can be set."
},
"default": {
"type": "integer",
"readOnly": true,
"format": "int64",
"description": "The default capacity."
},
"scaleType": {
"type": "string",
"readOnly": true,
"description": "The scale type applicable to the sku.",
"enum": [
"Automatic",
"Manual",
"None"
],
"x-ms-enum": {
"name": "SkuCapacityScaleType",
"modelAsString": true
}
}
}
},
"SkuCost": {
"type": "object",
"description": "Describes metadata for SKU cost info.",
"properties": {
"meterID": {
"type": "string",
"readOnly": true,
"description": "The meter used for this part of a SKU's cost."
},
"quantity": {
"type": "integer",
"readOnly": true,
"format": "int64",
"description": "The multiplier for the meter ID."
},
"extendedUnit": {
"type": "string",
"readOnly": true,
"description": "The overall duration represented by the quantity."
}
}
},
"SkuCapability": {
"type": "object",
"description": "Describes The SKU capabilities object.",
"properties": {
"name": {
"type": "string",
"readOnly": true,
"description": "The capability name."
},
"value": {
"type": "string",
"readOnly": true,
"description": "The capability value."
}
}
},
"SkuRestrictions": {
"properties": {
"type": {
"type": "string",
"readOnly": true,
"description": "The type of restrictions.",
"enum": [
"location",
"zone"
],
"x-ms-enum": {
"name": "ResourceSkuRestrictionsType",
"modelAsString": true
}
},
"values": {
"type": "array",
"readOnly": true,
"items": {
"type": "string"
},
"description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted."
},
"reasonCode": {
"type": "string",
"readOnly": true,
"description": "The reason for restriction.",
"enum": [
"QuotaId",
"NotAvailableForSubscription"
],
"x-ms-enum": {
"name": "ResourceSkuRestrictionsReasonCode",
"modelAsString": true
}
}
},
"description": "Describes restrictions which would prevent a SKU from being used."
},
"Tags": {
"type": "object",
"description": "Resource tags",
"additionalProperties": {
"type": "string"
}
},
"Resource": {
"x-ms-azure-resource": true,
"description": "Common properties of an ARM resource.",
"required": [
"location"
],
"properties": {
"id": {
"description": "Resource Id.",
"type": "string",
"readOnly": true
},
"name": {
"description": "Resource name.",
"type": "string",
"readOnly": true
},
"location": {
"description": "Resource location.",
"type": "string"
},
"type": {
"description": "Resource type.",
"type": "string",
"readOnly": true
},
"tags": {
"description": "User-defined tags for the resource.",
"$ref": "#/definitions/Tags"
}
}
},
"CommitmentAssociation": {
"type": "object",
"description": "Represents the association between a commitment plan and some other resource, such as a Machine Learning web service.",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"etag": {
"type": "string",
"description": "An entity tag used to enforce optimistic concurrency."
},
"properties": {
"description": "The properties of the commitment association resource.",
"$ref": "#/definitions/CommitmentAssociationProperties"
}
}
},
"CommitmentAssociationProperties": {
"type": "object",
"description": "Properties of an Azure ML commitment association.",
"properties": {
"associatedResourceId": {
"type": "string",
"description": "The ID of the resource this association points to, such as the ARM ID of an Azure ML web service.",
"readOnly": true
},
"commitmentPlanId": {
"type": "string",
"description": "The ARM ID of the parent Azure ML commitment plan.",
"readOnly": true
},
"creationDate": {
"format": "date-time",
"type": "string",
"description": "The date at which this commitment association was created, in ISO 8601 format.",
"readOnly": true
}
}
},
"ResourceSku": {
"type": "object",
"description": "The SKU of a resource.",
"properties": {
"capacity": {
"format": "int32",
"type": "integer",
"description": "The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource."
},
"name": {
"type": "string",
"description": "The SKU name. Along with tier, uniquely identifies the SKU."
},
"tier": {
"type": "string",
"description": "The SKU tier. Along with name, uniquely identifies the SKU."
}
}
},
"CommitmentAssociationListResult": {
"type": "object",
"description": "A page of commitment association resources.",
"properties": {
"nextLink": {
"type": "string",
"description": "A URI to retrieve the next page of results."
},
"value": {
"type": "array",
"description": "The set of results for this page.",
"items": {
"$ref": "#/definitions/CommitmentAssociation"
}
}
}
},
"MoveCommitmentAssociationRequest": {
"type": "object",
"description": "Specifies the destination Azure ML commitment plan for a move operation.",
"properties": {
"destinationPlanId": {
"type": "string",
"description": "The ARM ID of the commitment plan to re-parent the commitment association to."
}
}
},
"CommitmentPlanPatchPayload": {
"type": "object",
"description": "The properties of a commitment plan which may be updated via PATCH.",
"properties": {
"tags": {
"description": "User-defined tags for the commitment plan.",
"$ref": "#/definitions/Tags"
},
"sku": {
"description": "The commitment plan SKU.",
"$ref": "#/definitions/ResourceSku"
}
}
},
"CommitmentPlan": {
"type": "object",
"description": "An Azure ML commitment plan resource.",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"etag": {
"type": "string",
"description": "An entity tag used to enforce optimistic concurrency."
},
"properties": {
"description": "The commitment plan properties.",
"$ref": "#/definitions/CommitmentPlanProperties",
"readOnly": true
},
"sku": {
"description": "The commitment plan SKU.",
"$ref": "#/definitions/ResourceSku"
}
}
},
"CommitmentPlanProperties": {
"type": "object",
"description": "Properties of an Azure ML commitment plan.",
"properties": {
"chargeForOverage": {
"type": "boolean",
"description": "Indicates whether usage beyond the commitment plan's included quantities will be charged.",
"readOnly": true
},
"chargeForPlan": {
"type": "boolean",
"description": "Indicates whether the commitment plan will incur a charge.",
"readOnly": true
},
"creationDate": {
"format": "date-time",
"type": "string",
"description": "The date at which this commitment plan was created, in ISO 8601 format.",
"readOnly": true
},
"includedQuantities": {
"type": "object",
"description": "The included resource quantities this plan gives you.",
"additionalProperties": {
"$ref": "#/definitions/PlanQuantity"
},
"readOnly": true
},
"maxAssociationLimit": {
"format": "int32",
"type": "integer",
"description": "The maximum number of commitment associations that can be children of this commitment plan.",
"readOnly": true
},
"maxCapacityLimit": {
"format": "int32",
"type": "integer",
"description": "The maximum scale-out capacity for this commitment plan.",
"readOnly": true
},
"minCapacityLimit": {
"format": "int32",
"type": "integer",
"description": "The minimum scale-out capacity for this commitment plan.",
"readOnly": true
},
"planMeter": {
"type": "string",
"description": "The Azure meter which will be used to charge for this commitment plan.",
"readOnly": true
},
"refillFrequencyInDays": {
"format": "int32",
"type": "integer",
"description": "The frequency at which this commitment plan's included quantities are refilled.",
"readOnly": true
},
"suspendPlanOnOverage": {
"type": "boolean",
"description": "Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.",
"readOnly": true
}
}
},
"PlanQuantity": {
"type": "object",
"description": "Represents the quantity a commitment plan provides of a metered resource.",
"properties": {
"allowance": {
"format": "double",
"type": "number",
"description": "The quantity added to the commitment plan at an interval specified by its allowance frequency.",
"readOnly": true
},
"amount": {
"format": "double",
"type": "number",
"description": "The quantity available to the plan the last time usage was calculated.",
"readOnly": true
},
"includedQuantityMeter": {
"type": "string",
"description": "The Azure meter for usage against included quantities.",
"readOnly": true
},
"overageMeter": {
"type": "string",
"description": "The Azure meter for usage which exceeds included quantities.",
"readOnly": true
}
}
},
"CommitmentPlanListResult": {
"type": "object",
"description": "A page of commitment plan resources.",
"properties": {
"nextLink": {
"type": "string",
"description": "A URI to retrieve the next page of results."
},
"value": {
"type": "array",
"description": "The set of results for this page.",
"items": {
"$ref": "#/definitions/CommitmentPlan"
}
}
}
},
"PlanUsageHistoryListResult": {
"type": "object",
"description": "A page of usage history.",
"properties": {
"nextLink": {
"type": "string",
"description": "A URI to retrieve the next page of results."
},
"value": {
"type": "array",
"description": "The set of results for this page.",
"items": {
"$ref": "#/definitions/PlanUsageHistory"
},
"x-ms-identifiers": []
}
}
},
"PlanUsageHistory": {
"type": "object",
"description": "Represents historical information about usage of the Azure resources associated with a commitment plan.",
"properties": {
"planDeletionOverage": {
"type": "object",
"description": "Overage incurred as a result of deleting a commitment plan.",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"planMigrationOverage": {
"type": "object",
"description": "Overage incurred as a result of migrating a commitment plan from one SKU to another.",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"planQuantitiesAfterUsage": {
"type": "object",
"description": "Included quantities remaining after usage against the commitment plan's associated resources was calculated.",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"planQuantitiesBeforeUsage": {
"type": "object",
"description": "Included quantities remaining before usage against the commitment plan's associated resources was calculated.",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"planUsageOverage": {
"type": "object",
"description": "Usage against the commitment plan's associated resources which was not covered by included quantities and is therefore overage.",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"usage": {
"type": "object",
"description": "Usage against the commitment plan's associated resources.",
"additionalProperties": {
"format": "double",
"type": "number"
}
},
"usageDate": {
"format": "date-time",
"type": "string",
"description": "The date of usage, in ISO 8601 format."
}
}
},
"OperationEntityListResult": {
"description": "The list of REST API operations.",
"type": "object",
"properties": {
"value": {
"description": "The list of operations.",
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/OperationEntity"
},
"x-ms-identifiers": [
"name"
]
}
}