az hybridaks

Preview
Reference

Note

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

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

Manage hybridaks provisioned clusters.

Commands

Name	Description	Type	Status
az hybridaks create	Creates the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks delete	Deletes the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks get-upgrades	Get the upgrade versions available for the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks list	Lists the Hybrid AKS provisioned cluster in a resource group or in a subscription.	Extension	Preview
az hybridaks nodepool	Manage nodepools in a hybridaks provisioned cluster.	Extension	Preview
az hybridaks nodepool add	Adds a nodepool in the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks nodepool delete	Deletes the nodepool in the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks nodepool list	Lists all the nodepools in the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks nodepool scale	Scales the nodepool in the Hybrid AKS provisioned cluster .	Extension	Preview
az hybridaks nodepool show	Gets the nodepool in the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks notice	Output NOTICE file to user specified filepath.	Extension	Preview
az hybridaks proxy	Gets access to a connected Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks show	Gets the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks update	Updates the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks upgrade	Upgrades the Hybrid AKS provisioned cluster.	Extension	Preview
az hybridaks vnet	Manage virtual networks for hybridaks.	Extension	Preview
az hybridaks vnet create	Creates the Hybrid AKS virtual network.	Extension	Preview
az hybridaks vnet delete	Deletes the Hybrid AKS virtual network.	Extension	Preview
az hybridaks vnet list	Lists the Hybrid AKS virtual networks by resource group or subscription.	Extension	Preview
az hybridaks vnet show	Gets the Hybrid AKS virtual network.	Extension	Preview

az hybridaks create

Preview

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

Creates the Hybrid AKS provisioned cluster.

az hybridaks create --custom-location
                    --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--addon]
                    [--arc-agent-auto-upgrade]
                    [--arc-agent-version]
                    [--control-plane-count]
                    [--control-plane-ip]
                    [--control-plane-vm-size]
                    [--generate-ssh-keys]
                    [--kubernetes-version]
                    [--load-balancer-count]
                    [--load-balancer-sku]
                    [--load-balancer-vm-size]
                    [--location]
                    [--no-ssh-key]
                    [--no-wait]
                    [--node-count]
                    [--node-vm-size]
                    [--pod-cidr]
                    [--service-cidr]
                    [--ssh-key-value]
                    [--tags]
                    [--vnet-ids]
                    [--zones]

Examples

PutProvisionedCluster

az hybridaks create -g sample-rg --custom-location sample-cl -n sample-hybridakscluster --vnet-id vnet1

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

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

--addon -a

Enable addon. Multiple addons can be added by specifying this flag. Usage: --addon name=addon-name [config_key=config_value ...].

--arc-agent-auto-upgrade

Arc Agent Auto Upgrade.

default value: Enabled

--arc-agent-version

Arc Agent Version.

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

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

--load-balancer-sku

Type of load balancer. Options: "unstacked-haproxy" | "stacked-kube-vip" | "stacked-metallb" | "unmanaged".

--load-balancer-vm-size

VM Size of load balancer.

--location -l

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

--no-ssh-key -x

Do not use inject any public ssh key.

default value: False

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

--node-vm-size

VM Size of the nodes in the nodepool.

--pod-cidr

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

--service-cidr

A CIDR notation IP range from which to assign service cluster IPs.

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

--vnet-ids

ARM resource ID(s) of the HybridAKS VNets.

--zones -z

Comma-separated list of availability zones where control plane nodes will be placed.

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

Preview

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

Deletes the Hybrid AKS provisioned cluster.

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

Examples

DeleteProvisionedCluster

az hybridaks delete --name "sample-hybridakscluster" --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 hybridaks get-upgrades

Preview

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

Get the upgrade versions available for the Hybrid AKS provisioned cluster.

az hybridaks get-upgrades --name
                          --resource-group

Examples

Get the upgrade versions available for the Hybrid AKS provisioned cluster

az hybridaks 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 hybridaks list

Preview

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

Lists the Hybrid AKS provisioned cluster in a resource group or in a subscription.

az hybridaks list [--resource-group]

Examples

ListProvisionedClusterByResourceGroup

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

ListProvisionedClusterBySubscription

az hybridaks 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 hybridaks notice

Preview

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

Output NOTICE file to user specified filepath.

az hybridaks notice --output-filepath

Examples

GetNoticeFile

az hybridaks 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 hybridaks proxy

Preview

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

Gets access to a connected Hybrid AKS provisioned cluster.

az hybridaks proxy [--file]
                   [--ids]
                   [--kube-context]
                   [--name]
                   [--port]
                   [--resource-group]
                   [--subscription]
                   [--token]

Examples

Get access to a connected kubernetes cluster.

az hybridaks proxy -n clusterName -g resourceGroupName

Get access to a connected kubernetes cluster with custom port

az hybridaks proxy -n clusterName -g resourceGroupName --port portValue

Get access to a connected kubernetes cluster with service account token

az hybridaks proxy -n clusterName -g resourceGroupName --token tokenValue

Get access to a connected kubernetes cluster by specifying custom kubeconfig location

az hybridaks proxy -n clusterName -g resourceGroupName -f path/to/kubeconfig

Get access to a connected kubernetes cluster by specifying custom context

az hybridaks proxy -n clusterName -g resourceGroupName --kube-context contextName

Optional Parameters

--file -f

Kubernetes configuration file to update. If not provided, updates the file '~/.kube/config'. Use '-' to print YAML to stdout instead.

default value: ~\.kube\config

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--kube-context

If specified, overwrite the default context name.

--name -n

The name of the hybrid AKS provisioned cluster.

--port

Port used for accessing connected cluster.

default value: 47013

--resource-group -g

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

--subscription

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

--token

Service account token to use to authenticate to the kubernetes cluster.

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

Preview

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

Gets the Hybrid AKS provisioned cluster.

az hybridaks show --name
                  --resource-group

Examples

GetProvisionedCluster

az hybridaks show --name "sample-hybridakscluster" --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 hybridaks update

Preview

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

Updates the Hybrid AKS provisioned cluster.

az hybridaks update --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--tags]

Examples

UpdateProvisionedCluster

az hybridaks update --tags additionalProperties="sample" --name "sample-hybridakscluster" --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

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

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

Preview

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

Upgrades the Hybrid AKS provisioned cluster.

az hybridaks upgrade --name
                     --resource-group
                     [--kubernetes-version]
                     [--no-wait]
                     [--node-image-only]
                     [--yes]

Examples

UpgradeProvisionedCluster

az hybridaks upgrade --name "sample-hybridakscluster" --resource-group "sample-rg" --kubernetes-version v1.22.2

UpgradeProvisionedClusterNodeImage

az hybridaks upgrade --name "sample-hybridakscluster" --resource-group "sample-rg" --node-image-only

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

--node-image-only

Flag to upgrade only the node image.

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 hybridaks

Commands

az hybridaks create

Examples

Required Parameters

Optional Parameters

az hybridaks delete

Examples

Required Parameters

Optional Parameters

az hybridaks get-upgrades

Examples

Required Parameters

az hybridaks list

Examples

Optional Parameters

az hybridaks notice

Examples

Required Parameters

az hybridaks proxy

Examples

Optional Parameters

az hybridaks show

Examples

Required Parameters

az hybridaks update

Examples

Required Parameters

Optional Parameters

az hybridaks upgrade

Examples

Required Parameters

Optional Parameters

Feedback

Additional resources