az aksarc

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage provisioned clusters.

Commands

Name	Description	Type	Status
az aksarc create	Creates the provisioned cluster.	Extension	Preview
az aksarc delete	Deletes the provisioned cluster.	Extension	Preview
az aksarc get-credentials	Gets local kubeconfig of the provisioned cluster.	Extension	Preview
az aksarc list	Lists the provisioned clusters in a resource group or in a subscription.	Extension	Preview
az aksarc logs	Collects logs from provisioned clusters.	Extension	Preview
az aksarc logs hci	Collects logs from provisioned clusters in HCI environment.	Extension	Preview
az aksarc nodepool	Manages node pools in a provisioned cluster.	Extension	Preview
az aksarc nodepool add	Adds a node pool in the provisioned cluster.	Extension	Preview
az aksarc nodepool delete	Deletes the nodepool in the provisioned cluster.	Extension	Preview
az aksarc nodepool list	Lists all the node pools in the provisioned cluster.	Extension	Preview
az aksarc nodepool scale	Scales the node pool in the provisioned cluster.	Extension	Preview
az aksarc nodepool show	Gets the node pool in the provisioned cluster.	Extension	Preview
az aksarc notice	Outputs NOTICE file to user-specified filepath.	Extension	Preview
az aksarc show	Gets the provisioned cluster.	Extension	Preview
az aksarc update	Updates the provisioned cluster.	Extension	Preview
az aksarc vmsize	Manages virtual machine SKUs for provisioned clusters.	Extension	Preview
az aksarc vmsize list	Lists the supported virtual machine sizes in the specified custom location.	Extension	Preview
az aksarc vnet	Manages virtual networks for provisioned clusters.	Extension	Preview
az aksarc vnet create	Creates the virtual network.	Extension	Preview
az aksarc vnet delete	Deletes the virtual network.	Extension	Preview
az aksarc vnet list	Lists the virtual networks by resource group or subscription.	Extension	Preview
az aksarc vnet show	Gets the virtual network.	Extension	Preview

az aksarc create

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates the provisioned cluster.

az aksarc create --custom-location
                 --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--control-plane-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--enable-ahub]
                 [--enable-azure-rbac]
                 [--generate-ssh-keys]
                 [--kubernetes-version]
                 [--load-balancer-count]
                 [--location]
                 [--no-wait]
                 [--node-count]
                 [--node-vm-size]
                 [--pod-cidr]
                 [--ssh-key-value]
                 [--tags]
                 [--vnet-ids]

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>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

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

Number of control plane nodes.

--control-plane-ip

API server IP address for the control plane.

--control-plane-vm-size

VM size of control plane.

--enable-ahub

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

Property	Value
Default value:	False

--enable-azure-rbac

Enable Azure RBAC to control authorization checks on cluster.

Property	Value
Default value:	False

--generate-ssh-keys

Generate ssh key-pair if not present.

Property	Value
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>.

--no-wait

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

Property	Value
Default value:	False

--node-count -c

Number of nodes to be created in the node pool.

Property	Value
Default value:	1

--node-vm-size

VM size of the nodes in the node pool.

--pod-cidr

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

--ssh-key-value

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

Property	Value
Default value:	~\.ssh\id_rsa.pub

--tags

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

--vnet-ids

Azure Resource Manager resource ID(s) of the VNets.

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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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 the resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property	Value
Default value:	False

--yes -y

Do not prompt for confirmation.

Property	Value
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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets 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 the resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--admin -a

Gets cluster administrator credentials.

Property	Value
Default value:	False

--context

If specified, overwrites the default context name.

--file -f

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

Property	Value
Default value:	~\.kube\config

--overwrite-existing

Overwrites any existing cluster entry with the same name.

Property	Value
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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of the 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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Outputs NOTICE file to user-specified filepath.

az aksarc notice --output-filepath

Examples

GetNoticeFile

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

Required Parameters

--output-filepath

Outputs 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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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 the 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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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

Preview

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Updates the provisioned cluster.

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--control-plane-count]
                 [--disable-ahub]
                 [--enable-ahub]
                 [--tags]

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

Disables the Azure Hybrid User Benefits feature for a provisioned cluster.

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

Scales 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 the resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

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

Number of nodes to which to scale the Control Plane.

--disable-ahub

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

Property	Value
Default value:	False

--enable-ahub

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

Property	Value
Default value:	False

--tags

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

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.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.