az hybridaks
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
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
Name or ID of the custom location to use for the provisioned cluster.
Name of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.
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 Version.
Number of control plane nodes.
API server IP Address for the control plane.
VM Size of control plane.
Generate ssh key-pair if not present.
The kubernetes version of the provisioned cluster.
Number of load balancer nodes.
Type of load balancer. Options: "unstacked-haproxy" | "stacked-kube-vip" | "stacked-metallb" | "unmanaged".
VM Size of load balancer.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not use inject any public ssh key.
Do not wait for the long-running operation to finish.
Number of nodes to be created in the nodepool.
VM Size of the nodes in the nodepool.
The CIDR notation IP ranges from which to assign pod IPs.
A CIDR notation IP range from which to assign service cluster IPs.
Path to the ssh public key to be injected into the control plane.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
ARM resource ID(s) of the HybridAKS VNets.
Comma-separated list of availability zones where control plane nodes will be placed.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks delete
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 of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks get-upgrades
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 of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks list
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks notice
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 for NOTICE file.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks proxy
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
Kubernetes configuration file to update. If not provided, updates the file '~/.kube/config'. Use '-' to print YAML to stdout instead.
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.
If specified, overwrite the default context name.
The name of the hybrid AKS provisioned cluster.
Port used for accessing connected cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Service account token to use to authenticate to the kubernetes cluster.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks show
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 of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks update
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 of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az hybridaks upgrade
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 of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The kubernetes version of the provisioned cluster.
Do not wait for the long-running operation to finish.
Flag to upgrade only the node image.
Flag to disable confirmation prompts.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.