-
Notifications
You must be signed in to change notification settings - Fork 474
/
aks.yml
5560 lines (5559 loc) · 252 KB
/
aks.yml
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
### YamlMime:AzureCLIGroup
uid: az_aks
name: az aks
importantNote: >-
> [!NOTE]
> This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
Manage Azure Kubernetes Services.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_aks_browse
name: az aks browse
summary: |-
Show the dashboard for a Kubernetes cluster in a web browser.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/acs/_help.py
syntax: >-
az aks browse --name
--resource-group
[--disable-browser]
[--listen-address]
[--listen-port]
examples:
- summary: |-
Show the dashboard for a Kubernetes cluster in a web browser. (autogenerated)
syntax: az aks browse --name MyManagedCluster --resource-group MyResourceGroup
requiredParameters:
- isRequired: true
name: --name -n
summary: |-
Name of the managed cluster.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
optionalParameters:
- name: --disable-browser
defaultValue: "False"
summary: |-
Don't launch a web browser after establishing port-forwarding.
description: |-
Add this argument when launching a web browser manually, or for automated testing.
- name: --listen-address
defaultValue: "127.0.0.1"
summary: |-
The listening address for the dashboard.
description: |-
Add this argument to listen on a specific IP address.
- name: --listen-port
defaultValue: "8001"
summary: |-
The listening port for the dashboard.
description: |-
Add this argument when the default listening port is used by another process or unavailable.
- uid: az_aks_browse(aks-preview)
name: az aks browse
extensionSuffix: aks-preview
summary: |-
Show the dashboard for a Kubernetes cluster in a web browser.
status: GA
sourceType: Extension
syntax: >-
az aks browse --name
--resource-group
[--disable-browser]
[--listen-address]
[--listen-port]
examples:
- summary: |-
Show the dashboard for a Kubernetes cluster in a web browser. (autogenerated)
syntax: az aks browse --name MyManagedCluster --resource-group MyResourceGroup
requiredParameters:
- isRequired: true
name: --name -n
summary: |-
Name of the managed cluster.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
optionalParameters:
- name: --disable-browser
defaultValue: "False"
summary: |-
Don't launch a web browser after establishing port-forwarding.
description: |-
Add this argument when launching a web browser manually, or for automated testing.
- name: --listen-address
defaultValue: "127.0.0.1"
summary: |-
The listening address for the dashboard.
description: |-
Add this argument to listen on a specific IP address.
- name: --listen-port
defaultValue: "8001"
summary: |-
The listening port for the dashboard.
description: |-
Add this argument when the default listening port is used by another process or unavailable.
- uid: az_aks_check-acr
name: az aks check-acr
summary: |-
Validate an ACR is accessible from an AKS cluster.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/acs/_help.py
syntax: >-
az aks check-acr --acr
--name
--resource-group
[--node-name]
examples:
- summary: |-
Validate the ACR is accessible from the AKS cluster.
syntax: az aks check-acr --name MyManagedCluster --resource-group MyResourceGroup --acr myacr.azurecr.io
requiredParameters:
- isRequired: true
name: --acr
summary: |-
The FQDN of the ACR.
- isRequired: true
name: --name -n
summary: |-
Name of the managed cluster.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
optionalParameters:
- name: --node-name
summary: |-
The name of a specific node to perform acr pull test checks. If not specified, it will be checked on a random node.
- uid: az_aks_create
name: az aks create
summary: |-
Create a new managed Kubernetes cluster.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/acs/_help.py
syntax: >-
az aks create --name
--resource-group
[--aad-admin-group-object-ids]
[--aad-tenant-id]
[--aci-subnet-name]
[--admin-username]
[--aks-custom-headers]
[--ampls-resource-id]
[--api-server-authorized-ip-ranges]
[--appgw-id]
[--appgw-name]
[--appgw-subnet-cidr]
[--appgw-subnet-id]
[--appgw-watch-namespace]
[--assign-identity]
[--assign-kubelet-identity]
[--attach-acr]
[--auto-upgrade-channel {node-image, none, patch, rapid, stable}]
[--azure-keyvault-kms-key-id]
[--azure-keyvault-kms-key-vault-network-access {Private, Public}]
[--azure-keyvault-kms-key-vault-resource-id]
[--azure-monitor-workspace-resource-id]
[--ca-profile]
[--client-secret]
[--crg-id]
[--data-collection-settings]
[--defender-config]
[--disable-disk-driver]
[--disable-file-driver]
[--disable-local-accounts]
[--disable-public-fqdn]
[--disable-rbac]
[--disable-snapshot-controller]
[--dns-name-prefix]
[--dns-service-ip]
[--edge-zone]
[--enable-aad]
[--enable-addons]
[--enable-ahub]
[--enable-app-routing]
[--enable-asm]
[--enable-azure-container-storage {azureDisk, elasticSan, ephemeralDisk}]
[--enable-azure-keyvault-kms]
[--enable-azure-monitor-metrics]
[--enable-azure-rbac]
[--enable-blob-driver]
[--enable-cluster-autoscaler]
[--enable-cost-analysis]
[--enable-defender]
[--enable-encryption-at-host]
[--enable-fips-image]
[--enable-high-log-scale-mode {false, true}]
[--enable-image-cleaner]
[--enable-keda]
[--enable-managed-identity]
[--enable-msi-auth-for-monitoring {false, true}]
[--enable-node-public-ip]
[--enable-oidc-issuer]
[--enable-private-cluster]
[--enable-secret-rotation]
[--enable-sgxquotehelper]
[--enable-syslog {false, true}]
[--enable-ultra-ssd]
[--enable-vpa]
[--enable-windows-gmsa]
[--enable-windows-recording-rules]
[--enable-workload-identity]
[--ephemeral-disk-nvme-perf-tier {Basic, Premium, Standard}]
[--ephemeral-disk-volume-type {EphemeralVolumeOnly, PersistentVolumeWithAnnotation}]
[--fqdn-subdomain]
[--generate-ssh-keys]
[--gmsa-dns-server]
[--gmsa-root-domain-name]
[--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
[--grafana-resource-id]
[--host-group-id]
[--http-proxy-config]
[--image-cleaner-interval-hours]
[--ip-families]
[--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}]
[--ksm-metric-annotations-allow-list]
[--ksm-metric-labels-allow-list]
[--kubelet-config]
[--kubernetes-version]
[--linux-os-config]
[--load-balancer-backend-pool-type {nodeIP, nodeIPConfiguration}]
[--load-balancer-idle-timeout]
[--load-balancer-managed-outbound-ip-count]
[--load-balancer-managed-outbound-ipv6-count]
[--load-balancer-outbound-ip-prefixes]
[--load-balancer-outbound-ips]
[--load-balancer-outbound-ports]
[--load-balancer-sku {basic, standard}]
[--location]
[--max-count]
[--max-pods]
[--min-count]
[--nat-gateway-idle-timeout]
[--nat-gateway-managed-outbound-ip-count]
[--network-dataplane {azure, cilium}]
[--network-plugin {azure, kubenet, none}]
[--network-plugin-mode {overlay}]
[--network-policy]
[--no-ssh-key]
[--no-wait]
[--node-count]
[--node-os-upgrade-channel {NodeImage, None, SecurityPatch, Unmanaged}]
[--node-osdisk-diskencryptionset-id]
[--node-osdisk-size]
[--node-osdisk-type {Ephemeral, Managed}]
[--node-public-ip-prefix-id]
[--node-public-ip-tags]
[--node-resource-group]
[--node-vm-size]
[--nodepool-allowed-host-ports]
[--nodepool-asg-ids]
[--nodepool-labels]
[--nodepool-name]
[--nodepool-tags]
[--nodepool-taints]
[--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu}]
[--outbound-type {loadBalancer, managedNATGateway, userAssignedNATGateway, userDefinedRouting}]
[--pod-cidr]
[--pod-cidrs]
[--pod-subnet-id]
[--ppg]
[--private-dns-zone]
[--revision]
[--rotation-poll-interval]
[--service-cidr]
[--service-cidrs]
[--service-principal]
[--skip-subnet-role-assignment]
[--snapshot-id]
[--ssh-key-value]
[--storage-pool-name]
[--storage-pool-option {NVMe, Temp}]
[--storage-pool-size]
[--storage-pool-sku {PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS}]
[--tags]
[--tier {free, premium, standard}]
[--vm-set-type]
[--vnet-subnet-id]
[--windows-admin-password]
[--windows-admin-username]
[--workspace-resource-id]
[--yes]
[--zones]
examples:
- summary: |-
Create a Kubernetes cluster with an existing SSH public key.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --ssh-key-value /path/to/publickey
- summary: |-
Create a Kubernetes cluster with a specific version.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --kubernetes-version 1.16.9
- summary: |-
Create a Kubernetes cluster with a larger node pool.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --node-count 7
- summary: |-
Create a kubernetes cluster with default kubernetes version, default SKU load balancer (Standard) and default vm set type (VirtualMachineScaleSets).
syntax: az aks create -g MyResourceGroup -n MyManagedCluster
- summary: |-
Create a kubernetes cluster with standard SKU load balancer and two AKS created IPs for the load balancer outbound connection usage.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-managed-outbound-ip-count 2
- summary: |-
Create a kubernetes cluster with a standard SKU load balancer, with two outbound AKS managed IPs an idle flow timeout of 5 minutes and 8000 allocated ports per machine
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-managed-outbound-ip-count 2 --load-balancer-idle-timeout 5 --load-balancer-outbound-ports 8000
- summary: |-
Create a kubernetes cluster with standard SKU load balancer and use the provided public IPs for the load balancer outbound connection usage.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-outbound-ips <ip-resource-id-1,ip-resource-id-2>
- summary: |-
Create a kubernetes cluster with standard SKU load balancer and use the provided public IP prefixes for the load balancer outbound connection usage.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-outbound-ip-prefixes <ip-prefix-resource-id-1,ip-prefix-resource-id-2>
- summary: |-
Create a kubernetes cluster with a AKS managed NAT gateway, with two outbound AKS managed IPs an idle flow timeout of 4 minutes
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --nat-gateway-managed-outbound-ip-count 2 --nat-gateway-idle-timeout 4 --outbound-type managedNATGateway --generate-ssh-keys
- summary: |-
Create a kubernetes cluster with basic SKU load balancer and AvailabilitySet vm set type.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-sku basic --vm-set-type AvailabilitySet
- summary: |-
Create a kubernetes cluster with authorized apiserver IP ranges.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --api-server-authorized-ip-ranges 193.168.1.0/24,194.168.1.0/24,195.168.1.0
- summary: |-
Create a kubernetes cluster which enables managed identity.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-managed-identity
- summary: |-
Create a kubernetes cluster with userDefinedRouting, standard load balancer SKU and a custom subnet preconfigured with a route table
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --outbound-type userDefinedRouting --load-balancer-sku standard --vnet-subnet-id customUserSubnetVnetID
- summary: |-
Create a kubernetes cluster with supporting Windows agent pools.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-sku Standard --network-plugin azure --windows-admin-username azure --windows-admin-password 'replacePassword1234$'
- summary: |-
Create a kubernetes cluster with supporting Windows agent pools with AHUB enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-sku Standard --network-plugin azure --windows-admin-username azure --windows-admin-password 'replacePassword1234$' --enable-ahub
- summary: |-
Create a kubernetes cluster with managed AAD enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-aad --aad-admin-group-object-ids <id-1,id-2> --aad-tenant-id <id>
- summary: |-
Create a kubernetes cluster with server side encryption using your owned key.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --node-osdisk-diskencryptionset-id <disk-encryption-set-resource-id>
- summary: |-
Create a kubernetes cluster with ephemeral OS enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48
- summary: |-
Create a kubernetes cluster with EncryptionAtHost enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-encryption-at-host
- summary: |-
Create a kubernetes cluster with UltraSSD enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-ultra-ssd
- summary: |-
Create a kubernetes cluster with Azure RBAC enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-aad --enable-azure-rbac
- summary: |-
Create a kubernetes cluster with custom control plane identity and kubelet identity.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --assign-identity <control-plane-identity-resource-id> --assign-kubelet-identity <kubelet-identity-resource-id>
- summary: |-
Create a kubernetes cluster in the Edge Zone.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --location <location> --kubernetes-version 1.20.7 --edge-zone <edge-zone-name>
- summary: |-
Create a kubernetes cluster with a specific OS SKU
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --os-sku Ubuntu
- summary: |-
Create a kubernetes cluster with custom tags
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --tags "foo=bar" "baz=qux"
- summary: |-
Create a kubernetes cluster with custom headers
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --aks-custom-headers WindowsContainerRuntime=containerd
- summary: |-
Create a kubernetes cluster with FIPS-enabled OS
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-fips-image
- summary: |-
Create a kubernetes cluster with enabling Windows gmsa and with setting DNS server in the vnet used by the cluster.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-sku Standard --network-plugin azure --windows-admin-username azure --windows-admin-password 'replacePassword1234$' --enable-windows-gmsa
- summary: |-
Create a kubernetes cluster with enabling Windows gmsa but without setting DNS server in the vnet used by the cluster.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-sku Standard --network-plugin azure --windows-admin-username azure --windows-admin-password 'replacePassword1234$' --enable-windows-gmsa --gmsa-dns-server "10.240.0.4" --gmsa-root-domain-name "contoso.com"
- summary: |-
create a kubernetes cluster with a snapshot id.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --kubernetes-version 1.20.9 --snapshot-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/snapshots/mysnapshot1"
- summary: |-
create a kubernetes cluster with support of hostgroup id.
syntax: az aks create -g MyResourceGroup -n MyMC --kubernetes-version 1.20.13 --location westus2 --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSize --enable-managed-identity --assign-identity <user_assigned_identity_resource_id>
- summary: |-
Create a kubernetes cluster with no CNI installed.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --network-plugin none
- summary: |-
Create a kubernetes cluster with KEDA workload autoscaler enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-keda
- summary: |-
Create a kubernetes cluster with the Azure Monitor managed service for Prometheus integration enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-azure-monitor-metrics
- summary: |-
Create a kubernetes cluster with vertical pod autoscaler enaled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-vpa
- summary: |-
create a kubernetes cluster with a Capacity Reservation Group(CRG) ID.
syntax: az aks create -g MyResourceGroup -n MyMC --kubernetes-version 1.20.9 --node-vm-size VMSize --assign-identity "subscriptions/SubID/resourceGroups/RGName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID" --enable-managed-identity --crg-id "subscriptions/SubID/resourceGroups/RGName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"
- summary: |-
Create a kubernetes cluster with Azure Service Mesh enabled.
syntax: az aks create -g MyResourceGroup -n MyManagedCluster --enable-azure-service-mesh
requiredParameters:
- isRequired: true
name: --name -n
summary: |-
Name of the managed cluster.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
optionalParameters:
- name: --aad-admin-group-object-ids
summary: |-
Comma-separated list of aad group object IDs that will be set as cluster admin.
- name: --aad-tenant-id
summary: |-
The ID of an Azure Active Directory tenant.
- name: --aci-subnet-name
summary: |-
The name of a subnet in an existing VNet into which to deploy the virtual nodes.
- name: --admin-username -u
defaultValue: "azureuser"
summary: |-
User account to create on node VMs for SSH access.
- name: --aks-custom-headers
summary: |-
Comma-separated key-value pairs to specify custom headers.
- name: --ampls-resource-id
summary: |-
Resource ID of Azure Monitor Private Link scope for Monitoring Addon.
- name: --api-server-authorized-ip-ranges
summary: |-
Comma-separated list of authorized apiserver IP ranges. Set to 0.0.0.0/32 to restrict apiserver traffic to node pools.
- name: --appgw-id
summary: |-
Resource Id of an existing Application Gateway to use with AGIC. Use with ingress-azure addon.
- name: --appgw-name
summary: |-
Name of the application gateway to create/use in the node resource group. Use with ingress-azure addon.
- name: --appgw-subnet-cidr
summary: |-
Subnet CIDR to use for a new subnet created to deploy the Application Gateway. Use with ingress-azure addon.
- name: --appgw-subnet-id
summary: |-
Resource Id of an existing Subnet used to deploy the Application Gateway. Use with ingress-azure addon.
- name: --appgw-watch-namespace
summary: |-
Specify the namespace, which AGIC should watch. This could be a single string value, or a comma-separated list of namespaces.
- name: --assign-identity
summary: |-
Specify an existing user assigned identity for control plane's usage in order to manage cluster resource group.
- name: --assign-kubelet-identity
summary: |-
Specify an existing user assigned identity for kubelet's usage, which is typically used to pull image from ACR.
- name: --attach-acr
summary: |-
Grant the 'acrpull' role assignment to the ACR specified by name or resource ID.
- name: --auto-upgrade-channel
parameterValueGroup: "node-image, none, patch, rapid, stable"
summary: |-
Specify the upgrade channel for autoupgrade.
- name: --azure-keyvault-kms-key-id
summary: |-
Identifier of Azure Key Vault key.
- name: --azure-keyvault-kms-key-vault-network-access
parameterValueGroup: "Private, Public"
summary: |-
Network Access of Azure Key Vault.
description: |-
Allowed values are "Public", "Private". If not set, defaults to type "Public". Requires --azure-keyvault-kms-key-id to be used.
- name: --azure-keyvault-kms-key-vault-resource-id
summary: |-
Resource ID of Azure Key Vault.
- name: --azure-monitor-workspace-resource-id
summary: |-
Resource ID of the Azure Monitor Workspace.
- name: --ca-profile --cluster-autoscaler-profile
summary: |-
Comma-separated list of key=value pairs for configuring cluster autoscaler. Pass an empty string to clear the profile.
- name: --client-secret
summary: |-
Secret associated with the service principal. This argument is required if `--service-principal` is specified.
- name: --crg-id
summary: |-
The crg id used to associate the new cluster with the existed Capacity Reservation Group resource.
- name: --data-collection-settings
summary: |-
Path to JSON file containing data collection settings for Monitoring addon.
- name: --defender-config
summary: |-
Path to JSON file containing Microsoft Defender profile configurations.
- name: --disable-disk-driver
defaultValue: "False"
summary: |-
Disable AzureDisk CSI Driver.
- name: --disable-file-driver
defaultValue: "False"
summary: |-
Disable AzureFile CSI Driver.
- name: --disable-local-accounts
defaultValue: "False"
summary: |-
If set to true, getting static credential will be disabled for this cluster.
- name: --disable-public-fqdn
defaultValue: "False"
summary: |-
Disable public fqdn feature for private cluster.
- name: --disable-rbac
summary: |-
Disable Kubernetes Role-Based Access Control.
- name: --disable-snapshot-controller
defaultValue: "False"
summary: |-
Disable CSI Snapshot Controller.
- name: --dns-name-prefix -p
summary: |-
Prefix for hostnames that are created. If not specified, generate a hostname using the managed cluster and resource group names.
- name: --dns-service-ip
summary: |-
An IP address assigned to the Kubernetes DNS service.
description: |-
This address must be within the Kubernetes service address range specified by "--service-cidr". For example, 10.0.0.10.
- name: --edge-zone
summary: |-
The name of the Edge Zone.
- name: --enable-aad
defaultValue: "False"
summary: |-
Enable managed AAD feature for cluster.
- name: --enable-addons -a
summary: |-
Enable the Kubernetes addons in a comma-separated list.
description: |-
These addons are available:
- http_application_routing : configure ingress with automatic public DNS name creation.
- monitoring : turn on Log Analytics monitoring. Uses the Log Analytics Default Workspace if it exists, else creates one.
Specify "--workspace-resource-id" to use an existing workspace.
Specify "--enable-msi-auth-for-monitoring" to use Managed Identity Auth.
Specify "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled
Specify "--data-collection-settings" to configure data collection settings
Specify "--ampls-resource-id" for private link. Note MSI must be enabled.
Specify "--enable-high-log-scale-mode" to enable high log scale mode for container logs. Note MSI must be enabled.
If monitoring addon is enabled --no-wait argument will have no effect
- azure-policy : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner.
Learn more at aka.ms/aks/policy.
- virtual-node : enable AKS Virtual Node.
Requires --aci-subnet-name to provide the name of an existing subnet for the Virtual Node to use.
aci-subnet-name must be in the same vnet which is specified by --vnet-subnet-id (required as well).
- confcom : enable confcom addon, this will enable SGX device plugin by default.
- open-service-mesh : enable Open Service Mesh addon.
- azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon.
- name: --enable-ahub
defaultValue: "False"
summary: |-
Enable Azure Hybrid User Benefits (AHUB) for Windows VMs.
- name: --enable-app-routing
defaultValue: "False"
summary: |-
Enable Application Routing addon.
- name: --enable-asm --enable-azure-service-mesh
summary: |-
Enable Azure Service Mesh addon.
- name: --enable-azure-container-storage
parameterValueGroup: "azureDisk, elasticSan, ephemeralDisk"
summary: |-
Enable azure container storage and define storage pool type.
- name: --enable-azure-keyvault-kms
defaultValue: "False"
summary: |-
Enable Azure KeyVault Key Management Service.
- name: --enable-azure-monitor-metrics
defaultValue: "False"
summary: |-
Enable a kubernetes cluster with the Azure Monitor managed service for Prometheus integration.
- name: --enable-azure-rbac
defaultValue: "False"
summary: |-
Enable Azure RBAC to control authorization checks on cluster.
- name: --enable-blob-driver
summary: |-
Enable AzureBlob CSI Driver.
- name: --enable-cluster-autoscaler
defaultValue: "False"
summary: |-
Enable cluster autoscaler, default value is false.
description: |-
If specified, please make sure the kubernetes version is larger than 1.10.6.
- name: --enable-cost-analysis
defaultValue: "False"
summary: |-
Enable exporting Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. For more information see aka.ms/aks/docs/cost-analysis.
- name: --enable-defender
defaultValue: "False"
summary: |-
Enable Microsoft Defender security profile.
- name: --enable-encryption-at-host
defaultValue: "False"
summary: |-
Enable EncryptionAtHost, default value is false.
- name: --enable-fips-image
defaultValue: "False"
summary: |-
Use FIPS-enabled OS on agent nodes.
- name: --enable-high-log-scale-mode
defaultValue: "False"
parameterValueGroup: "false, true"
summary: |-
Enable High Log Scale Mode for Container Logs.
isPreview: true
- name: --enable-image-cleaner
defaultValue: "False"
summary: |-
Enable ImageCleaner Service.
- name: --enable-keda
defaultValue: "False"
summary: |-
Enable KEDA workload auto-scaler.
- name: --enable-managed-identity
summary: |-
Using a system assigned managed identity to manage cluster resource group. You can explicitly specify "--service-principal" and "--client-secret" to disable managed identity, otherwise it will be enabled.
- name: --enable-msi-auth-for-monitoring
defaultValue: "True"
parameterValueGroup: "false, true"
summary: |-
Enable Managed Identity Auth for Monitoring addon.
- name: --enable-node-public-ip
defaultValue: "False"
summary: |-
Enable VMSS node public IP.
- name: --enable-oidc-issuer
defaultValue: "False"
summary: |-
Enable OIDC issuer.
- name: --enable-private-cluster
defaultValue: "False"
summary: |-
Enable private cluster.
- name: --enable-secret-rotation
defaultValue: "False"
summary: |-
Enable secret rotation. Use with azure-keyvault-secrets-provider addon.
- name: --enable-sgxquotehelper
defaultValue: "False"
summary: |-
Enable SGX quote helper for confcom addon.
- name: --enable-syslog
defaultValue: "False"
parameterValueGroup: "false, true"
summary: |-
Enable syslog data collection for Monitoring addon.
- name: --enable-ultra-ssd
defaultValue: "False"
summary: |-
Enable UltraSSD, default value is false.
- name: --enable-vpa
defaultValue: "False"
summary: |-
Enable vertical pod autoscaler for cluster.
- name: --enable-windows-gmsa
defaultValue: "False"
summary: |-
Enable Windows gmsa.
- name: --enable-windows-recording-rules
defaultValue: "False"
summary: |-
Enable Windows Recording Rules when enabling the Azure Monitor Metrics addon.
- name: --enable-workload-identity
defaultValue: "False"
summary: |-
Enable workload identity addon.
- name: --ephemeral-disk-nvme-perf-tier
parameterValueGroup: "Basic, Premium, Standard"
summary: |-
Set ephemeral disk volume type for azure container storage.
- name: --ephemeral-disk-volume-type
parameterValueGroup: "EphemeralVolumeOnly, PersistentVolumeWithAnnotation"
summary: |-
Set ephemeral disk volume type for azure container storage.
- name: --fqdn-subdomain
summary: |-
Prefix for FQDN that is created for private cluster with custom private dns zone scenario.
- name: --generate-ssh-keys
defaultValue: "False"
summary: |-
Generate SSH public and private key files if missing. The keys will be stored in the ~/.ssh directory.
- name: --gmsa-dns-server
summary: |-
Specify DNS server for Windows gmsa for this cluster.
description: |-
You do not need to set this if you have set DNS server in the VNET used by the cluster.
You must set or not set --gmsa-dns-server and --gmsa-root-domain-name at the same time when setting --enable-windows-gmsa.
- name: --gmsa-root-domain-name
summary: |-
Specify root domain name for Windows gmsa for this cluster.
description: |-
You do not need to set this if you have set DNS server in the VNET used by the cluster.
You must set or not set --gmsa-dns-server and --gmsa-root-domain-name at the same time when setting --enable-windows-gmsa.
- name: --gpu-instance-profile
parameterValueGroup: "MIG1g, MIG2g, MIG3g, MIG4g, MIG7g"
summary: |-
GPU instance profile to partition multi-gpu Nvidia GPUs.
- name: --grafana-resource-id
summary: |-
Resource ID of the Azure Managed Grafana Workspace.
- name: --host-group-id
summary: |-
The fully qualified dedicated host group id used to provision agent node pool.
- name: --http-proxy-config
summary: |-
HTTP Proxy configuration for this cluster.
- name: --image-cleaner-interval-hours
summary: |-
ImageCleaner scanning interval.
- name: --ip-families
summary: |-
A comma-separated list of IP versions to use for cluster networking.
description: |-
Each IP version should be in the format IPvN. For example, IPv4.
- name: --k8s-support-plan
parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial"
summary: |-
Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs.
- name: --ksm-metric-annotations-allow-list
summary: |-
Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]').
- name: --ksm-metric-labels-allow-list
summary: |-
Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g. '=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]').
- name: --kubelet-config
summary: |-
Path to JSON file containing Kubelet configurations for agent nodes. https://aka.ms/aks/custom-node-config.
- name: --kubernetes-version -k
summary: |-
Version of Kubernetes to use for creating the cluster, such as "1.16.9".
valueFrom: '`az aks get-versions`'
- name: --linux-os-config
summary: |-
Path to JSON file containing OS configurations for Linux agent nodes. https://aka.ms/aks/custom-node-config.
- name: --load-balancer-backend-pool-type
parameterValueGroup: "nodeIP, nodeIPConfiguration"
summary: |-
Load balancer backend pool type.
description: |-
Define the LoadBalancer backend pool type of managed inbound backend pool. The nodeIP means the VMs will be attached to the LoadBalancer by adding its private IP address to the backend pool. The nodeIPConfiguration means the VMs will be attached to the LoadBalancer by referencing the backend pool ID in the VM's NIC.
- name: --load-balancer-idle-timeout
summary: |-
Load balancer idle timeout in minutes.
description: |-
Desired idle timeout for load balancer outbound flows, default is 30 minutes. Please specify a value in the range of [4, 100].
- name: --load-balancer-managed-outbound-ip-count
summary: |-
Load balancer managed outbound IP count.
description: |-
Desired number of managed outbound IPs for load balancer outbound connection. Valid for Standard SKU load balancer cluster only.
- name: --load-balancer-managed-outbound-ipv6-count
summary: |-
Load balancer managed outbound IPv6 IP count.
description: |-
Desired number of managed outbound IPv6 IPs for load balancer outbound connection. Valid for dual-stack (--ip-families IPv4,IPv6) only.
- name: --load-balancer-outbound-ip-prefixes
summary: |-
Load balancer outbound IP prefix resource IDs.
description: |-
Comma-separated public IP prefix resource IDs for load balancer outbound connection. Valid for Standard SKU load balancer cluster only.
- name: --load-balancer-outbound-ips
summary: |-
Load balancer outbound IP resource IDs.
description: |-
Comma-separated public IP resource IDs for load balancer outbound connection. Valid for Standard SKU load balancer cluster only.
- name: --load-balancer-outbound-ports
summary: |-
Load balancer outbound allocated ports.
description: |-
Desired static number of outbound ports per VM in the load balancer backend pool. By default, set to 0 which uses the default allocation based on the number of VMs.
- name: --load-balancer-sku
parameterValueGroup: "basic, standard"
summary: |-
Azure Load Balancer SKU selection for your cluster. basic or standard. Defaults to 'standard'.
description: |-
Select between Basic or Standard Azure Load Balancer SKU for your AKS cluster.
- name: --location -l
summary: |-
Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=<location>`.
- name: --max-count
summary: |-
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [1, 1000].
- name: --max-pods -m
summary: |-
The maximum number of pods deployable to a node.
description: |-
If not specified, defaults based on network-plugin. 30 for "azure", 110 for "kubenet", or 250 for "none".
- name: --min-count
summary: |-
Minimum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [1, 1000].
- name: --nat-gateway-idle-timeout
summary: |-
NAT gateway idle timeout in minutes.
description: |-
Desired idle timeout for NAT gateway outbound flows, default is 4 minutes. Please specify a value in the range of [4, 120]. Valid for Standard SKU load balancer cluster with managedNATGateway outbound type only.
- name: --nat-gateway-managed-outbound-ip-count
summary: |-
NAT gateway managed outbound IP count.
description: |-
Desired number of managed outbound IPs for NAT gateway outbound connection. Please specify a value in the range of [1, 16]. Valid for Standard SKU load balancer cluster with managedNATGateway outbound type only.
- name: --network-dataplane
parameterValueGroup: "azure, cilium"
summary: |-
The network dataplane to use.
description: |-
Network dataplane used in the Kubernetes cluster.
Specify "azure" to use the Azure dataplane (default) or "cilium" to enable Cilium dataplane.
- name: --network-plugin
parameterValueGroup: "azure, kubenet, none"
summary: |-
The Kubernetes network plugin to use.
description: |-
Specify "azure" for routable pod IPs from VNET, "kubenet" for non-routable pod IPs with an overlay network, or "none" for no networking configured. Defaults to "kubenet".
- name: --network-plugin-mode
parameterValueGroup: "overlay"
summary: |-
The network plugin mode to use.
description: |-
Used to control the mode the network plugin should operate in. For example, "overlay" used with
--network-plugin=azure will use an overlay network (non-VNET IPs) for pods in the cluster.
- name: --network-policy
summary: |-
Network Policy Engine to use.
description: |-
Azure provides three Network Policy Engines for enforcing network policies that can be used together with "azure" network plugin. The following values can be specified:
- "azure" for Azure Network Policy Manager,
- "cilium" for Azure CNI Powered by Cilium,
- "calico" for open-source network and network security solution founded by Tigera,
- "none" when no Network Policy Engine is installed (default value).
Defaults to "none" (network policy disabled).
- name: --no-ssh-key -x
defaultValue: "False"
summary: |-
Do not use or create a local SSH key.
description: |-
To access nodes after creating a cluster with this option, use the Azure Portal.
- name: --no-wait
defaultValue: "False"
summary: |-
Do not wait for the long-running operation to finish.
- name: --node-count -c
defaultValue: "3"
summary: |-
Number of nodes in the Kubernetes node pool. After creating a cluster, you can change the size of its node pool with `az aks scale`.
- name: --node-os-upgrade-channel
parameterValueGroup: "NodeImage, None, SecurityPatch, Unmanaged"
summary: |-
Manner in which the OS on your nodes is updated. It could be NodeImage, None, SecurityPatch or Unmanaged.
- name: --node-osdisk-diskencryptionset-id -d
summary: |-
ResourceId of the disk encryption set to use for enabling encryption at rest on agent node os disk.
- name: --node-osdisk-size
summary: |-
Size in GiB of the OS disk for each node in the node pool. Minimum 30 GiB.
- name: --node-osdisk-type
parameterValueGroup: "Ephemeral, Managed"
summary: |-
OS disk type to be used for machines in a given agent pool: Ephemeral or Managed. Defaults to 'Ephemeral' when possible in conjunction with VM size and OS disk size. May not be changed for this pool after creation.
- name: --node-public-ip-prefix-id
summary: |-
Public IP prefix ID used to assign public IPs to VMSS nodes.
- name: --node-public-ip-tags
summary: |-
The ipTags of the node public IPs.
- name: --node-resource-group
summary: |-
The node resource group is the resource group where all customer's resources will be created in, such as virtual machines.
- name: --node-vm-size -s
summary: |-
Size of Virtual Machines to create as Kubernetes nodes.
- name: --nodepool-allowed-host-ports
summary: |-
Expose host ports on the node pool. When specified, format should be a space-separated list of ranges with protocol, eg. `80/TCP 443/TCP 4000-5000/TCP`.
- name: --nodepool-asg-ids
summary: |-
The IDs of the application security groups to which the node pool's network interface should belong. When specified, format should be a space-separated list of IDs.
- name: --nodepool-labels
summary: |-
The node labels for all node pool. See https://aka.ms/node-labels for syntax of labels.
- name: --nodepool-name
defaultValue: "nodepool1"
summary: |-
Node pool name, up to 12 alphanumeric characters.
- name: --nodepool-tags
summary: |-
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
- name: --nodepool-taints
summary: |-
The node taints for all node pool.
- name: --os-sku
parameterValueGroup: "AzureLinux, CBLMariner, Mariner, Ubuntu"
summary: |-
The OS SKU of the agent node pool. Ubuntu or CBLMariner.
- name: --outbound-type
parameterValueGroup: "loadBalancer, managedNATGateway, userAssignedNATGateway, userDefinedRouting"
summary: |-
How outbound traffic will be configured for a cluster.
description: |-
Select between loadBalancer, userDefinedRouting, managedNATGateway and userAssignedNATGateway. If not set, defaults to type loadBalancer. Requires --vnet-subnet-id to be provided with a preconfigured route table and --load-balancer-sku to be Standard.
- name: --pod-cidr
summary: |-
A CIDR notation IP range from which to assign pod IPs when kubenet is used.
description: |-
This range must not overlap with any Subnet IP ranges. For example, 172.244.0.0/16.
- name: --pod-cidrs
summary: |-
A comma-separated list of CIDR notation IP ranges from which to assign pod IPs when kubenet is used.
description: |-
Each range must not overlap with any Subnet IP ranges. For example, "172.244.0.0/16,fd0:abcd::/64".
- name: --pod-subnet-id
summary: |-
The ID of a subnet in an existing VNet into which to assign pods in the cluster (requires azure network-plugin).
- name: --ppg
summary: |-
The ID of a PPG.
- name: --private-dns-zone
summary: |-
Private dns zone mode for private cluster.
description: |-
Allowed values are "system", "none" or custom private dns zone resource id. If not set, defaults to type system. Requires --enable-private-cluster to be used.
- name: --revision
summary: |-
Azure Service Mesh revision to install.
- name: --rotation-poll-interval
summary: |-
Set interval of rotation poll. Use with azure-keyvault-secrets-provider addon.
- name: --service-cidr
summary: |-
A CIDR notation IP range from which to assign service cluster IPs.
description: |-
This range must not overlap with any Subnet IP ranges. For example, 10.0.0.0/16.
- name: --service-cidrs
summary: |-
A comma-separated list of CIDR notation IP ranges from which to assign service cluster IPs.
description: |-
Each range must not overlap with any Subnet IP ranges. For example, "10.0.0.0/16,2001:abcd::/108".
- name: --service-principal
summary: |-
Service principal used for authentication to Azure APIs.
description: |-
If not specified, a new service principal is created and cached at $HOME/.azure/aksServicePrincipal.json to be used by subsequent `az aks` commands.
- name: --skip-subnet-role-assignment
defaultValue: "False"
summary: |-
Skip role assignment for subnet (advanced networking).
description: |-
If specified, please make sure your service principal has the access to your subnet.
- name: --snapshot-id
summary: |-
The source snapshot id used to create this cluster.
- name: --ssh-key-value
defaultValue: "~\\.ssh\\id_rsa.pub"
summary: |-
Public key path or key contents to install on node VMs for SSH access. For example, 'ssh-rsa AAAAB...snip...UcyupgH azureuser@linuxvm'.
- name: --storage-pool-name
summary: |-
Set storage pool name for azure container storage.
- name: --storage-pool-option
parameterValueGroup: "NVMe, Temp"
summary: |-
Set ephemeral disk storage pool option for azure container storage.
- name: --storage-pool-size
summary: |-
Set storage pool size for azure container storage.
- name: --storage-pool-sku
parameterValueGroup: "PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS"
summary: |-
Set azure disk type storage pool sku for azure container storage.
- name: --tags
summary: |-
The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged.
- name: --tier
parameterValueGroup: "free, premium, standard"
summary: |-
Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' does not have a financially backed SLA.
- name: --vm-set-type
summary: |-
Agent pool vm set type. VirtualMachineScaleSets or AvailabilitySet. Defaults to 'VirtualMachineScaleSets'.
- name: --vnet-subnet-id
summary: |-
The ID of a subnet in an existing VNet into which to deploy the cluster.
- name: --windows-admin-password
summary: |-
User account password to use on windows node VMs.
description: |-
Rules for windows-admin-password:
- Minimum-length: 14 characters
- Max-length: 123 characters
- Complexity requirements: 3 out of 4 conditions below need to be fulfilled
* Has lower characters
* Has upper characters
* Has a digit
* Has a special character (Regex match [\W_])
- Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"