az aksarc

Reference

Note

This reference is part of the aksarc extension for the Azure CLI (version 2.32.0 or higher). The extension will automatically install the first time you run an az aksarc command. Learn more about extensions.

Manage provisioned clusters.

Commands

Name	Description	Type	Status
az aksarc create	Creates the provisioned cluster.	Extension	GA
az aksarc delete	Deletes the provisioned cluster.	Extension	GA
az aksarc get-credentials	Get local kubeconfig of the provisioned cluster.	Extension	GA
az aksarc get-upgrades	Get the upgrade versions available for the provisioned cluster.	Extension	GA
az aksarc get-versions	List the supported Kubernetes versions in the specified custom location.	Extension	GA
az aksarc list	Lists the provisioned clusters in a resource group or in a subscription.	Extension	GA
az aksarc logs	Collect logs from provisioned clusters.	Extension	GA
az aksarc logs hci	Collect logs from provisioned clusters in HCI environment.	Extension	GA
az aksarc nodepool	Manage nodepools in a provisioned cluster.	Extension	GA
az aksarc nodepool add	Adds a nodepool in the provisioned cluster.	Extension	GA
az aksarc nodepool delete	Deletes the nodepool in the provisioned cluster.	Extension	GA
az aksarc nodepool list	Lists all the nodepools in the provisioned cluster.	Extension	GA
az aksarc nodepool scale	Scales the nodepool in the provisioned cluster .	Extension	GA
az aksarc nodepool show	Gets the nodepool in the provisioned cluster.	Extension	GA
az aksarc nodepool update	Update a nodepool in the provisioned cluster.	Extension	GA
az aksarc notice	Output NOTICE file to user specified filepath.	Extension	GA
az aksarc release	Manage VHD images for provisioned clusters.	Extension	Preview
az aksarc release download	Downloads the VHD images from a release.	Extension	Preview
az aksarc release save	Provisions the downloaded VHD images to the arc resource bridge.	Extension	Preview
az aksarc show	Gets the provisioned cluster.	Extension	GA
az aksarc update	Updates the provisioned cluster.	Extension	GA
az aksarc upgrade	Upgrades the provisioned cluster.	Extension	GA
az aksarc vmsize	Manage virtual machine SKUs for provisioned clusters.	Extension	GA
az aksarc vmsize list	Lists the supported virtual machine sizes in the specified custom location.	Extension	GA
az aksarc vnet	Manage virtual networks for provisioned clusters.	Extension	GA
az aksarc vnet create	Creates the virtual network.	Extension	GA
az aksarc vnet delete	Deletes the virtual network.	Extension	GA
az aksarc vnet list	Lists the virtual networks by resource group or subscription.	Extension	GA
az aksarc vnet show	Gets the virtual network.	Extension	GA

az aksarc create

Creates the provisioned cluster.

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--generate-ssh-keys]
                 [--kubernetes-version]
                 [--load-balancer-count]
                 [--location]
                 [--max-count]
                 [--max-pods]
                 [--min-count]
                 [--no-wait]
                 [--node-count]
                 [--node-vm-size]
                 [--nodepool-labels]
                 [--nodepool-taints]
                 [--pod-cidr]
                 [--ssh-auth-ips]
                 [--ssh-key-value]
                 [--tags]

Examples

PutProvisionedCluster

az aksarc create -g sample-rg --custom-location sample-cl -n sample-aksarccluster --vnet-ids "vnet-arm-id"

Required Parameters

--custom-location

Name or ID of the custom location to use for the provisioned cluster.

--name -n

Name of the provisioned cluster.

--resource-group -g

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

--vnet-id --vnet-ids

ARM resource ID of aksarc virtual network or Azure Stack HCI logical network.

Optional Parameters

--aad-admin-group-object-ids -i

Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.

--ca-profile --cluster-autoscaler-profile

Space-separated list of key=value pairs for configuring cluster autoscaler. Pass an empty string to clear the profile.

--control-plane-count --control-plane-node-count

Number of control plane nodes.

--control-plane-ip

\Kubernetes APIServer IPAddress. The IPAddress should be routable from Azure Resource Bridge Appliance VM. It should be part of the Network subnet being referenced. Exclude it from the IPPools to avoid duplicates. The cluster creation may fail or timeout if a non-routable IPAddress is passed.

--control-plane-vm-size

VM Size of control plane.

--disable-nfs-driver

Disable NFS driver for the provisioned cluster.

default value: False

--disable-smb-driver

Disable SMB driver for the provisioned cluster.

default value: False

--enable-ahub

Enable Azure Hybrid User Benefits (AHUB) for the provisioned cluster.

default value: False

--enable-azure-rbac

Enable Azure RBAC to control authorization checks on cluster.

default value: False

--enable-cluster-autoscaler -e

Enable cluster auto-scaler for the provisioned cluster.

default value: False

--generate-ssh-keys

Generate ssh key-pair if not present.

default value: False

--kubernetes-version -k

The kubernetes version of the provisioned cluster.

--load-balancer-count

Number of load balancer nodes.

--location -l

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

--max-count

The maximum number of nodes for auto-scaling.

--max-pods -m

Maximum number of pods that can run on a node.

--min-count

The minimum number of nodes for auto-scaling.

--no-wait

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

default value: False

--node-count -c

Number of nodes to be created in the nodepool.

default value: 1

--node-vm-size

VM Size of the nodes in the nodepool.

--nodepool-labels

Space-separated labels: key[=value] [key[=value] ...].

--nodepool-taints

Comma-separated list of nodepool taints.

--pod-cidr

The CIDR notation IP ranges from which to assign pod IPs.

--ssh-auth-ips --ssh-authorized-ip-ranges

Comma-separated list of IP addresses or CIDR that are allowed to ssh to the cluster vm.

--ssh-key-value

Path to the ssh public key to be injected into the control plane.

default value: ~\.ssh\id_rsa.pub

--tags

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc delete

Deletes the provisioned cluster.

az aksarc delete --name
                 --resource-group
                 [--no-wait]
                 [--yes]

Examples

DeleteProvisionedCluster

az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--no-wait

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

default value: False

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc get-credentials

Get local kubeconfig of the provisioned cluster.

az aksarc get-credentials --name
                          --resource-group
                          [--admin]
                          [--context]
                          [--file]
                          [--overwrite-existing]

Examples

GetAdminCredential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg" --admin

GetAADUserCredential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--admin -a

Get cluster administrator credentials.

default value: False

--context

If specified, overwrite the default context name.

--file -f

Kubernetes configuration file to update. If not provided, updates the file '~/.kube/config'.

default value: ~\.kube\config

--overwrite-existing

Overwrite any existing cluster entry with the same name.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc get-upgrades

Get the upgrade versions available for the provisioned cluster.

az aksarc get-upgrades --name
                       --resource-group

Examples

Get the upgrade versions available for the Hybrid AKS provisioned cluster

az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc get-versions

List the supported Kubernetes versions in the specified custom location.

az aksarc get-versions --custom-location
                       [--resource-group]

Examples

VMListSkus

az aksarc get-versions -g sample-rg --custom-location sample-cl

Required Parameters

--custom-location

Name of the custom location to use for displaying the supported k8s versions.

Optional Parameters

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc list

Lists the provisioned clusters in a resource group or in a subscription.

az aksarc list [--resource-group]

Examples

ListProvisionedClusterByResourceGroup

az aksarc list --resource-group "sample-rg"

ListProvisionedClusterBySubscription

az aksarc list

Optional Parameters

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc notice

Output NOTICE file to user specified filepath.

az aksarc notice --output-filepath

Examples

GetNoticeFile

az aksarc notice --output-filepath "./Notice"

Required Parameters

--output-filepath

Output filepath for NOTICE file.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc show

Gets the provisioned cluster.

az aksarc show --name
               --resource-group

Examples

GetProvisionedCluster

az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc update

Updates the provisioned cluster.

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--disable-ahub]
                 [--disable-cluster-autoscaler]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-cluster-autoscaler]
                 [--enable-nfs-driver]
                 [--enable-smb-driver]
                 [--max-count]
                 [--min-count]
                 [--tags]
                 [--update-cluster-autoscaler]

Examples

UpdateProvisionedCluster

az aksarc update --tags additionalProperties="sample" --name "sample-aksarccluster" --resource-group "sample-rg"

Enable Azure Hybrid User Benefits feature for a provisioned cluster.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --enable-ahub

Disable Azure Hybrid User Benefits feature for a provisioned cluster.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg"--disable-ahub

Scale Up Control Plane Nodes.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --control-plane-node-count 5

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--aad-admin-group-object-ids -i

Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.

--ca-profile --cluster-autoscaler-profile

Space-separated list of key=value pairs for configuring cluster autoscaler. Pass an empty string to clear the profile.

--control-plane-count --control-plane-node-count

Number of nodes to scale the Control Plane to.

--disable-ahub

Disable Azure Hybrid User Benefits (AHUB) for the provisioned cluster.

default value: False

--disable-cluster-autoscaler -d

Disable cluster auto-scaler for the provisioned cluster.

default value: False

--disable-nfs-driver

Disable NFS driver for the provisioned cluster.

default value: False

--disable-smb-driver

Disable SMB driver for the provisioned cluster.

default value: False

--enable-ahub

Enable Azure Hybrid User Benefits (AHUB) for the provisioned cluster.

default value: False

--enable-cluster-autoscaler -e

Enable cluster auto-scaler for the provisioned cluster.

default value: False

--enable-nfs-driver

Enable NFS driver for the provisioned cluster.

default value: False

--enable-smb-driver

Enable SMB driver for the provisioned cluster.

default value: False

--max-count

The maximum number of nodes for auto-scaling.

--min-count

The minimum number of nodes for auto-scaling.

--tags

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

--update-cluster-autoscaler -u

Update cluster auto-scaler for the provisioned cluster.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc upgrade

Upgrades the provisioned cluster.

az aksarc upgrade --name
                  --resource-group
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

Examples

UpgradeProvisionedCluster

az aksarc upgrade --name "sample-aksarccluster" --resource-group "sample-rg" --kubernetes-version "1.22.2"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--kubernetes-version -k

The kubernetes version of the provisioned cluster.

--no-wait

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

default value: False

--yes

Flag to disable confirmation prompts.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az aksarc

Commands

az aksarc create

Examples

Required Parameters

Optional Parameters

az aksarc delete

Examples

Required Parameters

Optional Parameters

az aksarc get-credentials

Examples

Required Parameters

Optional Parameters

az aksarc get-upgrades

Examples

Required Parameters

az aksarc get-versions

Examples

Required Parameters

Optional Parameters

az aksarc list

Examples

Optional Parameters

az aksarc notice

Examples

Required Parameters

az aksarc show

Examples

Required Parameters

az aksarc update

Examples

Required Parameters

Optional Parameters

az aksarc upgrade

Examples

Required Parameters

Optional Parameters

Feedback

Additional resources