az connectedk8s

  • Reference

Commands to manage connected kubernetes clusters.

Commands

az connectedk8s connect

Onboard a connected kubernetes cluster to azure.
az connectedk8s delete

Delete a connected kubernetes cluster along with connected cluster agents.
az connectedk8s list

List connected kubernetes clusters.
az connectedk8s show

Show details of a connected kubernetes cluster.
az connectedk8s update

Update properties of the onboarded agents.

az connectedk8s connect

Onboard a connected kubernetes cluster to azure.

az connectedk8s connect --name
                        --resource-group
                        [--kube-config]
                        [--kube-context]
                        [--location]
                        [--no-wait]
                        [--proxy-http]
                        [--proxy-https]
                        [--proxy-skip-range]
                        [--tags]

Examples

Onboard a connected kubernetes cluster with default kube config and kube context.

az connectedk8s connect -g resourceGroupName -n connectedClusterName

Onboard a connected kubernetes cluster by specifying the kubeconfig and kubecontext.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --kube-config /path/to/kubeconfig --kube-context kubeContextName

Onboard a connected kubernetes cluster by specifying the https proxy, http proxy, no proxy settings.

az connectedk8s connect -g resourceGroupName -n connectedClusterName --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

Required Parameters

--name -n

The name of the connected cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--kube-config

Path to the kube config file.

--kube-context

Kubconfig context from current machine.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

--proxy-http

Http proxy URL to be used.

--proxy-https

Https proxy URL to be used.

--proxy-skip-range

List of URLs/CIDRs for which proxy should not to be used.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az connectedk8s delete

Delete a connected kubernetes cluster along with connected cluster agents.

az connectedk8s delete --name
                       --resource-group
                       [--kube-config]
                       [--kube-context]
                       [--no-wait]
                       [--yes]

Examples

Delete a connected kubernetes cluster and connected cluster agents with default kubeconfig and kubecontext.

az connectedk8s delete -g resourceGroupName -n connectedClusterName

Delete a connected kubernetes cluster by specifying the kubeconfig and kubecontext for connected cluster agents deletion.

az connectedk8s delete -g resourceGroupName -n connectedClusterName --kube-config /path/to/kubeconfig --kube-context kubeContextName

Required Parameters

--name -n

The name of the connected cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--kube-config

Path to the kube config file.

--kube-context

Kubconfig context from current machine.

--no-wait

Do not wait for the long-running operation to finish.

--yes -y

Do not prompt for confirmation.

az connectedk8s list

List connected kubernetes clusters.

az connectedk8s list [--resource-group]

Examples

List all connected kubernetes clusters in a resource group.

az connectedk8s list -g resourceGroupName --subscription subscriptionName

List all connected kubernetes clusters in a subscription.

az connectedk8s list --subscription subscriptionName

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az connectedk8s show

Show details of a connected kubernetes cluster.

az connectedk8s show --name
                     --resource-group

Examples

Show the details for a connected kubernetes cluster

az connectedk8s show -g resourceGroupName -n connectedClusterName

Required Parameters

--name -n

The name of the connected cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az connectedk8s update

Update properties of the onboarded agents.

az connectedk8s update --name
                       --resource-group
                       [--kube-config]
                       [--kube-context]
                       [--proxy-http]
                       [--proxy-https]
                       [--proxy-skip-range]

Examples

Update proxy values for the agents

az connectedk8s update -g resourceGroupName -n connectedClusterName --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

Required Parameters

--name -n

The name of the connected cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--kube-config

Path to the kube config file.

--kube-context

Kubconfig context from current machine.

--proxy-http

Http proxy URL to be used.

--proxy-https

Https proxy URL to be used.

--proxy-skip-range

List of URLs/CIDRs for which proxy should not to be used.