-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
extensions.json
736 lines (736 loc) · 23.7 KB
/
extensions.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
{
"swagger": "2.0",
"info": {
"version": "2020-07-01-preview",
"title": "ExtensionsClient",
"description": "Use these APIs to create extension resources through ARM, for Kubernetes Clusters."
},
"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/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionInstanceName}": {
"put": {
"tags": [
"Extensions",
"ClusterExtensions"
],
"description": "Create a new Kubernetes Cluster Extension Instance.",
"operationId": "Extensions_Create",
"x-ms-examples": {
"Create Extension": {
"$ref": "./examples/CreateExtension.json"
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterRpParameter"
},
{
"$ref": "#/parameters/ClusterResourceNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ExtensionInstanceNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "extensionInstance",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ExtensionInstance"
},
"description": "Properties necessary to Create an Extension Instance."
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ExtensionInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"Extensions",
"ClusterExtensions"
],
"description": "Gets details of the Kubernetes Cluster Extension Instance.",
"operationId": "Extensions_Get",
"x-ms-examples": {
"Get Extension": {
"$ref": "./examples/GetExtension.json"
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterRpParameter"
},
{
"$ref": "#/parameters/ClusterResourceNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ExtensionInstanceNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ExtensionInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"tags": [
"Extensions",
"ClusterExtensions"
],
"description": "Update an existing Kubernetes Cluster Extension Instance.",
"operationId": "Extensions_Update",
"x-ms-examples": {
"Create Extension": {
"$ref": "./examples/UpdateExtension.json"
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterRpParameter"
},
{
"$ref": "#/parameters/ClusterResourceNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ExtensionInstanceNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "extensionInstance",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ExtensionInstanceUpdate"
},
"description": "Properties to Update in the Extension Instance."
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ExtensionInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"Extensions",
"ClusterExtensions"
],
"description": "Delete a Kubernetes Cluster Extension Instance. This will cause the Agent to Uninstall the extension instance from the cluster.",
"operationId": "Extensions_Delete",
"x-ms-examples": {
"Get Extension": {
"$ref": "./examples/DeleteExtension.json"
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterRpParameter"
},
{
"$ref": "#/parameters/ClusterResourceNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ExtensionInstanceNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has been completed successfully."
},
"204": {
"description": "No Content. The request has been accepted but the extension instance was not found."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions": {
"get": {
"tags": [
"Extensions",
"ClusterExtensions"
],
"description": "List all Source Control Configurations.",
"operationId": "Extensions_List",
"x-ms-examples": {
"List Source Control Configuration": {
"$ref": "./examples/ListExtensions.json"
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterRpParameter"
},
{
"$ref": "#/parameters/ClusterResourceNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ExtensionInstancesList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"SystemData": {
"description": "Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources",
"type": "object",
"properties": {
"createdBy": {
"description": "A string identifier for the identity that created the resource",
"type": "string",
"readOnly": true
},
"createdByType": {
"description": "The type of identity that created the resource: user, application, managedIdentity, key",
"type": "string",
"readOnly": true
},
"createdAt": {
"format": "date-time",
"description": "The timestamp of resource creation (UTC)",
"type": "string",
"readOnly": true
},
"lastModifiedBy": {
"description": "A string identifier for the identity that last modified the resource",
"type": "string",
"readOnly": true
},
"lastModifiedByType": {
"description": "The type of identity that last modified the resource: user, application, managedIdentity, key",
"type": "string",
"readOnly": true
},
"lastModifiedAt": {
"format": "date-time",
"description": "The timestamp of resource last modification (UTC)",
"type": "string",
"readOnly": true
}
}
},
"Resource": {
"description": "The Resource model definition.",
"type": "object",
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "Resource Id"
},
"name": {
"readOnly": true,
"type": "string",
"description": "Resource name"
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type"
},
"systemData": {
"description": "Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources",
"$ref": "#/definitions/SystemData"
}
},
"x-ms-azure-resource": true
},
"ProxyResource": {
"description": "ARM proxy resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {}
},
"ErrorResponse": {
"description": "Error response.",
"properties": {
"error": {
"description": "Error definition.",
"$ref": "#/definitions/ErrorDefinition"
}
}
},
"ErrorDefinition": {
"description": "Error definition.",
"readOnly": true,
"required": [
"message",
"code"
],
"properties": {
"code": {
"description": "Service specific error code which serves as the substatus for the HTTP error code.",
"type": "string",
"minimum": 100,
"maximum": 600
},
"message": {
"description": "Description of the error.",
"type": "string"
}
}
},
"ConfigurationSettings": {
"description": "Name-value pairs for configuring the extensionInstance",
"additionalProperties": {
"type": "string"
}
},
"ExtensionProtectedSettings": {
"description": "Configuration settings that are sensitive, as name-value pairs for configuring this instance of the extension.",
"additionalProperties": {
"type": "string"
}
},
"ReleaseTrain": {
"description": "ReleaseTrain this extension instance participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.",
"type": "string",
"default": "Stable"
},
"ScopeCluster": {
"description": "Specifies that the scope of the extensionInstance is Cluster",
"type": "object",
"properties": {
"releaseNamespace": {
"description": "Namespace where the extension Release must be placed, for a Cluster scoped extensionInstance. If this namespace does not exist, it will be created",
"type": "string"
}
}
},
"ScopeNamespace": {
"description": "Specifies that the scope of the extensionInstance is Namespace",
"type": "object",
"properties": {
"targetNamespace": {
"description": "Namespace where the extensionInstance will be created for an Namespace scoped extensionInstance. If this namespace does not exist, it will be created",
"type": "string"
}
}
},
"Scope": {
"description": "Scope of the extensionInstance. It can be either Cluster or Namespace; but not both.",
"type": "object",
"properties": {
"cluster": {
"type": "object",
"description": "Specifies that the scope of the extensionInstance is Cluster",
"$ref": "#/definitions/ScopeCluster"
},
"namespace": {
"type": "object",
"description": "Specifies that the scope of the extensionInstance is Namespace",
"$ref": "#/definitions/ScopeNamespace"
}
}
},
"InstallStateDefinition": {
"description": "Status of installation of this instance of the extension.",
"type": "string",
"readOnly": true,
"enum": [
"Pending",
"Installed",
"Failed"
],
"x-ms-enum": {
"name": "InstallStateType",
"modelAsString": true
}
},
"ExtensionStatus": {
"description": "Status from this instance of the extension.",
"type": "object",
"readOnly": true,
"properties": {
"code": {
"type": "string",
"description": "Status code provided by the Extension"
},
"displayStatus": {
"type": "string",
"description": "Short description of status of this instance of the extension."
},
"level": {
"type": "string",
"description": "Level of the status.",
"enum": [
"Error",
"Warning",
"Information"
],
"default": "Information",
"x-ms-enum": {
"name": "LevelType",
"modelAsString": true
}
},
"message": {
"type": "string",
"description": "Detailed message of the status from the Extension instance."
},
"time": {
"type": "string",
"description": "DateLiteral (per ISO8601) noting the time of installation status."
}
}
},
"ConfigurationIdentity": {
"properties": {
"principalId": {
"readOnly": true,
"type": "string",
"description": "The principal id of the system assigned identity which is used by the configuration."
},
"tenantId": {
"readOnly": true,
"type": "string",
"description": "The tenant id of the system assigned identity which is used by the configuration."
},
"type": {
"type": "string",
"description": "The type of identity used for the configuration. Type 'SystemAssigned' will use an implicitly created identity. Type 'None' will not use Managed Identity for the configuration.",
"enum": [
"SystemAssigned",
"None"
],
"x-ms-enum": {
"name": "ResourceIdentityType",
"modelAsString": false
}
}
},
"description": "Identity for the managed cluster."
},
"ExtensionInstance": {
"description": "The Extension Instance object.",
"properties": {
"properties": {
"type": "object",
"x-ms-client-flatten": true,
"description": "Properties of an Extension Instance resource",
"properties": {
"extensionType": {
"type": "string",
"description": "Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher."
},
"autoUpgradeMinorVersion": {
"description": "Flag to note if this instance participates in auto upgrade of minor version, or not.",
"type": "boolean"
},
"releaseTrain": {
"description": "ReleaseTrain this extension instance participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.",
"$ref": "#/definitions/ReleaseTrain"
},
"version": {
"description": "Version of the extension for this extension instance, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.",
"type": "string"
},
"scope": {
"description": "Scope at which the extension instance is installed.",
"$ref": "#/definitions/Scope"
},
"configurationSettings": {
"description": "Configuration settings, as name-value pairs for configuring this instance of the extension.",
"type": "object",
"$ref": "#/definitions/ConfigurationSettings"
},
"configurationProtectedSettings": {
"description": "Configuration settings that are sensitive, as name-value pairs for configuring this instance of the extension.",
"type": "object",
"$ref": "#/definitions/ExtensionProtectedSettings"
},
"installState": {
"type": "string",
"description": "Status of installation of this instance of the extension.",
"$ref": "#/definitions/InstallStateDefinition"
},
"statuses": {
"type": "array",
"description": "Status from this instance of the extension.",
"items": {
"$ref": "#/definitions/ExtensionStatus"
}
},
"creationTime": {
"type": "string",
"description": "DateLiteral (per ISO8601) noting the time the resource was created by the client (user).",
"readOnly": true
},
"lastModifiedTime": {
"type": "string",
"description": "DateLiteral (per ISO8601) noting the time the resource was modified by the client (user).",
"readOnly": true
},
"lastStatusTime": {
"type": "string",
"description": "DateLiteral (per ISO8601) noting the time of last status from the agent.",
"readOnly": true
},
"errorInfo": {
"type": "object",
"description": "Error information from the Agent - e.g. errors during installation.",
"readOnly": true,
"$ref": "#/definitions/ErrorDefinition"
},
"identity": {
"$ref": "#/definitions/ConfigurationIdentity",
"description": "The identity of the configuration."
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyResource"
}
]
},
"ExtensionInstancesList": {
"description": "Result of the request to list Extension Instances. It contains a list of ExtensionInstance objects and a URL link to get the next set of results.",
"properties": {
"value": {
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/ExtensionInstance"
},
"description": "List of Extension Instances within a Kubernetes cluster."
},
"nextLink": {
"type": "string",
"readOnly": true,
"description": "URL to get the next set of extension instance objects, if any."
}
}
},
"ExtensionInstanceUpdate": {
"description": "Update Extension Instance request object.",
"properties": {
"properties": {
"type": "object",
"x-ms-client-flatten": true,
"description": "Properties to update an Extension Instance resource",
"properties": {
"autoUpgradeMinorVersion": {
"description": "Flag to note if this instance participates in Extension Lifecycle Management or not.",
"type": "boolean"
},
"releaseTrain": {
"description": "ReleaseTrain this extension instance participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.",
"$ref": "#/definitions/ReleaseTrain"
},
"version": {
"description": "Version number of extension, to 'pin' to a specific version. autoUpgradeMinorVersion must be 'false'.",
"type": "string"
}
}
}
}
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)"
},
"ResourceGroupNameParameter": {
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group.",
"x-ms-parameter-location": "method"
},
"ClusterRpParameter": {
"name": "clusterRp",
"in": "path",
"required": true,
"type": "string",
"enum": [
"Microsoft.ContainerService",
"Microsoft.Kubernetes"
],
"description": "The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters).",
"x-ms-parameter-location": "method"
},
"ClusterResourceNameParameter": {
"name": "clusterResourceName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"managedClusters",
"connectedClusters"
],
"description": "The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters).",
"x-ms-parameter-location": "method"
},
"ClusterNameParameter": {
"name": "clusterName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the kubernetes cluster.",
"x-ms-parameter-location": "method"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The API version to be used with the HTTP request."
},
"ExtensionInstanceNameParameter": {
"name": "extensionInstanceName",
"in": "path",
"description": "Name of an instance of the Extension.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
}
}