Azure / Azure/azure-cli

az find gives an example parameter not listed in help file

Open
#17,086 1 comment 0 reactions 0 assignees View on GitHub
Find Service Attention
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

**Describe the bug**
`az find "az aks enable-addons"` outputs the example command `az aks enable-addons --addons virtual-node --name MyManagedCluster --resource-group MyResourceGroup --subnet MySubnetName`, but `--subnet` is not listed in the help files. I'm not sure which is right, but either `az aks enable-addons --help` or `az find "az aks enable-addons"` is wrong.

This occurs with and without the aks-preview extension installed

**To Reproduce**
```
david@WIN-T14B9CT7KMS:~/Docker-Provider-3/scripts/onboarding/templates$ az aks enable-addons --help
The behavior of this command has been altered by the following extension: aks-preview

Command
az aks enable-addons : Enable Kubernetes addons.
These addons are available:
http_application_routing - configure ingress with automatic public DNS name creation.
monitoring - turn on Log Analytics monitoring. Uses the Log Analytics
Default Workspace if it exists, else creates one. Specify "--workspace-resource-id" to use
an existing workspace.
If monitoring addon is enabled --no-wait argument will have
no effect
virtual-node - enable AKS Virtual Node. Requires --subnet-name to provide
the name of an existing subnet for the Virtual Node to use.
azure-policy - enable Azure policy. The Azure Policy add-on for AKS enables
at-scale enforcements and safeguards on your clusters in a centralized, consistent manner.
Learn more at aka.ms/aks/policy.
ingress-appgw - enable Application Gateway Ingress Controller addon
(PREVIEW).

Arguments
--addons -a [Required] : Enable the Kubernetes addons in a comma-separated list.
--name -n [Required] : Name of the managed cluster.
--resource-group -g [Required] : Name of resource group. You can configure the default group
using `az configure --defaults group=`.
--appgw-id : Resource Id of an existing Application Gateway to use with
AGIC. Use with ingress-azure addon.
--appgw-name : Name of the application gateway to create/use in the node
resource group. Use with ingress-azure addon.
--appgw-subnet-id : Resource Id of an existing Subnet used to deploy the
Application Gateway. Use with ingress-azure addon.
--appgw-subnet-prefix : Subnet Prefix to use for a new subnet created to deploy the
Application Gateway. Use with ingress-azure addon.
--appgw-watch-namespace : Specify the namespace, which AGIC should watch. This could be a
single string value, or a comma-separated list of namespaces.
Use with ingress-azure addon.
--disable-sgxquotehelper : Disable SGX quote helper for confcom addon.
--no-wait : Do not wait for the long-running operation to finish.
--subnet-name -s : The subnet name for the virtual node to use.
--workspace-resource-id : The resource ID of an existing Log Analytics Workspace to use
for storing monitoring data.

Global Arguments
--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. Allowed values: json, jsonc, none, table, tsv,
yaml, yamlc. Default: 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.

Examples
Enable Kubernetes addons. (autogenerated)
az aks enable-addons --addons virtual-node --name MyManagedCluster --resource-group
MyResourceGroup --subnet-name VirtualNodeSubnet

Enable ingress-appgw addon with subnet prefix.
az aks enable-addons --name MyManagedCluster --resource-group MyResourceGroup --addons
ingress-appgw --appgw-subnet-prefix 10.2.0.0/16 --appgw-name gateway

For more specific examples, use: az find "az aks enable-addons"

Please let us know how we are doing: https://aka.ms/azureclihats
david@WIN-T14B9CT7KMS:~/Docker-Provider-3/scripts/onboarding/templates$ az find "az aks enable-addons"
Finding examples...

Here are the most common ways to use [az aks enable-addons]:

Enable Kubernetes addons. (autogenerated)
az aks enable-addons --addons virtual-node --name MyManagedCluster --resource-group MyResourceGroup --subnet MySubnetName

Please let us know how we are doing: https://aka.ms/azureclihats
```

**Expected behavior**
`az find "az aks enable-addons"` should not demonstrate an argument not listed in documentation.

## Environment Summary
```
Linux-5.4.72-microsoft-standard-WSL2-x86_64-with-debian-buster-sid
Python 3.6.10
Installer: DEB

azure-cli 2.19.1

Extensions:
aks-preview 0.4.63
azure-iot 0.9.4
interactive 0.4.4
resource-graph 1.1.0

```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.