az akshybrid
Note
This reference is part of the akshybrid extension for the Azure CLI (version 2.32.0 or higher). The extension will automatically install the first time you run an az akshybrid 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.
Name | Description | Type | Status |
---|---|---|---|
az akshybrid create |
Creates the provisioned cluster. |
Extension | Preview |
az akshybrid delete |
Deletes the provisioned cluster. |
Extension | Preview |
az akshybrid get-credentials |
Get local kubeconfig of the provisioned cluster. |
Extension | Preview |
az akshybrid get-upgrades |
Get the upgrade versions available for the provisioned cluster. |
Extension | Preview |
az akshybrid get-versions |
List the supported Kubernetes versions in the specified custom location. |
Extension | Preview |
az akshybrid nodepool |
Manage nodepools in a provisioned cluster. |
Extension | Preview |
az akshybrid nodepool add |
Adds a nodepool in the provisioned cluster. |
Extension | Preview |
az akshybrid nodepool delete |
Deletes the nodepool in the provisioned cluster. |
Extension | Preview |
az akshybrid nodepool list |
Lists all the nodepools in the provisioned cluster. |
Extension | Preview |
az akshybrid nodepool scale |
Scales the nodepool in the provisioned cluster . |
Extension | Preview |
az akshybrid nodepool show |
Gets the nodepool in the provisioned cluster. |
Extension | Preview |
az akshybrid notice |
Output NOTICE file to user specified filepath. |
Extension | Preview |
az akshybrid show |
Gets the provisioned cluster. |
Extension | Preview |
az akshybrid update |
Updates the provisioned cluster. |
Extension | Preview |
az akshybrid upgrade |
Upgrades the provisioned cluster. |
Extension | Preview |
az akshybrid vmsize |
Manage virtual machine SKUs for akshybrid. |
Extension | Preview |
az akshybrid vmsize list |
Lists the supported virtual machine sizes in the specified custom location. |
Extension | Preview |
az akshybrid vnet |
Manage virtual networks for provisioned clusters. |
Extension | Preview |
az akshybrid vnet create |
Creates the virtual network. |
Extension | Preview |
az akshybrid vnet delete |
Deletes the virtual network. |
Extension | Preview |
az akshybrid vnet list |
Lists the virtual networks by resource group or subscription. |
Extension | Preview |
az akshybrid vnet show |
Gets the virtual network. |
Extension | Preview |
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates the provisioned cluster.
az akshybrid create --custom-location
--name
--resource-group
[--aad-admin-group-object-ids]
[--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]
[--location]
[--no-ssh-key]
[--no-wait]
[--node-count]
[--node-vm-size]
[--pod-cidr]
[--ssh-key-value]
[--tags]
[--vnet-ids]
PutProvisionedCluster
az akshybrid create -g sample-rg --custom-location sample-cl -n sample-akshybridcluster --vnet-id vnet1
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>
.
Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.
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.
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.
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 VNets.
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Deletes the provisioned cluster.
az akshybrid delete --name
--resource-group
[--no-wait]
[--yes]
DeleteProvisionedCluster
az akshybrid delete --name "sample-akshybridcluster" --resource-group "sample-rg"
Name of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get local kubeconfig of the provisioned cluster.
az akshybrid get-credentials --name
--resource-group
[--admin]
[--context]
[--file]
[--overwrite-existing]
GetAdminCredential
az akshybrid get-credentials --name "sample-akshybridcluster" --resource-group "sample-rg" --admin
GetAADUserCredential
az akshybrid get-credentials --name "sample-akshybridcluster" --resource-group "sample-rg"
Name of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Get cluster administrator credentials.
If specified, overwrite the default context name.
Kubernetes configuration file to update. If not provided, updates the file '~/.kube/config'.
Overwrite any existing cluster entry with the same 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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the upgrade versions available for the provisioned cluster.
az akshybrid get-upgrades --name
--resource-group
Get the upgrade versions available for the Hybrid AKS provisioned cluster
az akshybrid get-upgrades --name "samplecluster" --resource-group "sample-rg"
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List the supported Kubernetes versions in the specified custom location.
az akshybrid get-versions --custom-location
--resource-group
VMListSkus
az akshybrid get-versions -g sample-rg --custom-location sample-cl
Name of the custom location to use for displaying the supported k8s versions.
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Output NOTICE file to user specified filepath.
az akshybrid notice --output-filepath
GetNoticeFile
az akshybrid notice --output-filepath "./Notice"
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Gets the provisioned cluster.
az akshybrid show --name
--resource-group
GetProvisionedCluster
az akshybrid show --name "sample-akshybridcluster" --resource-group "sample-rg"
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Updates the provisioned cluster.
az akshybrid update --name
--resource-group
[--aad-admin-group-object-ids]
[--tags]
UpdateProvisionedCluster
az akshybrid update --tags additionalProperties="sample" --name "sample-akshybridcluster" --resource-group "sample-rg"
Name of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Upgrades the provisioned cluster.
az akshybrid upgrade --name
--resource-group
[--kubernetes-version]
[--no-wait]
[--node-image-only]
[--yes]
UpgradeProvisionedCluster
az akshybrid upgrade --name "sample-akshybridcluster" --resource-group "sample-rg" --kubernetes-version v1.22.2
UpgradeProvisionedClusterNodeImage
az akshybrid upgrade --name "sample-akshybridcluster" --resource-group "sample-rg" --node-image-only
Name of the provisioned cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: