az aksarc

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 deploy	Deploy a full AKS baremetal cluster onto one or more existing Arc-for-Servers (BareMetal) hosts.	Extension	GA
az aksarc get-credentials	Get local kubeconfig of the provisioned cluster.	Extension	GA
az aksarc get-logs	Collect logs from provisioned clusters and the underlying infrastructure.	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	Deprecated. Use 'az aksarc get-logs' instead.	Extension	GA
az aksarc logs hci	Collect logs from provisioned clusters and the underlying infrastructure.	Extension	Deprecated
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 undeploy	Tear down an AKS baremetal cluster previously created by 'az aksarc deploy'.	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 --custom-location
                 --name
                 --resource-group
                 --vnet-id --vnet-ids
                 [--aad-admin-group-object-ids]
                 [--acquire-policy-token]
                 [--ca-certs --custom-ca-trust-certificates]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--change-reference]
                 [--control-plane-count --control-plane-node-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-ai-toolchain-operator --enable-kaito]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--enable-oidc-issuer]
                 [--enable-wi --enable-workload-identity]
                 [--gateway-id]
                 [--generate-ssh-keys]
                 [--gpu-count-per-node]
                 [--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-authorized-ip-ranges]
                 [--ssh-key-value]
                 [--tags]
                 [--validate]

Examples

PutProvisionedCluster

az aksarc create --resource-group sample-rg --custom-location sample-cl --name sample-aksarccluster --vnet-ids "vnet-arm-id"

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc delete --name
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--no-wait]
                 [--yes]

Examples

DeleteProvisionedCluster

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

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc deploy --arc-machine-name --arc-machine-names --machine-names
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--enable-wi --enable-workload-identity]
                 [--hci-rp-object-id]
                 [--kubernetes-version]
                 [--no-wait]
                 [--validate]
                 [--yes]

Examples

Deploy a single-node AKS baremetal cluster

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost

Deploy a multi-node AKS baremetal cluster

az aksarc deploy --resource-group sample-rg --arc-machine-names host1 host2 host3

Deploy with WorkloadIdentity support enabled

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost --enable-workload-identity

Deploy a specific Kubernetes versioned bundle

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost --kubernetes-version 1.35.5-20260701

Deploy without Microsoft Graph lookup

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost --hci-rp-object-id <hci-rp-object-id>

Validate without deploying

az aksarc deploy --resource-group sample-rg --arc-machine-names host1 host2 --validate

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc get-credentials --name
                          --resource-group
                          [--acquire-policy-token]
                          [--admin]
                          [--change-reference]
                          [--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

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc get-logs [--acquire-policy-token]
                   [--change-reference]
                   [--credentials-dir --ssh-key]
                   [--ip --ips]
                   [--kubeconfig]
                   [--out-dir]

Examples

Collect logs with IP address and SSH credentials

az aksarc get-logs --ip 192.168.200.31 192.168.200.32 --ssh-key ~/.ssh --out-dir ./logs

Collect logs with kubeconfig and SSH credentials, kubeconfig is only used to collect IP addresses, and ssh-key file path is used instead of directory

az aksarc get-logs --kubeconfig ~/.kube/config --ssh-key ~/.ssh/id_rsa --out-dir ./logs

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc get-upgrades --name
                       --resource-group
                       [--acquire-policy-token]
                       [--change-reference]

Examples

Get the upgrade versions available for the Hybrid AKS provisioned cluster

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

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc get-versions --custom-location
                       [--acquire-policy-token]
                       [--change-reference]
                       [--resource-group]

Examples

VMListSkus

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

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc notice --output-filepath
                 [--acquire-policy-token]
                 [--change-reference]

Examples

GetNoticeFile

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

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc show --name
               --resource-group

Examples

GetProvisionedCluster

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

Required Parameters

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc undeploy --arc-machine-name --arc-machine-names --machine-names
                   --resource-group
                   [--acquire-policy-token]
                   [--change-reference]
                   [--yes]

Examples

Undeploy AKS Arc resources for the given Arc machines

az aksarc undeploy --resource-group sample-rg --arc-machine-names host1 host2 host3

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--acquire-policy-token]
                 [--ca-certs --custom-ca-trust-certificates]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--change-reference]
                 [--control-plane-count --control-plane-node-count]
                 [--control-plane-vm-size]
                 [--disable-ahub]
                 [--disable-ai-toolchain-operator --disable-kaito]
                 [--disable-cluster-autoscaler]
                 [--disable-gateway]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-ai-toolchain-operator --enable-kaito]
                 [--enable-cluster-autoscaler]
                 [--enable-nfs-driver]
                 [--enable-smb-driver]
                 [--gateway-id]
                 [--max-count]
                 [--min-count]
                 [--tags]
                 [--update-cluster-autoscaler]
                 [--yes]

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

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

az aksarc upgrade --name
                  --resource-group
                  [--acquire-policy-token]
                  [--change-reference]
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

Examples

UpgradeProvisionedCluster

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

Required Parameters

Optional Parameters

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

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

Property	Value
Default value:	False