az aks
Manage Azure Kubernetes Services.
Commands
az aks browse |
Show the dashboard for a Kubernetes cluster in a web browser. |
az aks create |
Create a new managed Kubernetes cluster. |
az aks disable-addons |
Disable Kubernetes addons. |
az aks enable-addons |
Enable Kubernetes addons. |
az aks get-credentials |
Get access credentials for a managed Kubernetes cluster. |
az aks get-upgrades |
Get the upgrade versions available for a managed Kubernetes cluster. |
az aks get-versions |
Get the versions available for creating a managed Kubernetes cluster. |
az aks kanalyze |
Display diagnostic results for the Kubernetes cluster after kollect is done. |
az aks kollect |
Collecting diagnostic information for the Kubernetes cluster. |
az aks nodepool |
Commands to manage node pools in Kubernetes kubernetes cluster. |
az aks nodepool add |
Add a node pool to the managed Kubernetes cluster. |
az aks nodepool delete |
Delete the agent pool in the managed Kubernetes cluster. |
az aks nodepool list |
List node pools in the managed Kubernetes cluster. |
az aks nodepool scale |
Scale the node pool in a managed Kubernetes cluster. |
az aks nodepool show |
Show the details for a node pool in the managed Kubernetes cluster. |
az aks nodepool update |
Update a node pool to enable/disable cluster-autoscaler or change min-count or max-count. |
az aks nodepool upgrade |
Upgrade the node pool in a managed Kubernetes cluster. |
az aks rotate-certs |
Rotate certificates and keys on a managed Kubernetes cluster. |
az aks scale |
Scale the node pool in a managed Kubernetes cluster. |
az aks show |
Show the details for a managed Kubernetes cluster. |
az aks start |
Start Managed Cluster. |
az aks stop |
Stop Managed Cluster. |
az aks update |
Update a managed Kubernetes cluster properties, such as enable/disable cluster-autoscaler. |
az aks upgrade |
Upgrade a managed Kubernetes cluster to a newer version. |
az aks wait |
Wait for a managed Kubernetes cluster to reach a desired state. |
az aks browse
Show the dashboard for a Kubernetes cluster in a web browser.
az aks browse --name
--resource-group
[--disable-browser]
[--listen-address]
[--listen-port]
Examples
Show the dashboard for a Kubernetes cluster in a web browser. (autogenerated)
az aks browse --name MyManagedCluster --resource-group MyResourceGroup
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Don't launch a web browser after establishing port-forwarding.
The listening address for the dashboard.
The listening port for the dashboard.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks create
Create a new managed Kubernetes cluster.
az aks create --name
--resource-group
[--aad-admin-group-object-ids]
[--aad-client-app-id]
[--aad-server-app-id]
[--aad-server-app-secret]
[--aad-tenant-id]
[--admin-username]
[--aks-custom-headers]
[--api-server-authorized-ip-ranges]
[--appgw-id]
[--appgw-name]
[--appgw-subnet-id]
[--appgw-subnet-prefix]
[--appgw-watch-namespace]
[--assign-identity]
[--attach-acr]
[--client-secret]
[--cluster-autoscaler-profile]
[--disable-rbac]
[--disable-sgxquotehelper]
[--dns-name-prefix]
[--dns-service-ip]
[--docker-bridge-address]
[--enable-aad]
[--enable-addons]
[--enable-azure-rbac]
[--enable-cluster-autoscaler]
[--enable-managed-identity]
[--enable-node-public-ip]
[--enable-pod-security-policy]
[--enable-private-cluster]
[--enable-rbac]
[--enable-vmss]
[--generate-ssh-keys]
[--kubernetes-version]
[--load-balancer-idle-timeout]
[--load-balancer-managed-outbound-ip-count]
[--load-balancer-outbound-ip-prefixes]
[--load-balancer-outbound-ips]
[--load-balancer-outbound-ports]
[--load-balancer-sku]
[--location]
[--max-count]
[--max-pods]
[--min-count]
[--network-plugin {azure, kubenet}]
[--network-policy]
[--no-ssh-key]
[--no-wait]
[--node-count]
[--node-osdisk-diskencryptionset-id]
[--node-osdisk-size]
[--node-osdisk-type]
[--node-resource-group]
[--node-vm-size]
[--node-zones {1, 2, 3}]
[--nodepool-labels]
[--nodepool-name]
[--nodepool-tags]
[--outbound-type {loadBalancer, userDefinedRouting}]
[--pod-cidr]
[--ppg]
[--service-cidr]
[--service-principal]
[--skip-subnet-role-assignment]
[--ssh-key-value]
[--tags]
[--uptime-sla]
[--vm-set-type]
[--vnet-subnet-id]
[--windows-admin-password]
[--windows-admin-username]
[--workspace-resource-id]
Examples
Create a Kubernetes cluster with an existing SSH public key.
az aks create -g MyResourceGroup -n MyManagedCluster --ssh-key-value /path/to/publickey
Create a Kubernetes cluster with a specific version.
az aks create -g MyResourceGroup -n MyManagedCluster --kubernetes-version 1.13.9
Create a Kubernetes cluster with a larger node pool.
az aks create -g MyResourceGroup -n MyManagedCluster --node-count 7
Create a kubernetes cluster with cluster autosclaler enabled.
az aks create -g MyResourceGroup -n MyManagedCluster --kubernetes-version 1.13.9 --node-count 3 --enable-cluster-autoscaler --min-count 1 --max-count 5
Create a kubernetes cluster with k8s 1.13.9 but use vmas.
az aks create -g MyResourceGroup -n MyManagedCluster --kubernetes-version 1.13.9 --vm-set-type AvailabilitySet
Create a kubernetes cluster with default kubernetes vesrion, default SKU load balancer(standard) and default vm set type(VirtualMachineScaleSets).
az aks create -g MyResourceGroup -n MyManagedCluster
Create a kubernetes cluster with standard SKU load balancer and two AKS created IPs for the load balancer outbound connection usage.
az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-managed-outbound-ip-count 2
Create a kubernetes cluster with standard SKU load balancer and use the provided public IPs for the load balancer outbound connection usage.
az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-outbound-ips <ip-resource-id-1,ip-resource-id-2>
Create a kubernetes cluster with standard SKU load balancer and use the provided public IP prefixes for the load balancer outbound connection usage.
az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-outbound-ip-prefixes <ip-prefix-resource-id-1,ip-prefix-resource-id-2>
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
az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-managed-outbound-ip-count 2 --load-balancer-idle-timeout 5 --load-balancer-outbound-ports 8000
Create a kubernetes cluster with basic SKU load balancer and AvailabilitySet vm set type.
az aks create -g MyResourceGroup -n MyManagedCluster --load-balancer-sku basic --vm-set-type AvailabilitySet
Create a kubernetes cluster with authorized apiserver IP ranges.
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
Create a kubernetes cluster with server side encryption using your owned key.
az aks create -g MyResourceGroup -n MyManagedCluster --node-osdisk-diskencryptionset-id <disk-encryption-set-resource-id>
Create a kubernetes cluster with userDefinedRouting, standard load balancer SKU and a custom subnet preconfigured with a route table
az aks create -g MyResourceGroup -n MyManagedCluster --outbound-type userDefinedRouting --load-balancer-sku standard --vnet-subnet-id customUserSubnetVnetID
Create a kubernetes cluster with managed AAD enabled.
az aks create -g MyResourceGroup -n MyManagedCluster --enable-aad --aad-admin-group-object-ids <id-1,id-2> --aad-tenant-id <id>
Create a kubernetes cluster with ephemeral os enabled.
az aks create -g MyResourceGroup -n MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Comma seperated list of aad group object IDs that will be set as cluster admin.
The ID of an Azure Active Directory client application of type "Native". This application is for user login via kubectl.
The ID of an Azure Active Directory server application of type "Web app/API". This application represents the managed cluster's apiserver (Server application).
The secret of an Azure Active Directory server application.
The ID of an Azure Active Directory tenant.
User account to create on node VMs for SSH access.
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Comma seperated list of authorized apiserver IP ranges. Set to 0.0.0.0/32 to restrict apiserver traffic to node pools.
Resource Id of an existing Application Gateway to use with AGIC. Use with ingress-azure addon.
Name of the application gateway to create/use in the node resource group. Use with ingress-azure addon.
Resource Id of an existing Subnet used to deploy the Application Gateway. Use with ingress-azure addon.
Subnet Prefix to use for a new subnet created to deploy the Application Gateway. Use with ingress-azure addon.
Specify the namespace, which AGIC should watch. This could be a single string value, or a comma-separated list of namespaces.
(PREVIEW) Specify an existing user assigned identity to manage cluster resource group.
Grant the 'acrpull' role assignment to the ACR specified by name or resource ID.
Secret associated with the service principal. This argument is required if --service-principal
is specified.
Space-separated list of key=value pairs for configuring cluster autoscaler. Pass an empty string to clear the profile.
Disable Kubernetes Role-Based Access Control.
Disable SGX quote helper for confcom addon.
Prefix for hostnames that are created. If not specified, generate a hostname using the managed cluster and resource group names.
An IP address assigned to the Kubernetes DNS service.
A specific IP address and netmask for the Docker bridge, using standard CIDR notation.
Enable managed AAD feature for cluster.
Enable the Kubernetes addons in a comma-separated list.
Whether to enable Azure RBAC for Kubernetes authorization.
Enable cluster autoscaler, default value is false.
(PREVIEW) Using managed identity to manage cluster resource group.
Enable VMSS node public IP.
(PREVIEW) Enable pod security policy.
Enable private cluster.
Enable Kubernetes Role-Based Access Control. Default: enabled.
To be deprecated. Use vm_set_type instead.
Generate SSH public and private key files if missing.
Version of Kubernetes to use for creating the cluster, such as "1.7.12" or "1.8.7".
Load balancer idle timeout in minutes.
Load balancer managed outbound IP count.
Load balancer outbound IP prefix resource IDs.
Load balancer outbound IP resource IDs.
Load balancer outbound allocated ports.
Azure Load Balancer SKU selection for your cluster. basic or standard.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [1, 100].
The maximum number of pods deployable to a node.
Minimun nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [1, 100].
The Kubernetes network plugin to use.
(PREVIEW) The Kubernetes network policy to use.
Do not use or create a local SSH key.
Do not wait for the long-running operation to finish.
Number of nodes in the Kubernetes node pool. It is required when --enable-cluster-autoscaler specified. After creating a cluster, you can change the size of its node pool with az aks scale
.
ResourceId of the disk encryption set to use for enabling encryption at rest.
Size in GB of the OS disk for each node in the node pool. Minimum 30 GB.
OS disk type to be used for machines in a given agent pool. Defaults to 'Managed'. May not be changed for this pool after creation.
The node resource group is the resource group where all customer's resources will be created in, such as virtual machines.
Size of Virtual Machines to create as Kubernetes nodes.
(--node-zones will be deprecated, use --zones) Space-separated list of availability zones where agent nodes will be placed.
Space-separated labels: key[=value] [key[=value] ...]. You can not change the node labels through CLI after creation. See https://aka.ms/node-labels for syntax of labels.
Node pool name, upto 12 alphanumeric characters.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
How outbound traffic will be configured for a cluster.
A CIDR notation IP range from which to assign pod IPs when kubenet is used.
The ID of a PPG.
A CIDR notation IP range from which to assign service cluster IPs.
Service principal used for authentication to Azure APIs.
Skip role assignment for subnet (advanced networking).
Public key path or key contents to install on node VMs for SSH access. For example, 'ssh-rsa AAAAB...snip...UcyupgH azureuser@linuxvm'.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Enable a paid managed cluster service with a financially backed SLA.
Agent pool vm set type. VirtualMachineScaleSets or AvailabilitySet.
The ID of a subnet in an existing VNet into which to deploy the cluster.
User account password to use on windows node VMs.
User account to create on windows node VMs.
The resource ID of an existing Log Analytics Workspace to use for storing monitoring data. If not specified, uses the default Log Analytics Workspace if it exists, otherwise creates one.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks disable-addons
Disable Kubernetes addons.
az aks disable-addons --addons
--name
--resource-group
[--no-wait]
Examples
Disable Kubernetes addons. (autogenerated)
az aks disable-addons --addons virtual-node --name MyManagedCluster --resource-group MyResourceGroup
Required Parameters
Disable the Kubernetes addons in a comma-separated list.
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks enable-addons
Enable Kubernetes addons.
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. If monitoring addon is enabled --no-wait argument will have no effect virtual-node - enable AKS Virtual Node. Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. 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. ingress-appgw - enable Application Gateway Ingress Controller addon (PREVIEW).
az aks enable-addons --addons
--name
--resource-group
[--appgw-id]
[--appgw-name]
[--appgw-subnet-id]
[--appgw-subnet-prefix]
[--appgw-watch-namespace]
[--disable-sgxquotehelper]
[--no-wait]
[--subnet-name]
[--workspace-resource-id]
Examples
Enable Kubernetes addons. (autogenerated)
az aks enable-addons --addons virtual-node --name MyManagedCluster --resource-group MyResourceGroup --subnet-name VirtualNodeSubnet
Enable ingress-appgw addon with subnet prefix.
az aks enable-addons --name MyManagedCluster --resource-group MyResourceGroup --addons ingress-appgw --appgw-subnet-prefix 10.2.0.0/16 --appgw-name gateway
Required Parameters
Enable the Kubernetes addons in a comma-separated list.
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Resource Id of an existing Application Gateway to use with AGIC. Use with ingress-azure addon.
Name of the application gateway to create/use in the node resource group. Use with ingress-azure addon.
Resource Id of an existing Subnet used to deploy the Application Gateway. Use with ingress-azure addon.
Subnet Prefix to use for a new subnet created to deploy the Application Gateway. Use with ingress-azure addon.
Specify the namespace, which AGIC should watch. This could be a single string value, or a comma-separated list of namespaces. Use with ingress-azure addon.
Disable SGX quote helper for confcom addon.
Do not wait for the long-running operation to finish.
The subnet name for the virtual node to use.
The resource ID of an existing Log Analytics Workspace to use for storing monitoring data.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks get-credentials
Get access credentials for a managed Kubernetes cluster.
az aks get-credentials --name
--resource-group
[--admin]
[--context]
[--file]
[--overwrite-existing]
[--user]
Examples
Get access credentials for a managed Kubernetes cluster. (autogenerated)
az aks get-credentials --name MyManagedCluster --resource-group MyResourceGroup
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Get cluster administrator credentials. Default: cluster user credentials.
If specified, overwrite the default context name.
Kubernetes configuration file to update. Use "-" to print YAML to stdout instead.
Overwrite any existing cluster entry with the same name.
Get credentials for the user. Only valid when --admin is False. Default: cluster user credentials.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks get-upgrades
Get the upgrade versions available for a managed Kubernetes cluster.
az aks get-upgrades --name
--resource-group
Examples
Get the upgrade versions available for a managed Kubernetes cluster
az aks get-upgrades --name MyManagedCluster --resource-group MyResourceGroup
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks get-versions
Get the versions available for creating a managed Kubernetes cluster.
az aks get-versions --location
Examples
Get the versions available for creating a managed Kubernetes cluster
az aks get-versions --location westus2
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks kanalyze
Display diagnostic results for the Kubernetes cluster after kollect is done.
az aks kanalyze --name
--resource-group
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks kollect
Collecting diagnostic information for the Kubernetes cluster.
Collect diagnostic information for the Kubernetes cluster and store it in the specified storage account. You can provide the storage account in three ways: storage account name and a shared access signature with write permission. resource Id to a storage account you own. the storagea account in diagnostics settings for your managed cluster.
az aks kollect --name
--resource-group
[--container-logs]
[--kube-objects]
[--node-logs]
[--sas-token]
[--storage-account]
Examples
using storage account name and a shared access signature token with write permission
az aks kollect -g MyResourceGroup -n MyManagedCluster --storage-account MyStorageAccount --sas-token "MySasToken"
using the resource id of a storagea account resource you own.
az aks kollect -g MyResourceGroup -n MyManagedCluster --storage-account "MyStoreageAccountResourceId"
using the storagea account in diagnostics settings for your managed cluster.
az aks kollect -g MyResourceGroup -n MyManagedCluster
customize the container logs to collect.
az aks kollect -g MyResourceGroup -n MyManagedCluster --container-logs "mynamespace1/mypod1 myns2"
customize the kubernetes objects to collect.
az aks kollect -g MyResourceGroup -n MyManagedCluster --kube-objects "mynamespace1/service myns2/deployment/deployment1"
customize the node log files to collect.
az aks kollect -g MyResourceGroup -n MyManagedCluster --node-logs "/var/log/azure-vnet.log /var/log/azure-vnet-ipam.log"
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The list of container logs to collect.
The list of kubernetes objects to describe.
The list of node logs to collect. For example, /var/log/cloud-init.log.
The SAS token with writable permission for the storage account.
Name or ID of the storage account to save the diagnostic information.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks rotate-certs
Rotate certificates and keys on a managed Kubernetes cluster.
Kubernetes will be unavailable during cluster certificate rotation.
az aks rotate-certs --name
--resource-group
[--no-wait]
[--yes]
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks scale
Scale the node pool in a managed Kubernetes cluster.
az aks scale --name
--node-count
--resource-group
[--no-wait]
[--nodepool-name]
Required Parameters
Name of the managed cluster.
Number of nodes in the Kubernetes node pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Node pool name, upto 12 alphanumeric characters.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks show
Show the details for a managed Kubernetes cluster.
az aks show --name
--resource-group
Examples
Show the details for a managed Kubernetes cluster
az aks show --name MyManagedCluster --resource-group MyResourceGroup
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks start
Start Managed Cluster.
Starts a Stopped Managed Cluster.
az aks start --name
--resource-group
[--no-wait]
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks stop
Stop Managed Cluster.
Stops a Running Managed Cluster.
az aks stop --name
--resource-group
[--no-wait]
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks update
Update a managed Kubernetes cluster properties, such as enable/disable cluster-autoscaler.
az aks update --name
--resource-group
[--aad-admin-group-object-ids]
[--aad-tenant-id]
[--aks-custom-headers]
[--api-server-authorized-ip-ranges]
[--attach-acr]
[--cluster-autoscaler-profile]
[--detach-acr]
[--disable-cluster-autoscaler]
[--disable-pod-security-policy]
[--enable-aad]
[--enable-cluster-autoscaler]
[--enable-pod-security-policy]
[--load-balancer-idle-timeout]
[--load-balancer-managed-outbound-ip-count]
[--load-balancer-outbound-ip-prefixes]
[--load-balancer-outbound-ips]
[--load-balancer-outbound-ports]
[--max-count]
[--min-count]
[--no-wait]
[--update-cluster-autoscaler]
[--uptime-sla]
Examples
Enable cluster-autoscaler within node count range [1,5]
az aks update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n MyManagedCluster
Disable cluster-autoscaler for an existing cluster
az aks update --disable-cluster-autoscaler -g MyResourceGroup -n MyManagedCluster
Update min-count or max-count for cluster autoscaler.
az aks update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n MyManagedCluster
Enable pod security policy.
az aks update --enable-pod-security-policy -g MyResourceGroup -n MyManagedCluster
Disable pod security policy.
az aks update --disable-pod-security-policy -g MyResourceGroup -n MyManagedCluster
Update a kubernetes cluster with standard SKU load balancer to use two AKS created IPs for the load balancer outbound connection usage.
az aks update -g MyResourceGroup -n MyManagedCluster --load-balancer-managed-outbound-ip-count 2
Update a kubernetes cluster with standard SKU load balancer to use the provided public IPs for the load balancer outbound connection usage.
az aks update -g MyResourceGroup -n MyManagedCluster --load-balancer-outbound-ips <ip-resource-id-1,ip-resource-id-2>
Update a kubernetes cluster with standard SKU load balancer to use the provided public IP prefixes for the load balancer outbound connection usage.
az aks update -g MyResourceGroup -n MyManagedCluster --load-balancer-outbound-ip-prefixes <ip-prefix-resource-id-1,ip-prefix-resource-id-2>
Update a kubernetes cluster with two outbound AKS managed IPs an idle flow timeout of 5 minutes and 8000 allocated ports per machine
az aks update -g MyResourceGroup -n MyManagedCluster --load-balancer-managed-outbound-ip-count 2 --load-balancer-idle-timeout 5 --load-balancer-outbound-ports 8000
Update a kubernetes cluster with authorized apiserver ip ranges.
az aks update -g MyResourceGroup -n MyManagedCluster --api-server-authorized-ip-ranges 193.168.1.0/24,194.168.1.0/24
Disable authorized apiserver ip ranges feature for a kubernetes cluster.
az aks update -g MyResourceGroup -n MyManagedCluster --api-server-authorized-ip-ranges ""
Restrict apiserver traffic in a kubernetes cluster to agentpool nodes.
az aks update -g MyResourceGroup -n MyManagedCluster --api-server-authorized-ip-ranges 0.0.0.0/32
Update a AKS-managed AAD cluster with tenant ID or admin group object IDs.
az aks update -g MyResourceGroup -n MyManagedCluster --aad-admin-group-object-ids <id-1,id-2> --aad-tenant-id <id>
Migrate a AKS AAD-Integrated cluster or a non-AAAAD cluster to a AKS-managed AAD cluster.
az aks update -g MyResourceGroup -n MyManagedCluster --enable-aad --aad-admin-group-object-ids <id-1,id-2> --aad-tenant-id <id>
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Comma seperated list of aad group object IDs that will be set as cluster admin.
The ID of an Azure Active Directory tenant.
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Comma seperated list of authorized apiserver IP ranges. Set to "" to allow all traffic on a previously restricted cluster. Set to 0.0.0.0/32 to restrict apiserver traffic to node pools.
Grant the 'acrpull' role assignment to the ACR specified by name or resource ID.
Space-separated list of key=value pairs for configuring cluster autoscaler. Pass an empty string to clear the profile.
Disable the 'acrpull' role assignment to the ACR specified by name or resource ID.
Disable cluster autoscaler.
(PREVIEW) Disable pod security policy.
Enable managed AAD feature for cluster.
Enable cluster autoscaler.
(PREVIEW) Enable pod security policy.
Load balancer idle timeout in minutes.
Load balancer managed outbound IP count.
Load balancer outbound IP prefix resource IDs.
Load balancer outbound IP resource IDs.
Load balancer outbound allocated ports.
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [1, 100].
Minimun nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [1, 100].
Do not wait for the long-running operation to finish.
Update min-count or max-count for cluster autoscaler.
Enable a paid managed cluster service with a financially backed SLA.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks upgrade
Upgrade a managed Kubernetes cluster to a newer version.
Kubernetes will be unavailable during cluster upgrades.
az aks upgrade --name
--resource-group
[--control-plane-only]
[--kubernetes-version]
[--no-wait]
[--node-image-only]
[--yes]
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Upgrade the cluster control plane only. If not specified, control plane AND all node pools will be upgraded.
Version of Kubernetes to upgrade the cluster to, such as "1.11.12".
Do not wait for the long-running operation to finish.
Only upgrade node image for agent pools.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az aks wait
Wait for a managed Kubernetes cluster to reach a desired state.
If an operation on a cluster was interrupted or was started with --no-wait
, use this command to wait for it to complete.
az aks wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Examples
Wait for a cluster to be upgraded, polling every minute for up to thirty minutes.
az aks wait -g MyResourceGroup -n MyManagedCluster --updated --interval 60 --timeout 1800
Wait for a managed Kubernetes cluster to reach a desired state (autogenerated)
az aks wait --created --interval 60 --name MyManagedCluster --resource-group MyResourceGroup --timeout 1800
Required Parameters
Name of the managed cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.