-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
managedcluster.json
1232 lines (1232 loc) · 48.5 KB
/
managedcluster.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": "ServiceFabricManagementClient",
"description": "Azure Service Fabric Resource Provider API Client",
"version": "2020-01-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"paths": {
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters": {
"get": {
"operationId": "ManagedClusters_ListByResourceGroup",
"summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.",
"description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"tags": [
"ManagedCluster"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List cluster by resource group": {
"$ref": "./examples/ManagedClusterListByResourceGroupOperation_example.json"
}
},
"responses": {
"200": {
"description": "The operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedClusterListResult"
}
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters": {
"get": {
"operationId": "ManagedClusters_ListBySubscription",
"summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.",
"description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.",
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"tags": [
"ManagedCluster"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List managed clusters": {
"$ref": "./examples/ManagedClusterListBySubscriptionOperation_example.json"
}
},
"responses": {
"200": {
"description": "The operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedClusterListResult"
}
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}": {
"get": {
"tags": [
"ManagedCluster"
],
"operationId": "ManagedClusters_Get",
"summary": "Gets a Service Fabric managed cluster resource.",
"description": "Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/clusterNameParameter"
},
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"x-ms-examples": {
"Get a cluster": {
"$ref": "./examples/ManagedClusterGetOperation_example.json"
}
},
"responses": {
"200": {
"description": "The operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedCluster"
}
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
},
"put": {
"tags": [
"ManagedCluster"
],
"operationId": "ManagedClusters_CreateOrUpdate",
"summary": "Creates or updates a Service Fabric managed cluster resource.",
"description": "Create or update a Service Fabric managed cluster resource with the specified name.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/clusterNameParameter"
},
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
},
{
"name": "parameters",
"in": "body",
"description": "The cluster resource.",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedCluster"
},
"x-ms-parameter-location": "method"
}
],
"x-ms-examples": {
"Put a cluster with minimum parameters": {
"$ref": "./examples/ManagedClusterPutOperation_example_min.json"
},
"Put a cluster with maximum parameters": {
"$ref": "./examples/ManagedClusterPutOperation_example_max.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"responses": {
"201": {
"description": "The request was accepted and the operation will complete asynchronously.",
"schema": {
"$ref": "#/definitions/ManagedCluster"
}
},
"200": {
"description": "The operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedCluster"
}
},
"202": {
"description": "The request was accepted and the operation will complete asynchronously.",
"schema": {
"$ref": "#/definitions/ManagedCluster"
}
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
},
"patch": {
"tags": [
"ManagedCluster"
],
"operationId": "ManagedClusters_Update",
"summary": "Updates the configuration of a Service Fabric managed cluster resource.",
"description": "Update the configuration of a Service Fabric managed cluster resource with the specified name.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/clusterNameParameter"
},
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
},
{
"name": "parameters",
"in": "body",
"description": "The parameters to update the managed cluster configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedClusterUpdateParameters"
},
"x-ms-parameter-location": "method"
}
],
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"Patch a managed cluster": {
"$ref": "./examples/ManagedClusterPatchOperation_example.json"
}
},
"responses": {
"200": {
"description": "The operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedCluster"
}
},
"202": {
"description": "The request was accepted and the operation will complete asynchronously.",
"schema": {
"$ref": "#/definitions/ManagedCluster"
}
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
},
"delete": {
"tags": [
"ManagedCluster"
],
"operationId": "ManagedClusters_Delete",
"summary": "Deletes a Service Fabric managed cluster resource.",
"description": "Delete a Service Fabric managed cluster resource with the specified name.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/clusterNameParameter"
},
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"x-ms-examples": {
"Delete a cluster": {
"$ref": "./examples/ManagedClusterDeleteOperation_example.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"responses": {
"202": {
"description": "The request was accepted and the operation will complete asynchronously."
},
"204": {
"description": "The resource was not found."
},
"200": {
"description": "The operation completed successfully."
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
}
},
"/providers/Microsoft.ServiceFabric/operations": {
"get": {
"tags": [
"Operations"
],
"summary": "Lists all of the available Service Fabric resource provider API operations.",
"description": "Get the list of available Service Fabric resource provider API operations.",
"operationId": "Operations_List",
"parameters": [
{
"name": "api-version",
"in": "query",
"description": "The version of the Service Fabric resource provider API",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedclusters/locations/{location}/osType/{osType}/clusterVersions": {
"get": {
"operationId": "ClusterVersions_ListByOS",
"summary": "Gets the list of Service Fabric cluster code versions available for the specified OS type.",
"description": "Gets all available code versions for Service Fabric cluster resources by OS type.",
"parameters": [
{
"$ref": "#/parameters/locationForClusterCodeVersions"
},
{
"$ref": "#/parameters/osType"
},
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"x-ms-examples": {
"List cluster versions by OS": {
"$ref": "./examples/ClusterVersionsListByOS_example.json"
}
},
"tags": [
"ClusterVersion"
],
"responses": {
"200": {
"description": "The operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ManagedClusterVersionDetails"
},
"description": "The list of available Service Fabric runtime versions."
}
},
"default": {
"description": "The detailed error response.",
"schema": {
"$ref": "#/definitions/ErrorModel"
}
}
}
}
}
},
"definitions": {
"AzureActiveDirectory": {
"properties": {
"tenantId": {
"type": "string",
"description": "Azure active directory tenant id."
},
"clusterApplication": {
"type": "string",
"description": "Azure active directory cluster application id."
},
"clientApplication": {
"type": "string",
"description": "Azure active directory client application id."
}
},
"description": "The settings to enable AAD authentication on the cluster."
},
"ClientCertificate": {
"required": [
"isAdmin"
],
"properties": {
"isAdmin": {
"type": "boolean",
"description": "Whether the certificate is admin or not."
},
"thumbprint": {
"type": "string",
"description": "Certificate Thumbprint."
},
"commonName": {
"type": "string",
"description": "Certificate Common name."
},
"issuerThumbprint": {
"type": "string",
"description": "Issuer thumbprint for the certificate. Its only use ehn CommonName is used."
}
},
"description": "Client Certificate definition."
},
"ClusterOsType": {
"type": "string",
"description": "Cluster operating system type.",
"enum": [
"Windows",
"Ubuntu",
"RedHat",
"Ubuntu18_04"
]
},
"ClusterState": {
"type": "string",
"description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n",
"enum": [
"WaitingForNodes",
"Deploying",
"BaselineUpgrade",
"UpdatingUserConfiguration",
"UpdatingUserCertificate",
"UpdatingInfrastructure",
"EnforcingClusterVersion",
"UpgradeServiceUnreachable",
"AutoScale",
"Ready"
]
},
"ManagedClusterVersionDetails": {
"properties": {
"msiVersion": {
"type": "string",
"description": "The Service Fabric runtime version of the cluster."
},
"supportExpiryUtc": {
"type": "string",
"description": "The date of expiry of support of the version."
},
"osType": {
"$ref": "#/definitions/ClusterOsType",
"description": "Indicates the operating system of the cluster."
}
},
"description": "The detail of the Service Fabric runtime version."
},
"LoadBalancingRule": {
"required": [
"frontendPort",
"backendPort",
"protocol",
"probeProtocol"
],
"properties": {
"frontendPort": {
"type": "integer",
"format": "int32",
"description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.",
"minimum": 1,
"maximum": 65534
},
"backendPort": {
"type": "integer",
"format": "int32",
"description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.",
"minimum": 1,
"maximum": 65534
},
"protocol": {
"type": "string",
"description": "The reference to the transport protocol used by the load balancing rule.",
"enum": [
"tcp",
"udp"
],
"x-ms-enum": {
"name": "protocol",
"modelAsString": true
}
},
"probeProtocol": {
"type": "string",
"description": "the reference to the load balancer probe used by the load balancing rule.",
"enum": [
"tcp",
"http",
"https"
],
"x-ms-enum": {
"name": "probeProtocol",
"modelAsString": true
}
},
"probeRequestPath": {
"type": "string",
"description": "The probe request path. Only supported for HTTP/HTTPS probes."
}
},
"description": "Describes a load balancing rule."
},
"ManagedCluster": {
"type": "object",
"description": "The manged cluster resource\n",
"allOf": [
{
"description": "The managed cluster resource properties"
},
{
"$ref": "#/definitions/Resource"
},
{
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ManagedClusterProperties",
"description": "The managed cluster resource properties"
},
"sku": {
"$ref": "#/definitions/Sku",
"description": "The sku of the managed cluster"
}
}
}
]
},
"ManagedClusterListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ManagedCluster"
}
},
"nextLink": {
"type": "string",
"description": "The URL to use for getting the next set of results."
}
},
"description": "Managed Cluster list results"
},
"ManagedClusterProperties": {
"required": [
"dnsName",
"adminUserName"
],
"properties": {
"dnsName": {
"type": "string",
"description": "The cluster dns name."
},
"fqdn": {
"type": "string",
"description": "the cluster Fully qualified domain name.",
"readOnly": true
},
"clusterId": {
"type": "string",
"description": "A service generated unique identifier for the cluster resource.",
"readOnly": true
},
"clusterState": {
"readOnly": true,
"$ref": "#/definitions/ClusterState",
"description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n"
},
"clusterCertificateThumbprint": {
"type": "string",
"description": "The cluster certificate thumbprint used node to node communication.",
"readOnly": true
},
"clientConnectionPort": {
"type": "integer",
"format": "int32",
"description": "The port used for client connections to the cluster.",
"default": 19000
},
"httpGatewayConnectionPort": {
"type": "integer",
"format": "int32",
"description": "The port used for http connections to the cluster.",
"default": 19080
},
"adminUserName": {
"type": "string",
"description": "vm admin user name."
},
"adminPassword": {
"x-ms-secret": true,
"type": "string",
"format": "password",
"description": "vm admin user password."
},
"loadBalancingRules": {
"type": "array",
"items": {
"$ref": "#/definitions/LoadBalancingRule"
},
"description": "Describes load balancing rules."
},
"clients": {
"type": "array",
"items": {
"$ref": "#/definitions/ClientCertificate"
},
"description": "client certificates for the cluster."
},
"azureActiveDirectory": {
"$ref": "#/definitions/AzureActiveDirectory",
"description": "Azure active directory."
},
"fabricSettings": {
"type": "array",
"$ref": "#/definitions/SettingsSectionDescription",
"description": "The list of custom fabric settings to configure the cluster."
},
"provisioningState": {
"type": "string",
"description": "The provisioning state of the managed cluster resource.",
"readOnly": true,
"enum": [
"Updating",
"Succeeded",
"Failed",
"Canceled"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": true
}
},
"clusterCodeVersion": {
"type": "string",
"description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**."
},
"clusterUpgradeMode": {
"$ref": "#/definitions/UpgradeMode",
"description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n"
},
"clusterUpgradeDescription": {
"$ref": "#/definitions/ClusterUpgradePolicy",
"description": "Describes the policy used when upgrading the cluster."
},
"reverseProxyEndpointPort": {
"type": "integer",
"format": "int32",
"description": "The endpoint used by reverse proxy."
}
},
"description": "Describes the managed cluster resource properties."
},
"ManagedClusterPropertiesUpdateParameters": {
"properties": {
"clientConnectionPort": {
"type": "integer",
"format": "int32",
"description": "The port used for client connections to the cluster."
},
"httpGatewayConnectionPort": {
"type": "integer",
"format": "int32",
"description": "The port used for http connections to the cluster."
},
"loadBalancingRules": {
"type": "array",
"$ref": "#/definitions/LoadBalancingRule",
"description": "Describes a load balancing rule."
},
"clients": {
"type": "array",
"$ref": "#/definitions/ClientCertificate",
"description": "client certificates for the cluster."
},
"azureActiveDirectory": {
"type": "array",
"$ref": "#/definitions/AzureActiveDirectory",
"description": "Azure active directory."
},
"fabricSettings": {
"type": "array",
"$ref": "#/definitions/SettingsSectionDescription",
"description": "The list of custom fabric settings to configure the cluster."
},
"clusterCodeVersion": {
"type": "string",
"description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**."
},
"clusterUpgradeMode": {
"$ref": "#/definitions/UpgradeMode",
"description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n"
},
"clusterUpgradeDescription": {
"$ref": "#/definitions/ClusterUpgradePolicy",
"description": "Describes the policy used when upgrading the cluster."
},
"reverseProxyEndpointPort": {
"type": "integer",
"format": "int32",
"description": "The endpoint used by reverse proxy."
}
},
"description": "Describes the managed cluster resource properties."
},
"ManagedClusterUpdateParameters": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ManagedClusterPropertiesUpdateParameters",
"description": "Describes the managed cluster resource properties."
},
"tags": {
"type": "object",
"description": "Managed cluster update parameters",
"additionalProperties": {
"type": "string"
}
}
},
"description": "Managed cluster update request"
},
"Sku": {
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/definitions/SkuName",
"description": "Sku Name. Basic will hav a minimum of 3 seed nodes and Standard a minimum of 5. Basic only allows 1 node type."
}
},
"description": "Sku definition"
},
"SkuName": {
"type": "string",
"description": "Sku Name. Basic will hav a minimum of 3 seed nodes and Standard a minimum of 5. Basic only allows 1 node type.",
"enum": [
"Basic",
"Standard"
]
},
"AvailableOperationDisplay": {
"properties": {
"provider": {
"type": "string",
"description": "The name of the provider."
},
"resource": {
"type": "string",
"description": "The resource on which the operation is performed"
},
"operation": {
"type": "string",
"description": "The operation that can be performed."
},
"description": {
"type": "string",
"description": "Operation description"
}
},
"description": "Operation supported by the Service Fabric resource provider"
},
"ApplicationDeltaHealthPolicy": {
"type": "object",
"description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n",
"properties": {
"defaultServiceTypeDeltaHealthPolicy": {
"$ref": "#/definitions/ServiceTypeDeltaHealthPolicy",
"description": "The delta health policy used by default to evaluate the health of a service type when upgrading the cluster."
},
"serviceTypeDeltaHealthPolicies": {
"$ref": "#/definitions/ServiceTypeDeltaHealthPolicyMap",
"description": "The map with service type delta health policy per service type name. The map is empty by default."
}
}
},
"ApplicationDeltaHealthPolicyMap": {
"type": "object",
"description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n",
"additionalProperties": {
"$ref": "#/definitions/ApplicationDeltaHealthPolicy"
}
},
"ApplicationHealthPolicy": {
"type": "object",
"description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n",
"properties": {
"defaultServiceTypeHealthPolicy": {
"$ref": "#/definitions/ServiceTypeHealthPolicy",
"description": "The health policy used by default to evaluate the health of a service type."
},
"serviceTypeHealthPolicies": {
"$ref": "#/definitions/ServiceTypeHealthPolicyMap",
"description": "The map with service type health policy per service type name. The map is empty by default."
}
}
},
"ApplicationHealthPolicyMap": {
"type": "object",
"description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n",
"additionalProperties": {
"$ref": "#/definitions/ApplicationHealthPolicy"
}
},
"ClusterHealthPolicy": {
"type": "object",
"description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n",
"properties": {
"maxPercentUnhealthyNodes": {
"type": "integer",
"description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n",
"default": 0,
"minimum": 0,
"maximum": 100
},
"maxPercentUnhealthyApplications": {
"type": "integer",
"description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n",
"default": 0,
"minimum": 0,
"maximum": 100
},
"applicationHealthPolicies": {
"$ref": "#/definitions/ApplicationHealthPolicyMap",
"description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities."
}
}
},
"ClusterUpgradeDeltaHealthPolicy": {
"description": "Describes the delta health policies for the cluster upgrade.",
"required": [
"maxPercentDeltaUnhealthyApplications",
"maxPercentDeltaUnhealthyNodes",
"maxPercentUpgradeDomainDeltaUnhealthyNodes"
],
"properties": {
"maxPercentDeltaUnhealthyNodes": {
"type": "integer",
"description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n",
"minimum": 0,
"maximum": 100
},
"maxPercentUpgradeDomainDeltaUnhealthyNodes": {
"type": "integer",
"description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.\n",
"minimum": 0,
"maximum": 100
},
"maxPercentDeltaUnhealthyApplications": {
"type": "integer",
"description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.\n",
"minimum": 0,
"maximum": 100
},
"applicationDeltaHealthPolicies": {
"$ref": "#/definitions/ApplicationDeltaHealthPolicyMap",
"description": "Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster."
}
}
},
"ClusterUpgradePolicy": {
"required": [
"healthCheckRetryTimeout",
"healthCheckStableDuration",
"healthCheckWaitDuration",
"healthPolicy",
"upgradeDomainTimeout",
"upgradeReplicaSetCheckTimeout",
"upgradeTimeout"
],
"properties": {
"forceRestart": {
"type": "boolean",
"description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)."
},
"upgradeReplicaSetCheckTimeout": {
"type": "string",
"description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format."
},
"healthCheckWaitDuration": {
"type": "string",
"description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format."
},
"healthCheckStableDuration": {
"type": "string",
"description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format."
},
"healthCheckRetryTimeout": {
"type": "string",
"description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format."
},
"upgradeTimeout": {
"type": "string",
"description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format."
},
"upgradeDomainTimeout": {
"type": "string",
"description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format."
},
"healthPolicy": {
"$ref": "#/definitions/ClusterHealthPolicy",
"description": "The cluster health policy used when upgrading the cluster."
},
"deltaHealthPolicy": {
"$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy",
"description": "The cluster delta health policy used when upgrading the cluster."
}
},
"description": "Describes the policy used when upgrading the cluster."
},
"ErrorModel": {
"properties": {
"error": {
"$ref": "#/definitions/ErrorModelError",
"description": "The error details."
}
},
"description": "The structure of the error."
},
"ErrorModelError": {
"properties": {
"code": {
"type": "string",
"description": "The error code."
},
"message": {
"type": "string",
"description": "The error message."
}
},
"description": "The error details."
},
"OperationListResult": {
"properties": {
"value": {
"type": "array",
"description": "List of operations supported by the Service Fabric resource provider.",