-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
autoscale_API.json
1083 lines (1083 loc) · 40.7 KB
/
autoscale_API.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": "MonitorManagementClient",
"version": "2021-05-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": {
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings": {
"get": {
"description": "Lists the autoscale settings for a resource group",
"tags": [
"AutoscaleSettings"
],
"operationId": "AutoscaleSettings_ListByResourceGroup",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "Successful request for a list of autoscale settings",
"schema": {
"$ref": "#/definitions/AutoscaleSettingResourceCollection"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List autoscale settings": {
"$ref": "./examples/listAutoscaleSetting.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}": {
"put": {
"description": "Creates or updates an autoscale setting.",
"tags": [
"AutoscaleSettings"
],
"operationId": "AutoscaleSettings_CreateOrUpdate",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AutoscaleSettingNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AutoscaleSettingResource"
},
"description": "Parameters supplied to the operation."
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "Successful request to create or update an autoscale setting",
"schema": {
"$ref": "#/definitions/AutoscaleSettingResource"
}
},
"201": {
"description": "Created autoscale setting",
"schema": {
"$ref": "#/definitions/AutoscaleSettingResource"
}
}
},
"x-ms-examples": {
"Create or update an autoscale setting": {
"$ref": "./examples/createOrUpdateAutoscaleSetting.json"
}
}
},
"delete": {
"description": "Deletes and autoscale setting",
"tags": [
"AutoscaleSettings"
],
"operationId": "AutoscaleSettings_Delete",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AutoscaleSettingNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "Successful request to delete an autoscale setting"
},
"204": {
"description": "No content: Successful request to delete an autoscale setting, but the response is intentionally empty"
}
},
"x-ms-examples": {
"Delete an autoscale setting": {
"$ref": "./examples/deleteAutoscaleSetting.json"
}
}
},
"get": {
"description": "Gets an autoscale setting",
"tags": [
"AutoscaleSettings"
],
"operationId": "AutoscaleSettings_Get",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AutoscaleSettingNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "Successful request to get one autoscale setting",
"schema": {
"$ref": "#/definitions/AutoscaleSettingResource"
}
}
},
"x-ms-examples": {
"Get an autoscale setting": {
"$ref": "./examples/getAutoscaleSetting.json"
}
}
},
"patch": {
"description": "Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.",
"operationId": "AutoscaleSettings_Update",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AutoscaleSettingNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"name": "autoscaleSettingResource",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AutoscaleSettingResourcePatch"
},
"description": "Parameters supplied to the operation."
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "An existing autoscale setting resource was successfully updated.",
"schema": {
"$ref": "#/definitions/AutoscaleSettingResource"
}
}
},
"x-ms-examples": {
"Patch an autoscale setting": {
"$ref": "./examples/patchAutoscaleSetting.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}/predictiveMetrics": {
"get": {
"tags": [
"Metrics"
],
"operationId": "PredictiveMetric_Get",
"description": "get predictive autoscale metric future data",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AutoscaleSettingNameParameter"
},
{
"$ref": "#/parameters/TimespanParameter"
},
{
"$ref": "#/parameters/IntervalParameter"
},
{
"$ref": "#/parameters/MetricNamespaceParameter"
},
{
"$ref": "#/parameters/MetricNamesParameter"
},
{
"$ref": "#/parameters/AggregationParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "Successful request to get the list of metric values.",
"schema": {
"$ref": "#/definitions/PredictiveResponse"
}
}
},
"x-ms-examples": {
"Get Metric for data": {
"$ref": "./examples/GetPredictiveMetric.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings": {
"get": {
"description": "Lists the autoscale settings for a subscription",
"tags": [
"AutoscaleSettings"
],
"operationId": "AutoscaleSettings_ListBySubscription",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AutoscaleErrorResponse"
}
},
"200": {
"description": "Successful request for a list of autoscale settings",
"schema": {
"$ref": "#/definitions/AutoscaleSettingResourceCollection"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List autoscale settings by subs": {
"$ref": "./examples/listAutoscaleSettingBySubscription.json"
}
}
}
}
},
"definitions": {
"ScaleCapacity": {
"type": "object",
"required": [
"minimum",
"maximum",
"default"
],
"properties": {
"minimum": {
"type": "string",
"description": "the minimum number of instances for the resource."
},
"maximum": {
"type": "string",
"description": "the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription."
},
"default": {
"type": "string",
"description": "the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default."
}
},
"description": "The number of instances that can be used during this profile."
},
"MetricTrigger": {
"type": "object",
"required": [
"metricName",
"metricResourceUri",
"timeGrain",
"statistic",
"timeWindow",
"timeAggregation",
"operator",
"threshold"
],
"properties": {
"metricName": {
"type": "string",
"description": "the name of the metric that defines what the rule monitors."
},
"metricNamespace": {
"type": "string",
"description": "the namespace of the metric that defines what the rule monitors."
},
"metricResourceUri": {
"type": "string",
"description": "the resource identifier of the resource the rule monitors."
},
"metricResourceLocation": {
"type": "string",
"description": "the location of the resource the rule monitors."
},
"timeGrain": {
"type": "string",
"format": "duration",
"description": "the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute."
},
"statistic": {
"type": "string",
"description": "the metric statistic type. How the metrics from multiple instances are combined.",
"enum": [
"Average",
"Min",
"Max",
"Sum",
"Count"
],
"x-ms-enum": {
"name": "MetricStatisticType",
"modelAsString": false
}
},
"timeWindow": {
"type": "string",
"format": "duration",
"description": "the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes."
},
"timeAggregation": {
"type": "string",
"description": "time aggregation type. How the data that is collected should be combined over time. The default value is Average.",
"enum": [
"Average",
"Minimum",
"Maximum",
"Total",
"Count",
"Last"
],
"x-ms-enum": {
"name": "TimeAggregationType",
"modelAsString": false
}
},
"operator": {
"type": "string",
"description": "the operator that is used to compare the metric data and the threshold.",
"enum": [
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanOrEqual",
"LessThan",
"LessThanOrEqual"
],
"x-ms-enum": {
"name": "ComparisonOperationType",
"modelAsString": false
}
},
"threshold": {
"type": "number",
"format": "double",
"description": "the threshold of the metric that triggers the scale action."
},
"dimensions": {
"type": "array",
"items": {
"$ref": "#/definitions/ScaleRuleMetricDimension"
},
"description": "List of dimension conditions. For example: [{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":[\"App1\"]},{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":[\"default\"]}]."
},
"dividePerInstance": {
"type": "boolean",
"description": "a value indicating whether metric should divide per instance."
}
},
"description": "The trigger that results in a scaling action."
},
"ScaleAction": {
"type": "object",
"required": [
"direction",
"type",
"cooldown"
],
"properties": {
"direction": {
"type": "string",
"description": "the scale direction. Whether the scaling action increases or decreases the number of instances.",
"enum": [
"None",
"Increase",
"Decrease"
],
"x-ms-enum": {
"name": "ScaleDirection",
"modelAsString": false
}
},
"type": {
"type": "string",
"description": "the type of action that should occur when the scale rule fires.",
"enum": [
"ChangeCount",
"PercentChangeCount",
"ExactCount",
"ServiceAllowedNextValue"
],
"x-ms-enum": {
"name": "ScaleType",
"modelAsString": false
}
},
"value": {
"type": "string",
"description": "the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.",
"default": "1"
},
"cooldown": {
"type": "string",
"format": "duration",
"description": "the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format."
}
},
"description": "The parameters for the scaling action."
},
"ScaleRule": {
"type": "object",
"required": [
"scaleAction",
"metricTrigger"
],
"properties": {
"metricTrigger": {
"$ref": "#/definitions/MetricTrigger",
"description": "the trigger that results in a scaling action."
},
"scaleAction": {
"$ref": "#/definitions/ScaleAction",
"description": "the parameters for the scaling action."
}
},
"description": "A rule that provide the triggers and parameters for the scaling action."
},
"TimeWindow": {
"type": "object",
"properties": {
"timeZone": {
"type": "string",
"description": "the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time"
},
"start": {
"type": "string",
"format": "date-time",
"description": "the start time for the profile in ISO 8601 format."
},
"end": {
"type": "string",
"format": "date-time",
"description": "the end time for the profile in ISO 8601 format."
}
},
"required": [
"start",
"end"
],
"description": "A specific date-time for the profile."
},
"RecurrentSchedule": {
"type": "object",
"required": [
"timeZone",
"days",
"hours",
"minutes"
],
"properties": {
"timeZone": {
"type": "string",
"description": "the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time"
},
"days": {
"type": "array",
"items": {
"type": "string"
},
"description": "the collection of days that the profile takes effect on. Possible values are Sunday through Saturday."
},
"hours": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported)."
},
"minutes": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "A collection of minutes at which the profile takes effect at."
}
},
"description": "The scheduling constraints for when the profile begins."
},
"Recurrence": {
"type": "object",
"required": [
"frequency",
"schedule"
],
"properties": {
"frequency": {
"type": "string",
"description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.",
"enum": [
"None",
"Second",
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Year"
],
"x-ms-enum": {
"name": "RecurrenceFrequency",
"modelAsString": false
}
},
"schedule": {
"$ref": "#/definitions/RecurrentSchedule",
"description": "the scheduling constraints for when the profile begins."
}
},
"description": "The repeating times at which this profile begins. This element is not used if the FixedDate element is used."
},
"AutoscaleProfile": {
"type": "object",
"required": [
"rules",
"name",
"capacity"
],
"properties": {
"name": {
"type": "string",
"description": "the name of the profile."
},
"capacity": {
"$ref": "#/definitions/ScaleCapacity",
"description": "the number of instances that can be used during this profile."
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/ScaleRule"
},
"description": "the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified."
},
"fixedDate": {
"$ref": "#/definitions/TimeWindow",
"description": "the specific date-time for the profile. This element is not used if the Recurrence element is used."
},
"recurrence": {
"$ref": "#/definitions/Recurrence",
"description": "the repeating times at which this profile begins. This element is not used if the FixedDate element is used."
}
},
"description": "Autoscale profile."
},
"PredictiveAutoscalePolicy": {
"type": "object",
"required": [
"scaleMode"
],
"properties": {
"scaleMode": {
"type": "string",
"description": "the predictive autoscale mode",
"enum": [
"Disabled",
"ForecastOnly",
"Enabled"
],
"x-ms-enum": {
"name": "PredictiveAutoscalePolicyScaleMode",
"modelAsString": false
}
},
"scaleLookAheadTime": {
"type": "string",
"format": "duration",
"description": "the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format."
}
},
"description": "The parameters for enabling predictive autoscale."
},
"EmailNotification": {
"type": "object",
"properties": {
"sendToSubscriptionAdministrator": {
"type": "boolean",
"description": "a value indicating whether to send email to subscription administrator.",
"default": false
},
"sendToSubscriptionCoAdministrators": {
"type": "boolean",
"description": "a value indicating whether to send email to subscription co-administrators.",
"default": false
},
"customEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored."
}
},
"description": "Email notification of an autoscale event."
},
"WebhookNotification": {
"type": "object",
"properties": {
"serviceUri": {
"type": "string",
"description": "the service address to receive the notification."
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "a property bag of settings. This value can be empty."
}
},
"description": "Webhook notification of an autoscale event."
},
"AutoscaleNotification": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"type": "string",
"description": "the operation associated with the notification and its value must be \"scale\"",
"enum": [
"Scale"
],
"x-ms-enum": {
"name": "OperationType",
"modelAsString": false
}
},
"email": {
"$ref": "#/definitions/EmailNotification",
"description": "the email notification."
},
"webhooks": {
"type": "array",
"items": {
"$ref": "#/definitions/WebhookNotification"
},
"description": "the collection of webhook notifications."
}
},
"description": "Autoscale notification."
},
"AutoscaleSetting": {
"type": "object",
"required": [
"profiles"
],
"properties": {
"profiles": {
"type": "array",
"maxItems": 20,
"items": {
"$ref": "#/definitions/AutoscaleProfile"
},
"description": "the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified."
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/definitions/AutoscaleNotification"
},
"description": "the collection of notifications."
},
"enabled": {
"type": "boolean",
"description": "the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'.",
"default": false
},
"predictiveAutoscalePolicy": {
"$ref": "#/definitions/PredictiveAutoscalePolicy",
"description": "the predictive autoscale policy mode."
},
"name": {
"type": "string",
"description": "the name of the autoscale setting."
},
"targetResourceUri": {
"type": "string",
"description": "the resource identifier of the resource that the autoscale setting should be added to."
},
"targetResourceLocation": {
"type": "string",
"description": "the location of the resource that the autoscale setting should be added to."
}
},
"description": "A setting that contains all of the configuration for the automatic scaling of a resource."
},
"AutoscaleSettingResource": {
"type": "object",
"required": [
"location",
"properties"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Azure resource Id"
},
"name": {
"type": "string",
"readOnly": true,
"description": "Azure resource name"
},
"type": {
"type": "string",
"readOnly": true,
"description": "Azure resource type"
},
"location": {
"type": "string",
"description": "Resource location",
"x-ms-mutability": [
"create",
"read"
]
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters."
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/AutoscaleSetting",
"description": "The autoscale setting of the resource."
},
"systemData": {
"readOnly": true,
"description": "The system metadata related to the response.",
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
},
"x-ms-azure-resource": true,
"description": "The autoscale setting resource."
},
"AutoscaleSettingResourcePatch": {
"type": "object",
"description": "The autoscale setting object for patch operations.",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Resource tags"
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/AutoscaleSetting",
"description": "The autoscale setting properties of the update operation."
}
}
},
"AutoscaleSettingResourceCollection": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/AutoscaleSettingResource"
},
"description": "the values for the autoscale setting resources."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of results."
}
},
"required": [
"value"
],
"description": "Represents a collection of autoscale setting resources."
},
"AutoscaleErrorResponse": {
"description": "Describes the format of Error response.",
"type": "object",
"properties": {
"error": {
"type": "object",
"description": "The error object.",
"properties": {
"code": {
"description": "One of a server-defined set of error codes.",
"type": "string"
},
"message": {
"description": "A human-readable representation of the error.",
"type": "string"
},
"target": {
"description": "The target of the particular error.",
"type": "string"
},
"details": {
"description": "A human-readable representation of the error's details.",
"type": "string"
}
}
},
"systemData": {
"readOnly": true,
"description": "The system metadata related to the response.",
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
}
},
"ScaleRuleMetricDimension": {
"type": "object",
"required": [
"DimensionName",
"Operator",
"Values"
],
"properties": {
"DimensionName": {
"type": "string",
"description": "Name of the dimension."
},
"Operator": {
"type": "string",
"description": "the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values",
"enum": [
"Equals",
"NotEquals"
],
"x-ms-enum": {
"name": "ScaleRuleMetricDimensionOperationType",
"modelAsString": true
}
},
"Values": {
"type": "array",
"items": {
"type": "string"
},
"description": "list of dimension values. For example: [\"App1\",\"App2\"]."
}
},
"description": "Specifies an auto scale rule metric dimension."
},
"PredictiveResponse": {
"type": "object",
"properties": {
"timespan": {
"type": "string",
"description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested."
},
"interval": {
"type": "string",
"format": "duration",
"description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made."
},
"metricName": {
"type": "string",
"description": "The metrics being queried"
},
"targetResourceId": {
"type": "string",
"description": "resource of the predictive metric."
},